com.ibm.bpe.api
Interface StaffResultSet

All Superinterfaces:
java.io.Serializable

public interface StaffResultSet
extends java.io.Serializable

Provides the results of a query request for persons.

The staff result set contains the qualifying user IDs, for example, the process administrators of a process instance. If everybody or nobody is qualifying specifically, then no user IDs are provided. The result type shows whether a set of user IDs is provided or whether everybody or nobody is qualifying.

Since:
5.0

Field Summary
static java.lang.String COPYRIGHT
           
static int RESULT_TYPE_EVERYBODY
          States that everybody is qualifying.
static int RESULT_TYPE_NOBODY
          States that no one is qualifying.
static int RESULT_TYPE_USERIDS
          States that a set of qualifying user IDs is returned.
 
Method Summary
 int getResultType()
          Returns an indicator that describes the content of the staff result set.
 java.lang.String[] getUserIDs()
          Returns an array of user IDs when the result type indicates that user IDs are returned.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

RESULT_TYPE_NOBODY

public static final int RESULT_TYPE_NOBODY
States that no one is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_EVERYBODY

public static final int RESULT_TYPE_EVERYBODY
States that everybody is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_USERIDS

public static final int RESULT_TYPE_USERIDS
States that a set of qualifying user IDs is returned. Note that the set can be empty.

See Also:
Constant Field Values
Method Detail

getResultType

public int getResultType()
Returns an indicator that describes the content of the staff result set.

Possible values are: RESULT_TYPE_NOBODY, RESULT_TYPE_EVERYBODY, RESULT_TYPE_USERIDS.


getUserIDs

public java.lang.String[] getUserIDs()
Returns an array of user IDs when the result type indicates that user IDs are returned. Otherwise, the array is empty.

Note that the array is also empty when no staff expression has been defined, for example, there is no staff expression for a process template that defines a set of process administrators.