com.adobe.idp.taskmanager.dsc.client.task.ParticipantInfo (Livecycle)

Public Methods

	Method		Defined By
		ParticipantInfo() Default constructor.	ParticipantInfo
		String getCommonName() Common Name for a user returned as a convenience from getTaskInfo()	ParticipantInfo
		String getDomainName() Retrieves the domain name of the assigned user or group.	ParticipantInfo
		String getGenericUserString() Retrieves a generic string to which to assign the user.	ParticipantInfo
		String getGroupCannonicalName() Retrieves the canonical name for an assigned group.	ParticipantInfo
		long getQueueID() Retrieves the queue identifier.	ParticipantInfo
		String getSpecifiedUserId() Retrieves the user identifier (principal identifier) for the user to whom the task is to be assigned.	ParticipantInfo
		String getUserCannonicalName() Retrieves the user's canonical name for an assigned task.	ParticipantInfo
		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.	ParticipantInfo
		void populate(String aUserId, long aQueueId, String aCommonName) For internal use only.	ParticipantInfo
		void setCommonName(String commonName) Sets a common name for the user.	ParticipantInfo
		void setDomainName(String domainName) Sets the domain name of the user or group to whom to assign the task.	ParticipantInfo
		void setGenericUserString(String genericUserString) Sets a generic string to which to assign the user.	ParticipantInfo
		void setGroupCannonicalName(String groupCannonicalName) Sets the canonical name of the group to which to assign the task.	ParticipantInfo
		void setQueueID(long queueID) Sets the queue identifier for the queue to which to assign the task.	ParticipantInfo
		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.	ParticipantInfo
		void setSpecifiedUserId(String specifiedUserId) Sets a specific user identifier to whom to assign the task.	ParticipantInfo
		void setUserCannonicalName(String userCannonicalName) Sets the canonical name of a user to whom to assign the task.	ParticipantInfo
		String toString() Retrieves the participant information for whom the task is assigned.	ParticipantInfo

Constructor Detail

ParticipantInfo

()

public ParticipantInfo()

Default constructor.

Method Detail

getCommonName

()

public String getCommonName()

Common Name for a user returned as a convenience from getTaskInfo()

Returns

common name for the user

getDomainName

()

public String getDomainName()

Retrieves the domain name of the assigned user or group.

Returns

The domain name.

getGenericUserString

()

public String getGenericUserString()

Retrieves a generic string to which to assign the user.

Returns

The generic string.

See also

setGenericUserString(String)

getGroupCannonicalName

()

public String getGroupCannonicalName()

Retrieves the canonical name for an assigned group.

Returns

The group canonical name.

getQueueID

()

public long getQueueID()

Retrieves the queue identifier.

Returns

The queue identifier.

getSpecifiedUserId

()

public String getSpecifiedUserId()

Retrieves the user identifier (principal identifier) for the user to whom the task is to be assigned.

Returns

The user identifier.

getUserCannonicalName

()

public String getUserCannonicalName()

Retrieves the user's canonical name for an assigned task.

Returns

The user's canonical name.

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.

populate

()

public void populate(String aUserId, long aQueueId, String aCommonName)

For internal use only.

Parameters

	`aUserId`

	`aQueueId`

	`aCommonName`

setCommonName

()

public void setCommonName(String commonName)

Sets a common name for the user. This property is not used when creating tasks.

Parameters

commonName

setDomainName

()

public void setDomainName(String domainName)

Sets the domain name of the user or group to whom to assign the task.

Parameters

domainName — The domain name.

setGenericUserString

()

public void setGenericUserString(String genericUserString)

Sets a generic string to which to assign the user. This string can be one of the following:

A user's identifier.
A user's login unique identifier. Note that this is not guaranteed to be unique in the system: the first one found will be used.
A group identifier.

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

Parameters

genericUserString — The generic string.

setGroupCannonicalName

()

public void setGroupCannonicalName(String groupCannonicalName)

Sets the canonical name of the group to which to assign the task.

Parameters

groupCannonicalName — The canonical name of the group.

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.

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.

setSpecifiedUserId

()

public void setSpecifiedUserId(String specifiedUserId)

Sets a specific user identifier to whom to assign the task.

Parameters

specifiedUserId — The specific user identifier.

setUserCannonicalName

()

public void setUserCannonicalName(String userCannonicalName)

Sets the canonical name of a user to whom to assign the task.

Parameters

userCannonicalName — The canonical name of the user.

toString

()

public String toString()

Retrieves the participant information for whom the task is assigned.

Returns

The participant information.

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/taskmanager/dsc/client/task/ParticipantInfo.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ParticipantInfo	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples

Package	com.adobe.idp.taskmanager.dsc.client.task
Class	public class ParticipantInfo
Inheritance	ParticipantInfo Object