com.adobe.idp.taskmanager.dsc.client.task
Class ParticipantInfo

java.lang.Object
  extended by com.adobe.idp.taskmanager.dsc.client.task.ParticipantInfo
All Implemented Interfaces:
java.io.Serializable

public class ParticipantInfo
extends java.lang.Object
implements java.io.Serializable

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:

See Also:
CreateTaskInfo.setAssignTo(ParticipantInfo), TaskInfo.getAssignedTo(), Serialized Form

Constructor 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

ParticipantInfo

public ParticipantInfo()
Default constructor.

Method Detail

toString

public java.lang.String toString()
Retrieves the participant information for whom the task is assigned.

Overrides:
toString in class java.lang.Object
Returns:
The participant information.

getQueueID

public long getQueueID()
Retrieves the queue identifier.

Returns:
The queue identifier.

setQueueID

public void setQueueID(long queueID)
Sets the queue identifier for the queue to which to assign the task. When you set the queue identifier, the user or group information is reset.

Parameters:
queueID - The queue identifier.

isRandomGroupUser

public 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.

Returns:
true if the the task is to be assigned to a random user in the group, false otherwise.

setRandomGroupUser

public 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.

Parameters:
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.

getGroupCannonicalName

public java.lang.String getGroupCannonicalName()
Retrieves the canonical name for an assigned group.

Returns:
The group canonical name.

setGroupCannonicalName

public void setGroupCannonicalName(java.lang.String groupCannonicalName)
Sets the canonical name of the group to which to assign the task.

Parameters:
groupCannonicalName - The canonical name of the group.

getUserCannonicalName

public java.lang.String getUserCannonicalName()
Retrieves the user's canonical name for an assigned task.

Returns:
The user's canonical name.

setUserCannonicalName

public void setUserCannonicalName(java.lang.String userCannonicalName)
Sets the canonical name of a user to whom to assign the task.

Parameters:
userCannonicalName - The canonical name of the user.

getDomainName

public java.lang.String getDomainName()
Retrieves the domain name of the assigned user or group.

Returns:
The domain name.

setDomainName

public void setDomainName(java.lang.String domainName)
Sets the domain name of the user or group to whom to assign the task.

Parameters:
domainName - The domain name.

getSpecifiedUserId

public java.lang.String getSpecifiedUserId()
Retrieves the user identifier (principal identifier) for the user to whom the task is to be assigned.

Returns:
The user identifier.

setSpecifiedUserId

public void setSpecifiedUserId(java.lang.String specifiedUserId)
Sets a specific user identifier to whom to assign the task.

Parameters:
specifiedUserId - The specific user identifier.

getGenericUserString

public java.lang.String getGenericUserString()
Retrieves a generic string to which to assign the user.

Returns:
The generic string.
See Also:
ParticipantInfo.setGenericUserString(String)

setGenericUserString

public void setGenericUserString(java.lang.String genericUserString)
Sets a generic string to which to assign the user. This string can be one of the following:

This way of assigning a task is to be used when evaluating user-defined XPath expressions in a workflow.

Parameters:
genericUserString - The generic string.

getCommonName

public java.lang.String getCommonName()
Common Name for a user returned as a convenience from getTaskInfo()

Returns:
common name for the user

setCommonName

public void setCommonName(java.lang.String commonName)
sets a common name for the user. This property is not used when creating tasks.

Parameters:
commonName -

principalId

public java.lang.String principalId()

populate

public void populate(java.lang.String aUserId,
                     java.lang.String aPrincipalId,
                     long aQueueId,
                     java.lang.String aCommonName)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


[an error occurred while processing this directive] [an error occurred while processing this directive]