ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.rca.domain.impl 

Stage  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.domain.impl
Classpublic class Stage
InheritanceStage Inheritance Object
Implements IStage, IEventDispatcher
Subclasses StageTemplate

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 stage in a review workflow.



Public Properties
 PropertyDefined By
  additionalMetadata : String
This property can be used to store additional metadata while extending the application.
Stage
  allMemberList : IList
[read-only] The property returns a collection of all members.
Stage
  assignTaskToInitiatorProcess : String
The process that overrides the default AssignTaskToInitiator process.
Stage
  assignTaskToParticipantProcess : String
The process that overrides the default AssignTaskToParticipant process.
Stage
  calculatedEndDate : Date
The endDate if a review has ended.
Stage
  calculatedStartDate : Date
The startDate if a review has started.
Stage
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  disposition : String
This property can be used to store a custom status for the stage.
Stage
  duration : int
The time period in duration unit after which this stage expires.
Stage
  durationUnit : String
The unit for the duration field.
Stage
  endDate : Date
Date on which the stage execution ended.
Stage
  ganttItems : ArrayCollection
[read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.
Stage
  id : String
[read-only] A unique identifier for this stage.
Stage
  itemEndDate : Date
[read-only] End date of the item.
Stage
  itemName : String
[read-only] Name of the item.
Stage
  itemStartDate : Date
[read-only] Start date of the item.
Stage
  itemState : String
[read-only] State of the item.
Stage
  itemStatus : String
[read-only] Status of the item.
Stage
  itemType : String
[read-only] Type of item.
Stage
  memberList : IList
[read-only] The property returns a collection of directly associated members.
Stage
  moderators : IList
[read-only] Returns a list of moderators for this stage.
Stage
  name : String
Name of this stage.
Stage
  nonExpiringStage : Boolean
This Boolean flag determines the post-expiry behaviour of a stage.
Stage
  nonModeratorParticipant : IList
[read-only] Returns a list of non-moderator participants (reviewers and approvers) for this stage.
Stage
  operationList : ArrayCollection
[read-only] A collection of operations that are available to a user through the context menu in the Gantt chart.
Stage
  participants : IList
This property holds the collection of participants for this stage.
Stage
  postProcessHookName : String
Name of the process that is executed after the start of this stage.
Stage
  preProcessHookName : String
Name of the process that is executed before the start of this stage.
Stage
  reference : Boolean
This Boolean value decides whether this stage is a reference to a stage template or not.
Stage
  reminders : IList
This property holds the collection of reminders associated with this stage.
Stage
  requiresInitiatorReview : Boolean
This Boolean value to decide if in a creation stage an initiator review is required after a collateral is produced or not.
Stage
  resolved : Boolean
If this stage is a reference to a stage template, then whether the reference has been resolved or not is decided by this Boolean value.
Stage
  reviewContext : IReviewContext
Review context object for this review stage.
Stage
  showChildren : Boolean
A Boolean flag to determine if the children need to be displayed.
Stage
  showParent : Boolean
A Boolean flag to determine if the parent needs to be displayed.
Stage
  signatureType : String
Type of signature required for an approval stage.
Stage
  stageNo : int
Number of this stage within the schedule template.
Stage
  startDate : Date
Date on which the stage execution started.
Stage
  status : String
Status of the stage.
Stage
  taskType : String
This property determines the mechanism of task delivery to participants.
Stage
  type : String
Defines the type of the stage.
Stage
  uniqueMemberList : IList
[read-only] The property returns a collection of unique members.
Stage
  vo : ReviewStageVO
The Value Object for this stage.
Stage
  waitForExpiry : Boolean
A Boolean value to decide whether to wait for the complete duration for expiry even if all the stage participants have completed their tasks before expiry duration or not.
Stage
Public Methods
 MethodDefined By
  
Stage(value:ReviewStageVO = null)
The constructor for Stage class.
Stage
  
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.
Stage
  
This remote operation adds a member to the collection and submits the change to the server.
Stage
  
Adds a participant at the end of the list of participants for this stage.
Stage
  
Adds a participant at the end of the list of participants for this stage.
Stage
  
Populates the calculatedStartDate and calculatedEndDate fields.
Stage
  
Calculates duration for this stage based on start and end dates.
Stage
  
Dispatches an event into the event flow.
Stage
  
Fetches original document for this stage.
Stage
  
Fetches document for this stage in the current state.
Stage
  
A Boolean function to determine if the item has displayable children.
Stage
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Stage
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Removes all the participants in this stage.
Stage
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Stage
  
This remote operation removes a member from the collection and submits the change to the server.
Stage
  
Removes a participant at the index from the list of participants for this stage.
Stage
  
Resolves the reference if this stage is a reference to a stage template.
Stage
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
  
Updates the stage duration for this stage.
Stage
  
This remote operation updates the tile of a member present in collection and submits the change to the server.
Stage
 Inherited
Returns the primitive value of the specified object.
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Stage
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

allMemberList

property 
allMemberList:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The property returns a collection of all members. It takes into consideration any child objects that may be of type IMemberCollection.

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



Implementation
    public function get allMemberList():IList

assignTaskToInitiatorProcess

property 
assignTaskToInitiatorProcess:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The process that overrides the default AssignTaskToInitiator process.



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

assignTaskToParticipantProcess

property 
assignTaskToParticipantProcess:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The process that overrides the default AssignTaskToParticipant process.



Implementation
    public function get assignTaskToParticipantProcess():String
    public function set assignTaskToParticipantProcess(value:String):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 a review 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 a review has started. Otherwise the expected start date.



Implementation
    public function get calculatedStartDate():Date
    public function set calculatedStartDate(value:Date):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)

This property can be used to store a custom status for the stage.



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

duration

property 
duration:int

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The time period in duration unit after which this stage expires.



Implementation
    public function get duration():int
    public function set duration(value:int):void

durationUnit

property 
durationUnit:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The unit for the duration field.



Implementation
    public function get durationUnit():String
    public function set durationUnit(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)

Date on which the stage execution ended.



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.

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



Implementation
    public function get ganttItems():ArrayCollection

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)

A unique identifier for this stage.



Implementation
    public function get id():String

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

memberList

property 
memberList:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The property returns a collection of directly associated members.

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



Implementation
    public function get memberList():IList

moderators

property 
moderators:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Returns a list of moderators for this stage.

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



Implementation
    public function get moderators():IList

name

property 
name:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Name of this stage.



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

nonExpiringStage

property 
nonExpiringStage:Boolean

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This Boolean flag determines the post-expiry behaviour of a stage.



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

nonModeratorParticipant

property 
nonModeratorParticipant:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Returns a list of non-moderator participants (reviewers and approvers) for this stage.

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



Implementation
    public function get nonModeratorParticipant():IList

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

participants

property 
participants:IList

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 collection of participants for this stage.

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



Implementation
    public function get participants():IList
    public function set participants(value:IList):void

postProcessHookName

property 
postProcessHookName:String

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 process that is executed after the start of this stage.



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

preProcessHookName

property 
preProcessHookName:String

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 process that is executed before the start of this stage.



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

reference

property 
reference:Boolean

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This Boolean value decides whether this stage is a reference to a stage template or not.



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

reminders

property 
reminders:IList

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 collection of reminders associated with this stage.



Implementation
    public function get reminders():IList
    public function set reminders(value:IList):void

requiresInitiatorReview

property 
requiresInitiatorReview:Boolean

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This Boolean value to decide if in a creation stage an initiator review is required after a collateral is produced or not.



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

resolved

property 
resolved:Boolean

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

If this stage is a reference to a stage template, then whether the reference has been resolved or not is decided by this Boolean value.



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

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)

Review context object for this review stage.



Implementation
    public function get reviewContext():IReviewContext
    public function set reviewContext(value:IReviewContext):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

signatureType

property 
signatureType:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Type of signature required for an approval stage.



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

stageNo

property 
stageNo:int

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Number of this stage within the schedule template.



Implementation
    public function get stageNo():int
    public function set stageNo(value:int):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)

Date on which the stage execution started.



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

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)

Status of the stage.



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

taskType

property 
taskType: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 determines the mechanism of task delivery to participants.



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

type

property 
type:String

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the type of the stage.



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

uniqueMemberList

property 
uniqueMemberList:IList  [read-only]

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The property returns a collection of unique members.

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



Implementation
    public function get uniqueMemberList():IList

vo

property 
vo:ReviewStageVO

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 this stage.



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

waitForExpiry

property 
waitForExpiry: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 value to decide whether to wait for the complete duration for expiry even if all the stage participants have completed their tasks before expiry duration or not.



Implementation
    public function get waitForExpiry():Boolean
    public function set waitForExpiry(value:Boolean):void
Constructor Detail

Stage

()Constructor
public function Stage(value:ReviewStageVO = null)

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 Stage class.

Parameters
value:ReviewStageVO (default = null) — Stage 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.

addMemberAndSave

()method 
public function addMemberAndSave(member:IMember):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This remote operation adds a member to the collection and submits the change to the server.

Parameters

member:IMember — The member to be added to member collection.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

addParticipant

()method 
public function addParticipant(participant:IStageParticipant):void

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Adds a participant at the end of the list of participants for this stage.

Parameters

participant:IStageParticipant — Participant to be added to this stage.

addParticipantAt

()method 
public function addParticipantAt(participant:IStageParticipant, index:int):void

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Adds a participant at the end of the list of participants for this stage.

Parameters

participant:IStageParticipant — Participant to be added to stage.
 
index:int — Index at which this participant needs to be added.

calculateDates

()method 
public function calculateDates():void

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Populates the calculatedStartDate and calculatedEndDate fields.

calculateStageDuration

()method 
public function calculateStageDuration():Number

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Calculates duration for this stage based on start and end dates.

Returns
Number — It returns the duration for this stage in milliseconds.

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.

fetchStageDocument

()method 
public function fetchStageDocument():mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Fetches original document for this stage.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the document used for review in this stage.

fetchStageDocumentWithComment

()method 
public function fetchStageDocumentWithComment():mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Fetches document for this stage in the current state.

Returns
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains the document used for review in this stage with inline comments published by customers.

hasChildren

()method 
public function hasChildren():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 function to determine if the item has displayable children.

Returns
Boolean — It returns a True value if there are displayable children.

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.

removeAllParticipants

()method 
public function removeAllParticipants():void

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Removes all the participants in this stage.

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.

removeMemberAndSave

()method 
public function removeMemberAndSave(member:IMember):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This remote operation removes a member from the collection and submits the change to the server.

Parameters

member:IMember — The member to be removed from member collection.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeParticipantAt

()method 
public function removeParticipantAt(index:int):IStageParticipant

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Removes a participant at the index from the list of participants for this stage.

Parameters

index:int — The index in the list of participants for the stage.

Returns
IStageParticipant — It returns the removed participant.

resolveStage

()method 
public function resolveStage():mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Resolves the reference if this stage is a reference to a stage template.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateDurationAndSave

()method 
public function updateDurationAndSave():mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Updates the stage duration for this stage.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateTitleAndSave

()method 
public function updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This remote operation updates the tile of a member present in collection and submits the change to the server.

Parameters

member:IMember — The member to be removed from member collection.
 
title:String — The title of the member.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

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.

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 will be triggered; false otherwise.