| 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) |
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
| Method | Defined By | ||
|---|---|---|---|
|
This remote operation adds a member to the collection and submits the change to the server. | IMemberCollection | |
Adds a participant at the end of the list of participants for this stage. | IStage | ||
Adds a participant at the end of the list of participants for this stage. | IStage | ||
Populates the calculatedStartDate and calculatedEndDate fields. | IStage | ||
Calculates duration for this stage based on start and end dates. | IStage | ||
Fetches original document for this stage. | IStage | ||
Fetches document for this stage in the current state. | IStage | ||
|
A Boolean function to determine if the item has displayable children. | IGanttDataItem | |
Removes all the participants in this stage. | IStage | ||
|
This remote operation removes a member from the collection and submits the change to the server. | IMemberCollection | |
Removes a participant at the index from the list of participants for this stage. | IStage | ||
Resolves the reference if this stage is a reference to a stage template. | IStage | ||
Updates the stage duration for this stage. | IStage | ||
|
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):voidassignTaskToInitiatorProcess | 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):voidassignTaskToParticipantProcess | 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):voidcalculatedEndDate | 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):voidcalculatedStartDate | 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):voiddisposition | 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):voidduration | 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):voidRelated API Elements
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):voidRelated API Elements
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):voidid | property |
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():IListname | property |
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):voidnonModeratorParticipant | 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():IListparticipants | 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):voidpostProcessHookName | 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):voidpreProcessHookName | 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):voidreference | 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):voidreminders | 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):voidrequiresInitiatorReview | 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):voidresolved | 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):voidreviewContext | 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):voidRelated API Elements
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):voidstageNo | 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):voidstartDate | 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):voidstatus | 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):voidRelated API Elements
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):voidtype | property |
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):voidwaitForExpiry | 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):voidMethod 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
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
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.
ReturnsNumber — 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.
Returnsmx.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.
Returnsmx.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.
|
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.
Returnsmx.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.
Returnsmx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
Thu Dec 4 2014, 05:50 PM -08:00