Result

Description

Package: com.ibm.rpm.framework

Extends: N/A

Usage

Result is used as the return type of many API methods. Result encapsulates the exceptions that have been raised during the execution of a method. Hence, a method that returns a Result or one of its extended classes does not throw any exception.

In order to know if a method has been successfully executed, the caller must check Result.successfull. When the latter's value is set to false, the array of exceptions that caused the failure can be retrieved in Result.errors.

Note: When there is no error, Result.error is null.

Supported API Calls

Refer to the Application interface section for details.

Security Restrictions

N/A

Fields

The following table lists the fields for this object.

Table 1. Result Field Description
Field Detail
successfull

Type: boolean

Default value: N/A

Description: This field is true when the execution of the method has been successful. This means that no exception of severity levelError, SevereError, or FatalError have been raised. Otherwise, it is false.

Field validation description: N/A

Additional field security restrictions: N/A

errors

Type: RPMException[]

Default value: null

Description: Contains the array of errors that have been raised during the execution of the method and their severity level. Possible severity levels are: Error, SevereError, or FatalError.

Field validation description: N/A

Additional field security restrictions: N/A

warningFree

Type: boolean

Default value: N/A

Description: This field is true when the execution of the method has raised no exceptions of severity level Warning. Otherwise, it is false.

Field validation description: N/A

Additional field security restrictions: N/A

warnings

Type: RPMException[]

Default value: null

Description: Contains the array of warnings that have been raised during the execution of the method and their severity level. Severity levels can be Warning or Information.

Field validation description: N/A

Additional field security restrictions: N/A

Inherited Fields

N/A

Related Objects