Participant

Package	com.adobe.solutions.rca.domain.impl
Class	public class Participant
Inheritance	Participant Object
Implements	IParticipant, IEventDispatcher
Subclasses	Initiator, StageParticipant

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This class defines a participant in a review workflow.

Public Properties

	Property		Defined By
		additionalMetadata : String This property can be used to store additional metadata, while extending the application.	Participant
		assignedTo : IMemberCollection [read-only] Reference to the member collection to which this member is assigned.	Participant
		canonicalName : String [read-only] CanonicalName of the member as defined in Document Server User Management.	Participant
		completedBy : String This property stores the reference to the user who completed the task assigned to a participant.	Participant
		completedFromIP : String This property holds the IP from which a task assigned to a participant is completed.	Participant
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		disposition : String Current disposition of a participant, if any.	Participant
		domainName : String [read-only] Domain name of the member as defined in Document Server User Management.	Participant
		email : String [read-only] Email of the member.	Participant
		finalComments : String The final comments made by the participant after reviewing or approving a document.	Participant
		id : String [read-only] Unique identifier for a participant.	Participant
		name : String [read-only] Name of the member.	Participant
		reviewContext : IReviewContext The details of the review version of which a participant is a part.	Participant
		role : String [read-only] Role of the member in the workflow.	Participant
		status : String Current status of a participant.	Participant
		title : String [read-only] Title of the member in the workflow.	Participant
		type : String [read-only]	Participant
		user : IUser The user object for a participant.	Participant
		vo : ParticipantVO The Value Object for a participant.	Participant

Public Methods

	Method		Defined By
		Participant(value:ParticipantVO) The constructor for Participant class.	Participant
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	Participant
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Participant
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Participant
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Participant
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	Participant

Property Detail

additionalMetadata

property

additionalMetadata:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This property can be used to store additional metadata, while extending the application.

Implementation
public function get additionalMetadata():String
public function set additionalMetadata(value:String):void

assignedTo

property

assignedTo:IMemberCollection [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Reference to the member collection to which this member is assigned.

Implementation
public function get assignedTo():IMemberCollection

canonicalName

property

canonicalName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

CanonicalName of the member as defined in Document Server User Management. The combination of canonicalName and domainName are used to uniquely identify a user.

Implementation
public function get canonicalName():String

completedBy

property

completedBy:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This property stores the reference to the user who completed the task assigned to a participant.

Implementation
public function get completedBy():String
public function set completedBy(value:String):void

completedFromIP

property

completedFromIP:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This property holds the IP from which a task assigned to a participant is completed.

Implementation
public function get completedFromIP():String
public function set completedFromIP(value:String):void

disposition

property

disposition:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Current disposition of a participant, if any.

Implementation
public function get disposition():String
public function set disposition(value:String):void

domainName

property

domainName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Domain name of the member as defined in Document Server User Management. The combination of canonicalName and domainName are used to uniquely identify a user.

Implementation
public function get domainName():String

email

property

email:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Email of the member.

This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.

Implementation
public function get email():String

finalComments

property

finalComments:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The final comments made by the participant after reviewing or approving a document.

Implementation
public function get finalComments():String
public function set finalComments(value:String):void

id

property

id:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Unique identifier for a participant.

Implementation
public function get id():String

name

property

name:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Name of the member.

This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.

Implementation
public function get name():String

reviewContext

property

reviewContext:IReviewContext

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The details of the review version of which a participant is a part.

Implementation
public function get reviewContext():IReviewContext
public function set reviewContext(value:IReviewContext):void

role

property

role:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Role of the member in the workflow.

This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.

Implementation
public function get role():String

status

property

status:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Current status of a participant.

Implementation
public function get status():String
public function set status(value:String):void

title

property

title:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Title of the member in the workflow.

Implementation
public function get title():String

type

property

type:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This property can be used as the source for data binding. When this property is modified, it dispatches the userUpdated event.

Implementation
public function get type():String

user

property

user:IUser

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The user object for a participant.

Implementation
public function get user():IUser
public function set user(value:IUser):void

vo

property

vo:ParticipantVO

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The Value Object for a participant.

Implementation
public function get vo():ParticipantVO
public function set vo(value:ParticipantVO):void

Constructor Detail

Participant

()

Constructor

public function Participant(value:ParticipantVO)

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The constructor for Participant class.

Parameters

value:ParticipantVO — Participant value object.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Legal Notices | Online Privacy Policy

Participant - AS3 Review, Commenting, and Approval

Classes x

additionalMetadata

assignedTo

canonicalName

completedBy

completedFromIP

disposition

domainName

email

finalComments

id

name

reviewContext

role

status

title

type

user

vo

Participant

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger