com.ibm.itim.apps.workflow
Class HumanResourceMO

java.lang.Object
  com.ibm.itim.apps.workflow.HumanResourceMO

All Implemented Interfaces:

WorkflowResourceMO

public class HumanResourceMO
extends java.lang.Object
implements WorkflowResourceMO

Representing a human resource participating in workflow processes.

Constructor Summary

HumanResourceMO(PlatformContext platform, javax.security.auth.Subject subject)
Constructs the the managed object with a platform context and the subject representing the human participant.

HumanResourceMO(PlatformContext platform, javax.security.auth.Subject subject, AccountMO account)
Constructs the the managed object with a platform context, a subject, and the managed object representing the human participant account.

Method Summary

void	execute(WorkflowSearchResultsMO results, java.util.Locale locale) Deprecated. As of ITIM 4.6 getAssignments(WorkflowSearchResultsMO, Locale).
AccountMO	getAccount() Returns the human participant account.
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.
void	getAssignmentsByDueDate(WorkflowSearchResultsMO results, int searchLimit) Retrieves the assignments for the participant involved.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HumanResourceMO

public HumanResourceMO(PlatformContext platform,
                       javax.security.auth.Subject subject)

Constructs the the managed object with a platform context and the subject representing the human participant.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

HumanResourceMO

public HumanResourceMO(PlatformContext platform,
                       javax.security.auth.Subject subject,
                       AccountMO account)

Constructs the the managed object with a platform context, a subject, and the managed object representing the human participant account.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

account - AccountMO representing the human participant account.

Method Detail

getAssignments

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

Returns the assignments representing the human participant account.

Specified by:

getAssignments in interface WorkflowResourceMO

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.

Specified by:

getAssignments in interface WorkflowResourceMO

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

getAssignmentsByDueDate

public void getAssignmentsByDueDate(WorkflowSearchResultsMO results,
                                    int searchLimit)
                             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. Results are ordered by the due date on the assignment, from oldest to newest. This method will return no more than the specified search limit size, but may be subject to additional result set size limitations in the system. Use the value -1 to avoid placing additional result set size limits.

Parameters:

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

searchLimit - specifies an integer limit on the maximum number of results to be returned, -1 to place no additional limit on the size of the results

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.

Specified by:

getAssignments in interface WorkflowResourceMO

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.

Specified by:

getAssignmentGroups in interface WorkflowResourceMO

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

execute

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

Deprecated. As of ITIM 4.6 getAssignments(WorkflowSearchResultsMO, Locale).

Executes the search using the configured parameters. Note, not all objects that meet the search parameters 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 execute the search. This is most likely caused by an invalid parameter in the request.

See Also:

Assignment

getAccount

public AccountMO getAccount()

Returns the human participant account.

Returns:

AccountMO representing the human participant account.