AssignmentGroup

java.lang.Object
- com.ibm.itim.workflow.model.AssignmentGroup

All Implemented Interfaces:

java.io.Serializable
```
public class AssignmentGroup
extends java.lang.Object
implements java.io.Serializable
```
This class provides general information about a group of assignments.

Since:

ITIM 4.6

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LOCKED` Constant identifying the locked state.
`static int`	`PARTIAL_LOCKED` Constant identifying the partial locked state.
`static int`	`UNLOCKED` Constant identifying the unlocked state.

Constructor Summary

Constructors
Constructor and Description

AssignmentGroup()

Constructors
Constructor and Description
`AssignmentGroup()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getActivityDesignId()` Returns the ID of the activity associated with this assignment as defined at design time.
`java.lang.String`	`getActivityName()` Returns the name of the activity associated with this assignment as defined at design time.
`java.lang.String`	`getActivitySubType()` Returns the sub-type of the activity associated with this assignment.
`int`	`getCount()` Returns the number of assignments in this grouping.
`java.lang.String`	`getDescription()` Returns a description of the object.
`java.util.Date`	`getDueDate()` Returns the date/time the earliest assignment in the group 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).
`int`	`getLockState()` Returns whether the assignment group is locked or unlocked or partially locked.
`ActivityParticipant`	`getParticipant()` Deprecated.
`java.lang.String`	`getProcessDesignId()` Returns the ID of the process associated with this assignment as defined at design time.
`long`	`getProcessId()` Returns the identifier of the process associated with the assignment.
`java.lang.String`	`getRequestee()` Returns the name of the process requestee associated with this assignment group.
`java.lang.String`	`getSubject()` Returns the subject of the process associated with this assignment group.
`void`	`setActivityDesignId(java.lang.String id)` Changes the design time 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`	`setCount(int count)` Changes the number of assignments in this grouping.
`void`	`setDescription(java.lang.String description)` Changes the object's description.
`void`	`setDueDate(java.util.Date dueDate)` Changes the date/time the earliest assignment is due (must be completed before escalation).
`void`	`setId(long id)` Changes the identifier of the assignment.
`void`	`setLockOwner(DistinguishedName lockOwner)` Changes the participant that has currently locked the assignment.
`void`	`setLockState(int lockState)` Changes the assignment to either locked or unlocked or partially locked.
`void`	`setParticipant(ActivityParticipant participant)` Deprecated.
`void`	`setProcessDesignId(java.lang.String id)` Changes the design time ID of the process associated with this assignment.
`void`	`setProcessId(long processId)` Changes the identifier of the process associated with the assignment.
`void`	`setRequestee(java.lang.String requestee)` Changes the name of the process requestee associated with this assignment group.
`void`	`setSubject(java.lang.String subject)` Changes the subject of the process associated with this assignment group.
`java.lang.String`	`toString()` Forms a string representation of the AssignmentGroup

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOCKED
```
public static final int LOCKED
```
    Constant identifying the locked state.
    
    See Also:
    
    Constant Field Values
  - UNLOCKED
```
public static final int UNLOCKED
```
    Constant identifying the unlocked state.
    
    See Also:
    
    Constant Field Values
  - PARTIAL_LOCKED
```
public static final int PARTIAL_LOCKED
```
    Constant identifying the partial locked state.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AssignmentGroup
```
public AssignmentGroup()
```
- Method Detail
  - getId
```
public long getId()
```
    Returns the identifier of the assignment. The ID is provided as a convenience for only assignment groups that contain just one assignment. For groups that contain multiple assignments the returned ID will be 0.
    
    Returns:
    
    ID of the assignment.
    
    Since:
    
    ITIM 4.6
  - setId
```
public void setId(long id)
```
    Changes the identifier of the assignment.
    
    Parameters:
    
    id - ID of the assignment.
    
    Since:
    
    ITIM 4.6
  - getProcessId
```
public long getProcessId()
```
    Returns the identifier of the process associated with the assignment. The ID is provided as a convenience for only assignment groups that contain just one assignment. For groups that contain multiple assignments the returned ID will be 0.
    
    Returns:
    
    ID of the process associated with the assignment.
    
    Since:
    
    ITIM 4.6
  - setProcessId
```
public void setProcessId(long processId)
```
    Changes the identifier of the process associated with the assignment.
    
    Parameters:
    
    processId - ID of the process associated with the assignment.
    
    Since:
    
    ITIM 4.6
  - 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
  - getProcessDesignId
```
public java.lang.String getProcessDesignId()
```
    Returns the ID of the process associated with this assignment as defined at design time.
    
    Returns:
    
    Design time id of the process.
    
    Since:
    
    ITIM 4.6
  - setProcessDesignId
```
public void setProcessDesignId(java.lang.String id)
```
    Changes the design time ID of the process associated with this assignment.
    
    Parameters:
    
    id - String ID of the process.
    
    Since:
    
    ITIM 4.6
  - getActivityDesignId
```
public java.lang.String getActivityDesignId()
```
    Returns the ID of the activity associated with this assignment as defined at design time. An activity ID is only unique within a process.
    
    Returns:
    
    Design time id of the activity.
    
    Since:
    
    ITIM 4.6
  - 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.
    
    Since:
    
    ITIM 4.6
  - getDescription
```
public java.lang.String getDescription()
```
    Returns a description of the object. The description is provided as a convenience for only assignment groups that contain just one assignment. For groups that contain multiple assignments no description will be returned.
    
    Returns:
    
    Description of the object.
    
    Since:
    
    ITIM 4.6
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Changes the object's description.
    
    Parameters:
    
    description - String description of the object.
    
    Since:
    
    ITIM 4.6
  - getDueDate
```
public java.util.Date getDueDate()
```
    Returns the date/time the earliest assignment in the group is due (must be completed before escalation).
    
    Returns:
    
    Date the assignment is due.
    
    Since:
    
    ITIM 4.6
  - setDueDate
```
public void setDueDate(java.util.Date dueDate)
```
    Changes the date/time the earliest assignment is due (must be completed before escalation).
    
    Parameters:
    
    dueDate - Date the assignment is due.
    
    Since:
    
    ITIM 4.6
  - getRequestee
```
public java.lang.String getRequestee()
```
    Returns the name of the process requestee associated with this assignment group. The requestee is provided as a convenience for only assignment groups that contain just one assignment. For groups that contain multiple assignments no requestee will be returned.
    
    Returns:
    
    name Name of the process requestee associated with this assignment.
    
    Since:
    
    ITIM 4.6
  - setRequestee
```
public void setRequestee(java.lang.String requestee)
```
    Changes the name of the process requestee associated with this assignment group.
    
    Parameters:
    
    requestee - Name of the process requestee associated with this assignment.
    
    Since:
    
    ITIM 4.6
  - 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.
    
    Since:
    
    ITIM 4.6
  - 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.
    
    Since:
    
    ITIM 4.6
  - getSubject
```
public java.lang.String getSubject()
```
    Returns the subject of the process associated with this assignment group.
    
    Returns:
    
    subject Subject of the process associated with this assignment group.
    
    Since:
    
    ITIM 4.6
  - setSubject
```
public void setSubject(java.lang.String subject)
```
    Changes the subject of the process associated with this assignment group.
    
    Parameters:
    
    subject - Subject of the process associated with this assignment group.
    
    Since:
    
    ITIM 4.6
  - getLockState
```
public int getLockState()
```
    Returns whether the assignment group is locked or unlocked or partially locked.
    
    Returns:
    
    LOCKED if locked, UNLOCKED if not locked, PARTIAL_LOCKED if partially locked.
    
    Since:
    
    ITIM 4.6
  - setLockState
```
public void setLockState(int lockState)
```
    Changes the assignment to either locked or unlocked or partially locked.
    
    Parameters:
    
    lockState - LOCKED if locked, UNLOCKED if not locked, PARTIAL_LOCKED if partially locked.
    
    Since:
    
    ITIM 4.6
  - getLockOwner
```
public DistinguishedName getLockOwner()
```
    Returns the participant that has currently locked the assignment (if any). If multiple assignments are in the group, an owner is only returned if the assignments are locked by the same user.
    
    Returns:
    
    DistinguishedName of person who has locked the assignment group, null if no one has or more than one person has.
    
    Since:
    
    ITIM 4.6
  - setLockOwner
```
public void setLockOwner(DistinguishedName lockOwner)
```
    Changes the participant that has currently locked the assignment.
    
    Parameters:
    
    lockOwner - DistinguishedName of person who has locked the assignment.
    
    Since:
    
    ITIM 4.6
  - getCount
```
public int getCount()
```
    Returns the number of assignments in this grouping.
    
    Returns:
    
    Number of assignments in this grouping.
    
    Since:
    
    ITIM 4.6
  - setCount
```
public void setCount(int count)
```
    Changes the number of assignments in this grouping.
    
    Parameters:
    
    count - Number of assignments in this grouping.
    
    Since:
    
    ITIM 4.6
  - getParticipant
```
public ActivityParticipant getParticipant()
```
    Deprecated.
    
    Returns the participant for this assignment. In release 4.6, workitems are no longer assigned individual workitems. Instead, one work item can have multiple participants. These participants are stored in their own table. This field is no longer used.
    
    Returns:
    
    ActivityParticipant
    
    Since:
    
    ITIM 4.6
  - setParticipant
```
public void setParticipant(ActivityParticipant participant)
```
    Deprecated.
    
    Sets the participant for this assignment. In release 4.6, workitems are no longer assigned individual workitems. Instead, one work item can have multiple participants. These participants are stored in their own table. This field is no longer used.
    
    Parameters:
    
    participant -
    
    Since:
    
    ITIM 4.6
  - toString
```
public java.lang.String toString()
```
    Forms a string representation of the AssignmentGroup
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String - string representing this AssignmentGroup

Methods inherited from class java.lang.Object

LOCKED

UNLOCKED

PARTIAL_LOCKED

AssignmentGroup

getId

setId

getProcessId

setProcessId

getActivityName

setActivityName

getProcessDesignId

setProcessDesignId

getActivityDesignId

setActivityDesignId

getDescription

setDescription

getDueDate

setDueDate

getRequestee

setRequestee

getActivitySubType

setActivitySubType

getSubject

setSubject

getLockState

setLockState

getLockOwner

setLockOwner

getCount

setCount

getParticipant

setParticipant

toString