|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.taskmanager.dsc.client.task.ParticipantInfo
public class ParticipantInfo
This class is used to define to whom a task is currently assigned or to whom it will later be assigned.
When using a ParticipantInfo
object for creating a task, you can only call one of the following methods:
#setQueueID()
#setDomainName()
#setGroupCannonicalName()
#setUserCannonicalName()
#setSpecifiedUserId()
#setGenericUserString()
CreateTaskInfo.setAssignTo(ParticipantInfo)
,
TaskInfo.getAssignedTo()
,
Serialized FormConstructor Summary | |
---|---|
ParticipantInfo()
Default constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getCommonName()
Common Name for a user returned as a convenience from getTaskInfo() |
java.lang.String |
getDomainName()
Retrieves the domain name of the assigned user or group. |
java.lang.String |
getGenericUserString()
Retrieves a generic string to which to assign the user. |
java.lang.String |
getGroupCannonicalName()
Retrieves the canonical name for an assigned group. |
long |
getQueueID()
Retrieves the queue identifier. |
java.lang.String |
getSpecifiedUserId()
Retrieves the user identifier (principal identifier) for the user to whom the task is to be assigned. |
java.lang.String |
getUserCannonicalName()
Retrieves the user's canonical name for an assigned task. |
int |
hashCode()
|
boolean |
isRandomGroupUser()
If assigned to a group, this method determines whether the task is to be assigned to a random group user or the group's queue. |
void |
populate(java.lang.String aUserId,
java.lang.String aPrincipalId,
long aQueueId,
java.lang.String aCommonName)
|
java.lang.String |
principalId()
|
void |
setCommonName(java.lang.String commonName)
sets a common name for the user. |
void |
setDomainName(java.lang.String domainName)
Sets the domain name of the user or group to whom to assign the task. |
void |
setGenericUserString(java.lang.String genericUserString)
Sets a generic string to which to assign the user. |
void |
setGroupCannonicalName(java.lang.String groupCannonicalName)
Sets the canonical name of the group to which to assign the task. |
void |
setQueueID(long queueID)
Sets the queue identifier for the queue to which to assign the task. |
void |
setRandomGroupUser(boolean randomGroupUser)
Sets whether the task is to be assigned to a random user in the group or to the group's queue. |
void |
setSpecifiedUserId(java.lang.String specifiedUserId)
Sets a specific user identifier to whom to assign the task. |
void |
setUserCannonicalName(java.lang.String userCannonicalName)
Sets the canonical name of a user to whom to assign the task. |
java.lang.String |
toString()
Retrieves the participant information for whom the task is assigned. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ParticipantInfo()
Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public long getQueueID()
public void setQueueID(long queueID)
queueID
- The queue identifier.public boolean isRandomGroupUser()
true
if the the task is to be assigned to a random user in the group, false
otherwise.public void setRandomGroupUser(boolean randomGroupUser)
randomGroupUser
- true
if the task is to be assigned to a random user in a group,
false
if the task is to be assigned to the group's queue.public java.lang.String getGroupCannonicalName()
public void setGroupCannonicalName(java.lang.String groupCannonicalName)
groupCannonicalName
- The canonical name of the group.public java.lang.String getUserCannonicalName()
public void setUserCannonicalName(java.lang.String userCannonicalName)
userCannonicalName
- The canonical name of the user.public java.lang.String getDomainName()
public void setDomainName(java.lang.String domainName)
domainName
- The domain name.public java.lang.String getSpecifiedUserId()
public void setSpecifiedUserId(java.lang.String specifiedUserId)
specifiedUserId
- The specific user identifier.public java.lang.String getGenericUserString()
ParticipantInfo.setGenericUserString(String)
public void setGenericUserString(java.lang.String genericUserString)
This way of assigning a task is to be used when evaluating user-defined XPath expressions in a workflow.
genericUserString
- The generic string.public java.lang.String getCommonName()
public void setCommonName(java.lang.String commonName)
commonName
- public java.lang.String principalId()
public void populate(java.lang.String aUserId, java.lang.String aPrincipalId, long aQueueId, java.lang.String aCommonName)
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |