You can use the StatusSet object to decode the OIA status. The StatusSet object returns values defined in the OIAStatus object and when used together, you can get status information from the OIA.
Table 5-34 StatusSet
|
Method |
|
|---|---|
|
contains(statusFlag) |
Determines if the set contains the specified status flag from OIAStatus constants. Parameters {Number} statusFlag status to check Returns {Boolean} True if the status flag is present in the set. |
|
isEmpty() |
Determines if the status set is empty. Returns {Boolean} True if the set is empty. |
|
size() |
Indicates the number of status flags in the set. Returns {Number} The status count |
|
toArray() |
Converts the internal status set to an array. Returns {Object []} Array of status flags in the set. |
|
toString() |
Converts the internal status set to a string. Returns {String} Space delimited names of status flags in the set. |
|
forEach(callback, thisArg) |
Function to iterate over each element in the status set. Parameters {forEachCallback} Callback to perform the specific operation. Called with the name of each status in the set. {Object} thisArg optional pointer to a context object. |
|
forEachCallback(string, thisArg) |
A user provided callback function where you provide the behavior, to be used as the callback parameter to forEach. Parameters {String} String The name of a status in the status set. {Object} thisArg Optional pointer to a context object |