com.adobe.solutions.rca.domain

# IStage - AS3 Review, Commenting, and Approval

Package | com.adobe.solutions.rca.domain
Interface | public interface IStage extends IGanttDataItem , IMemberCollection
Implementors | Stage

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Defines a stage inside a schedule template.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | additionalMetadata : String This property can be used to store additional metadata while extending the application. | IStage
|  | allMemberList : IList [read-only] The property returns a collection of all members. | IMemberCollection
|  | assignTaskToInitiatorProcess : String The process that overrides the default AssignTaskToInitiator process. | IStage
|  | assignTaskToParticipantProcess : String The process that overrides the default AssignTaskToParticipant process. | IStage
|  | calculatedEndDate : Date The endDate if a review has ended. | IStage
|  | calculatedStartDate : Date The startDate if a review has started. | IStage
|  | disposition : String This property can be used to store a custom status for the stage. | IStage
|  | duration : int The time period in duration unit after which this stage expires. | IStage
|  | durationUnit : String The unit for the duration field. | IStage
|  | endDate : Date Date on which the stage execution ended. | IStage
|  | ganttItems : ArrayCollection [read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True. | IGanttDataItem
|  | id : String [read-only] A unique identifier for this stage. | IStage
|  | itemEndDate : Date [read-only] End date of the item. | IGanttDataItem
|  | itemName : String [read-only] Name of the item. | IGanttDataItem
|  | itemStartDate : Date [read-only] Start date of the item. | IGanttDataItem
|  | itemState : String [read-only] State of the item. | IGanttDataItem
|  | itemStatus : String [read-only] Status of the item. | IGanttDataItem
|  | itemType : String [read-only] Type of item. | IGanttDataItem
|  | memberList : IList [read-only] The property returns a collection of directly associated members. | IMemberCollection
|  | moderators : IList [read-only] Returns a list of moderators for this stage. | IStage
|  | name : String Name of this stage. | IStage
|  | nonExpiringStage : Boolean This Boolean flag determines the post-expiry behaviour of a stage. | IStage
|  | nonModeratorParticipant : IList [read-only] Returns a list of non-moderator participants (reviewers and approvers) for this stage. | IStage
|  | operationList : ArrayCollection [read-only] A collection of operations that are available to a user through the context menu in the Gantt chart. | IGanttDataItem
|  | participants : IList This property holds the collection of participants for this stage. | IStage
|  | postProcessHookName : String Name of the process that is executed after the start of this stage. | IStage
|  | preProcessHookName : String Name of the process that is executed before the start of this stage. | IStage
|  | reference : Boolean This Boolean value decides whether this stage is a reference to a stage template or not. | IStage
|  | reminders : IList This property holds the collection of reminders associated with this stage. | IStage
|  | requiresInitiatorReview : Boolean This Boolean value to decide if in a creation stage an initiator review is required after a collateral is produced or not. | IStage
|  | 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. | IStage
|  | reviewContext : IReviewContext Review context object for this review stage. | IStage
|  | showChildren : Boolean A Boolean flag to determine if the children need to be displayed. | IGanttDataItem
|  | showParent : Boolean A Boolean flag to determine if the parent needs to be displayed. | IGanttDataItem
|  | signatureType : String Type of signature required for an approval stage. | IStage
|  | stageNo : int Number of this stage within the schedule template. | IStage
|  | startDate : Date Date on which the stage execution started. | IStage
|  | status : String Status of the stage. | IStage
|  | taskType : String This property determines the mechanism of task delivery to participants. | IStage
|  | type : String Defines the type of the stage. | IStage
|  | uniqueMemberList : IList [read-only] The property returns a collection of unique members. | IMemberCollection
|  | vo : ReviewStageVO The Value Object for this stage. | IStage
|  | 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. | IStage

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation adds a member to the collection and submits the change to the server. | IMemberCollection
|  | addParticipant(participant:IStageParticipant):void Adds a participant at the end of the list of participants for this stage. | IStage
|  | addParticipantAt(participant:IStageParticipant, index:int):void Adds a participant at the end of the list of participants for this stage. | IStage
|  | calculateDates():void Populates the calculatedStartDate and calculatedEndDate fields. | IStage
|  | calculateStageDuration():Number Calculates duration for this stage based on start and end dates. | IStage
|  | fetchStageDocument():mx.rpc:AsyncToken Fetches original document for this stage. | IStage
|  | fetchStageDocumentWithComment():mx.rpc:AsyncToken Fetches document for this stage in the current state. | IStage
|  | hasChildren():Boolean A Boolean function to determine if the item has displayable children. | IGanttDataItem
|  | removeAllParticipants():void Removes all the participants in this stage. | IStage
|  | removeMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation removes a member from the collection and submits the change to the server. | IMemberCollection
|  | removeParticipantAt(index:int):IStageParticipant Removes a participant at the index from the list of participants for this stage. | IStage
|  | resolveStage():mx.rpc:AsyncToken Resolves the reference if this stage is a reference to a stage template. | IStage
|  | updateDurationAndSave():mx.rpc:AsyncToken Updates the stage duration for this stage. | IStage
|  | updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken This remote operation updates the tile of a member present in collection and submits the change to the server. | IMemberCollection

Property Detail

### additionalMetadata

property

`additionalMetadata:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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`

### assignTaskToInitiatorProcess

property

`assignTaskToInitiatorProcess:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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

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

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

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

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`

Related API Elements

durationUnit

### durationUnit

property

`durationUnit:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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`

Related API Elements

duration

### endDate

property

`endDate:Date`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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`

### id

property

`id:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

A unique identifier for this stage.

Implementation
`public function get id():String`

### moderators

property

`moderators:IList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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 `stageParticpantChanged` 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.0

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

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

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 `stageParticpantChanged` event.

Implementation
`public function get nonModeratorParticipant():IList`

### participants

property

`participants:IList`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This property holds the collection of participants for this stage.

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

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

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

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

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

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

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

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`

Related API Elements

com.adobe.solutions.rca.domain.IReviewContext

### signatureType

property

`signatureType:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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

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

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`

Related API Elements

com.adobe.solutions.rca.constant.StageStatus

### taskType

property

`taskType:String`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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`

### vo

property

`vo:ReviewStageVO`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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`
Method Detail

### addParticipant

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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.

Related API Elements

com.adobe.solutions.rca.domain.IStageParticipant

### addParticipantAt

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Populates the `calculatedStartDate` and `calculatedEndDate` fields.

Related API Elements

calculatedStartDate
calculatedEndDate

### calculateStageDuration

()
method

`public function calculateStageDuration():Number`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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.

### fetchStageDocument

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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.

### removeAllParticipants

()
method

`public function removeAllParticipants():void`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Removes all the participants in this stage.

### removeParticipantAt

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10.0

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

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

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00