com.ibm.itim.workflow.model
Class AssignmentEntity

java.lang.Object
  |
  +--com.ibm.itim.workflow.model.AssignmentEntity

public class AssignmentEntity

extends java.lang.Object

Class that provides management capabilities for an Assignment in a workflow Activity.

Constructor Summary

AssignmentEntity(Assignment assignment)
Constructs with Assignment value object.

Method Summary

void	complete(DistinguishedName user) Signals completion of the assignment to the workflow engine.
void	complete(DistinguishedName user, ActivityResult result) Signals completion of the assignment to the workflow engine and provides the engine with the activity result in the same call.
void	defer(int deferralDays) Defers the workitem for specified number of days In 4.6, the only item that can be deferred is Compliance Alert Manual Activity
void	delegate(DistinguishedName personDN, DistinguishedName currentPersonDN) Re-assign (delegate) the assignment to another person.
ActivityEntity	getActivity() Returns the activity associated with this assignment.
static AssignmentEntity	getAssignment(long assignmentId) Returns an assignment associated with the id.
java.util.List	getInputParameters() Returns list of input parameters for this assignment.
java.util.Collection	getPotentialOwners() Returns a list of potention participants this work item could be delegated.
java.util.Collection	getPotentialOwners(boolean onlyExistingPotentialOwners) Returns existing potential owner(s) of the activity.
Assignment	getValueObject() Returns the value object holding details about this assignment.
void	lock(DistinguishedName userDN) Locks the assignment.
void	setValueObject(Assignment assignment) Sets the value object holding details about this assignment.
void	unlock(DistinguishedName personDN) Unlocks the assignment.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssignmentEntity

public AssignmentEntity(Assignment assignment)

Constructs with Assignment value object.

Parameters:

assignment - Assignment value object.

Method Detail

complete

public void complete(DistinguishedName user)
              throws WorkflowException

Signals completion of the assignment to the workflow engine.

Parameters:

user - Participant of the assignment.

Throws:

WorkflowException - Thrown if an error occured trying to process the completion.

complete

public void complete(DistinguishedName user,
                     ActivityResult result)
              throws WorkflowException

Signals completion of the assignment to the workflow engine and provides the engine with the activity result in the same call.

Parameters:

user - Participant of the assignment.

result - ActivityResult holding the result of the completing assignment.

Throws:

WorkflowException - Thrown if an error occured trying to process the completion.

delegate

public void delegate(DistinguishedName personDN,
                     DistinguishedName currentPersonDN)
              throws WorkflowException

Re-assign (delegate) the assignment to another person.

Parameters:

personDN - DistinguishedName of the person delegated the assignment.

currentPersonDN - Person distinguished name of the current logged in user. This parameter is null if this work is done on behalf of the System Administrator.

Throws:

WorkflowException - if an error occurred trying to delegate the assignment.

WorkflowException

Since:

ITIM 4.6

getPotentialOwners

public java.util.Collection getPotentialOwners()
                                        throws WorkflowException

Returns a list of potention participants this work item could be delegated.

Returns:

A collection of person distinguished names who are owners of this work item. The repository stores system user distinguished name's but, they are converted to the owner of the account.

Throws:

WorkflowException - Thrown if an error occured trying to retrieve the owners of this work item.

Since:

ITIM 4.6

getPotentialOwners

public java.util.Collection getPotentialOwners(boolean onlyExistingPotentialOwners)
                                        throws WorkflowException

Returns existing potential owner(s) of the activity. A potential owner is a person who was originally assigned the activity and is a candidate for locking, unlocking or delegating the assignment.

Parameters:

onlyExistingPotentialOwners - A flag to indicate that only existing potential owner(s) should be returned, when its value is 'true'. If 'false' then an WorkflowException is thrown if a potential owner is not present.

Returns:

A collection of the existing person distinguished names who are owners of this work item. The repository stores system user distinguished name's but, they are converted to the owner of the account.

Throws:

WorkflowException - Thrown if an error occured trying to retrieve the owners of this work item.

Since:

ITIM 4.6

lock

public void lock(DistinguishedName userDN)
          throws WorkflowException

Locks the assignment.

Parameters:

userDN - DistinguishedName of the system user locking the assignment.

Throws:

WorkflowException - Thrown if an error occured trying to lock the assignment.

WorkflowException

Since:

ITIM 4.6

unlock

public void unlock(DistinguishedName personDN)
            throws WorkflowException

Unlocks the assignment.

Parameters:

personDN - Person distinguished name of the current logged in user. This parameter is null if this work is done on behalf of the System Administrator.

Throws:

WorkflowException - Thrown if an error occured trying to unlock the assignment.

WorkflowException

Since:

ITIM 4.6

defer

public void defer(int deferralDays)
           throws WorkflowException

Defers the workitem for specified number of days In 4.6, the only item that can be deferred is Compliance Alert Manual Activity

Parameters:

deferralDays - the number of days to defer the workorder

Throws:

WorkflowException - if there is a failure to defer the workitem

Since:

ITIM 4.6

getAssignment

public static AssignmentEntity getAssignment(long assignmentId)
                                      throws WorkflowException

Returns an assignment associated with the id.

Parameters:

assignmentId - Id of the assignment

Returns:

AssignmentEntity object. Returns null if the work item is not found in the repository.

Throws:

WorkflowException - Thrown if unable to retrieve the assignment.

getActivity

public ActivityEntity getActivity()
                           throws WorkflowException

Returns the activity associated with this assignment.

Returns:

ActivityEntity of the associated assignment. Returns null if the activity is not found in the repository.

Throws:

WorkflowException - Thrown if unable to retrieve the activity.

getInputParameters

public java.util.List getInputParameters()
                                  throws WorkflowException

Returns list of input parameters for this assignment.

Returns:

List of input parameters.

Throws:

WorkflowException - Thrown if unable to retrieve the input parameters.

getValueObject

public Assignment getValueObject()

Returns the value object holding details about this assignment.

Returns:

Assignment value object.

setValueObject

public void setValueObject(Assignment assignment)

Sets the value object holding details about this assignment.

Parameters:

assignment - Assignment value object.