com.ibm.task.api

Interface StaffResultSet

  • All Superinterfaces:
    java.io.Serializable

    public interface StaffResultSet
extends java.io.Serializable
    Returns the persons or groups that are members of a specific role.

    The staff result set contains user or group IDs that belong to a specific role, for example, the potential owners of a task instance. If everybody or nobody is qualifying specifically, then no user or group IDs are provided. The result type indicates whether user or group IDs are provided or whether everybody or nobody is qualifying.

    Since:
    6.0

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String[] getGroupIDs()
      Returns group IDs when the result type indicates that group IDs are returned.
      int getResultType()
      Returns an indicator that describes the content of the staff result set.
      java.lang.String[] getUserIDs()
      Returns user IDs when the result type indicates that user IDs are returned.

    • Field Detail

      • RESULT_TYPE_NOBODY

        static final int RESULT_TYPE_NOBODY
        States that no one is qualifying.
        See Also:
        Constant Field Values

      • RESULT_TYPE_EVERYBODY

        static final int RESULT_TYPE_EVERYBODY
        States that everybody is qualifying.
        See Also:
        Constant Field Values

      • RESULT_TYPE_USERIDS

        static final int RESULT_TYPE_USERIDS
        States that user IDs are returned. Note that the array can be empty.
        See Also:
        Constant Field Values

      • RESULT_TYPE_GROUPIDS

        static final int RESULT_TYPE_GROUPIDS
        States that group IDs are returned. Note that the array can be empty.
        Since:
        6.0.2
        See Also:
        Constant Field Values

      • RESULT_TYPE_USERIDS_AND_GROUPIDS

        static final int RESULT_TYPE_USERIDS_AND_GROUPIDS
        States that user and group IDs are returned.
        Since:
        6.0.2
        See Also:
        Constant Field Values

    • Method Detail

      • getResultType

        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, RESULT_TYPE_GROUPIDS, RESULT_TYPE_USERIDS_AND_GROUPIDS

      • getGroupIDs

        java.lang.String[] getGroupIDs()
        Returns group IDs when the result type indicates that group IDs are returned. Otherwise, the array is empty.
        Since:
        6.0.2

      • getUserIDs

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

        Note that the array may also be empty when user IDs are said to be returned, for example

        • No staff expression has been defined, for example, there is no staff expression for a process template that defines a set of process administrators.
        • No users qualify when resolveStaffQuery is called.
IBM Business Process ManagerTM
Release 8