com.ibm.itim.workflow.model
Class Assignment

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

All Implemented Interfaces:

java.io.Serializable

public class Assignment

extends java.lang.Object

implements java.io.Serializable

This class provides general information about an assignment, or work item.

See Also:

Serialized Form

Constructor Summary

Assignment()

Method Summary

java.lang.String	getActivityDesignId() Returns the ID of the activity associated with this assignment as defined at design time.
long	getActivityId() Returns the ID of the activity associated with this assignment.
java.lang.String	getActivityName() Returns the name of the activity associated with this assignment as defined at design time.
ActivityParticipant	getActivityParticipant() Returns the participant of the assignment.
java.lang.String	getActivitySubType() Returns the sub-type of the activity associated with this assignment.
java.lang.String	getActivityType() Return the type of the activity associated with this assignment.
java.lang.String	getDescription() Returns a description of the object.
java.util.Date	getDueDate() Returns the date/time the assignment is due (must be completed before escalation).
long	getId() Returns the identifier of the assignment.
DistinguishedName	getLockOwner() Returns the participant that has currently locked the assignment (if any).
java.lang.String	getProcessDesignId() Returns the process definition design id.
long	getProcessId() Returns the ID of the process that is running this assignment.
java.lang.String	getRequestee() Returns the name of the process requestee associated with this assignment.
java.lang.String	getRequester() Returns the name of the process requester associated with this assignment.
java.lang.String	getSubject() Returns the subject of the process associated with this assignment.
java.util.Date	getTimeCreated() Returns the date/time the assignment was made.
boolean	isLocked() Returns whether the assignment is locked or not.
void	setActivityDesignId(java.lang.String id) Changes the design time ID of the activity associated with this assignment.
void	setActivityId(long activityId) Changes the ID of the activity associated with this assignment.
void	setActivityName(java.lang.String activityName) Changes the design time name of the activity associated with this assignment.
void	setActivitySubType(java.lang.String activitySubType) Changes the sub-type of the activity associated with this assignment.
void	setActivityType(java.lang.String activityType) Changes the type of the activity associated with this assignment.
void	setDescription(java.lang.String description) Changes the object's description.
void	setDueDate(java.util.Date dueDate)
void	setId(long id) Changes the identifier of the assignment.
void	setIsLocked(boolean isLocked) Changes the assignment to either locked or unlocked.
void	setLockOwner(DistinguishedName lockOwner) Changes the participant to the person that has currently locked the assignment.
void	setParticipant(ActivityParticipant participant) Changes the participant of the assignment.
void	setProcessDesignId(java.lang.String processDefDesignId) Changes the process definition design id to the specified String Id.
void	setProcessId(long processId) Changes the ID of the assignment process.
void	setRequestee(java.lang.String requestee) Changes the name of the process requestee associated with this assignment.
void	setRequester(java.lang.String requester) Changes the name of the process requester associated with this assignment.
void	setSubject(java.lang.String subject) Changes the subject of the process associated with this assignment.
void	setTimeCreated(java.util.Date timeCreated)

Methods inherited from class java.lang.Object

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

Constructor Detail

Assignment

public Assignment()

Method Detail

getId

public long getId()

Returns the identifier of the assignment.

Returns:

ID of the assignment.

setId

public void setId(long id)

Changes the identifier of the assignment.

Parameters:

id - ID of the assignment.

getActivityDesignId

public java.lang.String getActivityDesignId()

Returns the ID of the activity associated with this assignment as defined at design time.

Returns:

Design time id of the activity.

setActivityDesignId

public void setActivityDesignId(java.lang.String id)

Changes the design time ID of the activity associated with this assignment.

Parameters:

id - String ID of the activity.

getActivityName

public java.lang.String getActivityName()

Returns the name of the activity associated with this assignment as defined at design time.

Returns:

Design time name of the activity.

Since:

ITIM 4.6

setActivityName

public void setActivityName(java.lang.String activityName)

Changes the design time name of the activity associated with this assignment.

Parameters:

activityName - String name of the activity.

Since:

ITIM 4.6

getDescription

public java.lang.String getDescription()

Returns a description of the object.

Returns:

Description of the object.

setDescription

public void setDescription(java.lang.String description)

Changes the object's description.

Parameters:

description - String description of the object.

getActivityParticipant

public ActivityParticipant getActivityParticipant()

Returns the participant of the assignment.

Returns:

ActivityParticipant representing the assignment participant.

setParticipant

public void setParticipant(ActivityParticipant participant)

Changes the participant of the assignment.

Parameters:

participant - ActivityParticipant of the assignment.

getTimeCreated

public java.util.Date getTimeCreated()

Returns the date/time the assignment was made.

Returns:

Date the assignment was made.

setTimeCreated

public void setTimeCreated(java.util.Date timeCreated)

getDueDate

public java.util.Date getDueDate()

Returns the date/time the assignment is due (must be completed before escalation).

Returns:

Date the assignment is due.

setDueDate

public void setDueDate(java.util.Date dueDate)

getProcessId

public long getProcessId()

Returns the ID of the process that is running this assignment.

Returns:

ID of the assignment process.

setProcessId

public void setProcessId(long processId)

Changes the ID of the assignment process.

Parameters:

processId - ID of the assignment process.

getActivityId

public long getActivityId()

Returns the ID of the activity associated with this assignment.

Returns:

ID of the activity associated with this assignment.

setActivityId

public void setActivityId(long activityId)

Changes the ID of the activity associated with this assignment.

Parameters:

activityId - ID of the activity associated with this assignment.

getActivityType

public java.lang.String getActivityType()

Return the type of the activity associated with this assignment.

Returns:

Type of the activity associated with this assignment.

setActivityType

public void setActivityType(java.lang.String activityType)

Changes the type of the activity associated with this assignment.

Parameters:

activityType - Type of the activity associated with this assignment.

getActivitySubType

public java.lang.String getActivitySubType()

Returns the sub-type of the activity associated with this assignment. Note: not all activities have a subtype. Those activities will return an empty string.

Returns:

Sub-type of the activity associated with this assignment, the empty string if not applicable.

setActivitySubType

public void setActivitySubType(java.lang.String activitySubType)

Changes the sub-type of the activity associated with this assignment. Note: not all activities have a subtype. Those activities will return an empty string.

Parameters:

activitySubType - Sub-type of the activity associated with this assignment, the empty string if not applicable.

getSubject

public java.lang.String getSubject()

Returns the subject of the process associated with this assignment.

Returns:

subject Subject of the process associated with this assignment.

setSubject

public void setSubject(java.lang.String subject)

Changes the subject of the process associated with this assignment.

Parameters:

subject - Subject of the process associated with this assignment.

getRequestee

public java.lang.String getRequestee()

Returns the name of the process requestee associated with this assignment.

Returns:

name Name of the process requestee associated with this assignment.

setRequestee

public void setRequestee(java.lang.String requestee)

Changes the name of the process requestee associated with this assignment.

Parameters:

requestee - Name of the process requestee associated with this assignment.

getRequester

public java.lang.String getRequester()

Returns the name of the process requester associated with this assignment.

Returns:

name Name of the process requester associated with this assignment.

setRequester

public void setRequester(java.lang.String requester)

Changes the name of the process requester associated with this assignment.

Parameters:

requester - Name of the process requester associated with this assignment.

isLocked

public boolean isLocked()

Returns whether the assignment is locked or not.

Returns:

True if locked, false if not.

setIsLocked

public void setIsLocked(boolean isLocked)

Changes the assignment to either locked or unlocked.

Parameters:

isLocked - True if locked, false if not.

getLockOwner

public DistinguishedName getLockOwner()

Returns the participant that has currently locked the assignment (if any).

Returns:

DistinguishedName of person who has locked the assignment, null if no one has.

Since:

ITIM 4.6

setLockOwner

public void setLockOwner(DistinguishedName lockOwner)

Changes the participant to the person that has currently locked the assignment.

Parameters:

lockOwner - DistinguishedName of person who has locked the assignment.

Since:

ITIM 4.6

getProcessDesignId

public java.lang.String getProcessDesignId()

Returns the process definition design id.

Returns:

String value of process definition design Id.

setProcessDesignId

public void setProcessDesignId(java.lang.String processDefDesignId)

Changes the process definition design id to the specified String Id.

Parameters:

processDefDesignId - Process definition design Id.