Scripting and Programming Guides › Developer's Guide for Java › Utilities Package › Result Class

Result Class

The Result class, SmApiResult, stores the result of a SiteMinder Java API request. A SiteMinder result contains the following elements:

• Facility. Origin of the result. For example, the result might originate on the client or server.
• Severity. Significance of the result, such as informational or warning.
• Status. Status code of the result. Status codes are unique within each facility. You can use a facility’s unique status code to distinguish a particular result from other results that might have originated from the facility.
• Message. Additional information about the result, such as descriptive text or numeric details.

A result might also include a reason code. For example, a password policy result might include a reason code of 1001, meaning that the password does not contain the required minimum number of characters. To find a reason code for a result, call getReason().

All server-side errors are returned as results, not as exceptions. However, when a client-side exception is thrown, an SmApiResult object is embedded in the exception.