StatusSet

StatusSet

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.

Example:

if (session.getOIA().getStatus().contains(OIAStatus.BLOCK_MODE)) {
}

Methods

contains(value) → {Boolean}

Determines if the set contains the specified status value.

Parameters:
Name Type Description
value Object

value to look for in the set

Returns:
  • true if the value is in the set
Type
Boolean

isEmpty() → {Boolean}

Determines if the set is empty.

Returns:

true if the set is empty

Type
Boolean

size() → {Number}

Indicates the number of values in the set.

Returns:

the value count

Type
Number

toArray() → {Array}

Converts the set to an array.

Returns:

array of values in the set

Type
Array

toString() → {String}

Converts the set to a String.

Returns:

space-delimited names of vlaues in the set

Type
String

forEach(callback, thisArg)

Function to iterate over each element in the set.

Parameters:
Name Type Description
callback function

The function callback to perform the specific operation. Called with the name of each value in the set.

thisArg Object

optional pointer to a context object

contains(value) → {Boolean}

Determines if the set contains the specified status value.

Parameters:
Name Type Description
value Object

value to look for in the set

Returns:
  • true if the value is in the set
Type
Boolean

isEmpty() → {Boolean}

Determines if the set is empty.

Returns:

true if the set is empty

Type
Boolean

size() → {Number}

Indicates the number of values in the set.

Returns:

the value count

Type
Number

toArray() → {Array}

Converts the set to an array.

Returns:

array of values in the set

Type
Array

toString() → {String}

Converts the set to a String.

Returns:

space-delimited names of vlaues in the set

Type
String

forEach(callback, thisArg)

Function to iterate over each element in the set.

Parameters:
Name Type Description
callback function

The function callback to perform the specific operation. Called with the name of each value in the set.

thisArg Object

optional pointer to a context object