StageParticipant

Package	com.adobe.solutions.rca.domain.impl
Class	public class StageParticipant
Inheritance	StageParticipant Participant Object
Implements	IStageParticipant
Subclasses	Approver, Author, Moderator, Reviewer

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 of a stage.

Public Properties

	Property		Defined By
		additionalMetadata : String This property can be used to store additional metadata, while extending the application.	Participant
		assignedTo : IMemberCollection [override] [read-only] Reference to the member collection to which this member is assigned.	StageParticipant
		calculatedDuration : Number Duration calculated from calculatedStartDate and calculatedEndDate.	StageParticipant
		calculatedEndDate : Date The endDate if the participant task has ended.	StageParticipant
		calculatedStartDate : Date The startDate if the participant task has started.	StageParticipant
		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
		createdAt : String The state of review when this participant was added	StageParticipant
		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
		endDate : Date End date of participant's role in the stage.	StageParticipant
		finalComments : String The final comments made by the participant after reviewing or approving a document.	Participant
		ganttItems : ArrayCollection [read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.	StageParticipant
		id : String [read-only] Unique identifier for a participant.	Participant
		itemEndDate : Date [read-only] End date of the item.	StageParticipant
		itemName : String [read-only] Name of the item.	StageParticipant
		itemStartDate : Date [read-only] Start date of the item.	StageParticipant
		itemState : String [read-only] State of the item.	StageParticipant
		itemStatus : String [read-only] Status of the item.	StageParticipant
		itemType : String [read-only] Type of item.	StageParticipant
		name : String [read-only] Name of the member.	Participant
		operationList : ArrayCollection [read-only] A collection of operations that are available to a user through the context menu in the Gantt chart.	StageParticipant
		reviewContext : IReviewContext The details of the review version of which a participant is a part.	Participant
		reviewStage : IStage Stage object which has this participant object in its list of participants.	StageParticipant
		role : String [read-only] Role of the member in the workflow.	Participant
		showChildren : Boolean A Boolean flag to determine if the children need to be displayed.	StageParticipant
		showParent : Boolean A Boolean flag to determine if the parent needs to be displayed.	StageParticipant
		startDate : Date Start date of participant's role in the stage.	StageParticipant
		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
		StageParticipant(value:StageParticipantVO) The constructor for StageParticipant class.	StageParticipant
		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
		calculateDates():void Populates the calculatedStartDate and calculatedEndDate fields.	StageParticipant
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	Participant
		hasChildren():Boolean A Boolean function to determine if the item has displayable children.	StageParticipant
		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

assignedTo

property

assignedTo:IMemberCollection [read-only] [override]

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
override public function get assignedTo():IMemberCollection

calculatedDuration

property

calculatedDuration:Number

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Duration calculated from calculatedStartDate and calculatedEndDate.

Implementation
public function get calculatedDuration():Number
public function set calculatedDuration(value:Number):void

calculatedEndDate

property

calculatedEndDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The endDate if the participant task has ended. Otherwise the expected end date.

Implementation
public function get calculatedEndDate():Date
public function set calculatedEndDate(value:Date):void

calculatedStartDate

property

calculatedStartDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The startDate if the participant task has started. Otherwise the expected start date.

Implementation
public function get calculatedStartDate():Date
public function set calculatedStartDate(value:Date):void

createdAt

property

createdAt:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The state of review when this participant was added

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

endDate

property

endDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

End date of participant's role in the stage.

Implementation
public function get endDate():Date
public function set endDate(value:Date):void

ganttItems

property

ganttItems:ArrayCollection [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.

Implementation
public function get ganttItems():ArrayCollection

itemEndDate

property

itemEndDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

End date of the item.

Implementation
public function get itemEndDate():Date

itemName

property

itemName: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 item.

Implementation
public function get itemName():String

itemStartDate

property

itemStartDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Start date of the item.

Implementation
public function get itemStartDate():Date

itemState

property

itemState: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)

State of the item.

Implementation
public function get itemState():String

itemStatus

property

itemStatus: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)

Status of the item.

Implementation
public function get itemStatus():String

itemType

property

itemType: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)

Type of item.

Implementation
public function get itemType():String

operationList

property

operationList:ArrayCollection [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A collection of operations that are available to a user through the context menu in the Gantt chart.

Implementation
public function get operationList():ArrayCollection

reviewStage

property

reviewStage:IStage

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Stage object which has this participant object in its list of participants.

Implementation
public function get reviewStage():IStage
public function set reviewStage(value:IStage):void

showChildren

property

showChildren:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the children need to be displayed.

Implementation
public function get showChildren():Boolean
public function set showChildren(value:Boolean):void

showParent

property

showParent:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the parent needs to be displayed.

Implementation
public function get showParent():Boolean
public function set showParent(value:Boolean):void

startDate

property

startDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Start date of participant's role in the stage.

Implementation
public function get startDate():Date
public function set startDate(value:Date):void

Constructor Detail