com.ibm.itim.apps.workflow
Interface WorkflowResourceMO

All Known Implementing Classes:

HumanResourceMO

public interface WorkflowResourceMO

Interface for obtaining the assignments of a resource participating in workflow processes. It's for the clients of API to use this but not to implement.

Method Summary

void	getAssignmentGroups(WorkflowSearchResultsMO results, java.util.Locale locale) Retrieves groups of assignments for the participant involved.
java.util.Collection	getAssignments() Returns the assignments representing the human participant account.
void	getAssignments(WorkflowSearchResultsMO results, java.util.Locale locale) Retrieves the assignments for the participant involved.
void	getAssignments(WorkflowSearchResultsMO results, java.lang.String processDesignId, java.lang.String activityDesignId, java.util.Locale locale) Retrieves the assignments for the participant with the given process design id and activity design id.

Method Detail

getAssignments

public java.util.Collection getAssignments()
                                    throws java.rmi.RemoteException,
                                           AuthorizationException,
                                           ApplicationException

Returns the assignments representing the human participant account.

Returns:

Collection of WorkflowAssignmentMO for the human resource.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if subject is not a System Administrator and try to obtain assignments representing the human participant account other than himself.

ApplicationException - Thrown if unable to retrieve the resource's assignments.

See Also:

WorkflowAssignmentMO

getAssignments

public void getAssignments(WorkflowSearchResultsMO results,
                           java.util.Locale locale)
                    throws java.rmi.RemoteException,
                           ApplicationException

Retrieves the assignments for the participant involved. Note, not all objects that meet the search criteria will be accessible by the client. Those objects will not placed in the result set and no AuthorizationException will be thrown.

Parameters:

results - WorkflowSearchResultsMO provides accessor methods to retrieve results (Collection of Assignment) of the search.

locale - User's locale to sort with. null value defaults to Locale.US

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to retrieve the resource's assignments.

See Also:

Assignment

getAssignments

public void getAssignments(WorkflowSearchResultsMO results,
                           java.lang.String processDesignId,
                           java.lang.String activityDesignId,
                           java.util.Locale locale)
                    throws java.rmi.RemoteException,
                           AuthorizationException,
                           ApplicationException

Retrieves the assignments for the participant with the given process design id and activity design id.

Parameters:

results - WorkflowSearchResultsMO provides accessor methods to retrieve results (Collection of Assignment) of the search.

processDesignId - Design Id of the process definition to query for AssignmentGroup.getProcessDesignId().

activityDesignId - Design Id of the activity definition to query for AssignmentGroup.getActivityDesignId().

locale - User's locale to sort with. null value defaults to Locale.US

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if subject is not a System Administrator and try to obtain assignments representing the human participant account other than himself.

ApplicationException - Thrown if unable to retrieve the resource's assignments.

See Also:

Assignment

getAssignmentGroups

public void getAssignmentGroups(WorkflowSearchResultsMO results,
                                java.util.Locale locale)
                         throws java.rmi.RemoteException,
                                AuthorizationException,
                                ApplicationException

Retrieves groups of assignments for the participant involved. A group is returned for each unique combination. The details of each assignment are not provided, just a count of the number of assignments in each group.

Parameters:

results - WorkflowSearchResultsMO provides accessor methods to retrieve results (Collection of AssignmentGroup) of the search.

locale - User's locale to sort with. null value defaults to Locale.US

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

AuthorizationException - Thrown if subject is not a System Administrator and try to obtain assignments representing the human participant account other than himself.

ApplicationException - Thrown if unable to retrieve the resource's assignments.

See Also:

AssignmentGroup