| Package | com.adobe.solutions.rca.domain.impl |
| Class | public class StageTemplate |
| Inheritance | StageTemplate  Stage Object |
| Implements | IStageTemplate |
| 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
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| active : Boolean
A Boolean value to decide if the template is active. | StageTemplate | ||
 | 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 | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| createdBy : String [read-only]
Name of the user who created the template. | StageTemplate | ||
| createdOn : Date [read-only]
The date on which the template was created. | StageTemplate | ||
| description : String
Description of a template. | StageTemplate | ||
| 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 | |
| lastModifiedBy : String [read-only]
Name of the user who last modified the template. | StageTemplate | ||
| lastModifiedOn : Date [read-only]
The date on which the template was last modified. | StageTemplate | ||
| 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 | |
| stageManagement : IStageManagement
Stage management service instance for a template. | StageTemplate | ||
| 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
| Method | Defined By | ||
|---|---|---|---|
StageTemplate(value:com.adobe.solutions.rca.vo:StageTemplateVO = null)
The constructor for StageTemplate class. | StageTemplate | ||
| 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 | |
Deletes the template. | StageTemplate | ||
|
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 | |
Fetches the list of schedule templates which contains a reference to this stage template in the stage list. | StageTemplate | ||
Returns the Value Object for this template. | StageTemplate | ||
|
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 | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes all the participants in this stage. | Stage | |
|
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 | |
Saves the template. | StageTemplate | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
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 | |
|
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
active | property |
active: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 if the template is active.
Implementation
public function get active():Boolean public function set active(value:Boolean):voidcreatedBy | property |
createdOn | property |
description | property |
description:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Description of a template.
Implementation
public function get description():String public function set description(value:String):voidlastModifiedBy | property |
lastModifiedOn | property |
stageManagement | property |
stageManagement:IStageManagement| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Stage management service instance for a template.
Implementation
public function get stageManagement():IStageManagement public function set stageManagement(value:IStageManagement):voidConstructor Detail
StageTemplate | () | Constructor |
public function StageTemplate(value:com.adobe.solutions.rca.vo:StageTemplateVO = 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 StageTemplate class.
value:com.adobe.solutions.rca.vo:StageTemplateVO (default = null) |
Method Detail
deleteTemplate | () | method |
public function deleteTemplate():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) |
Deletes the template.
Returnsmx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the StageTemplateVO or null value if the stage does not exist.
|
getReferringTemplates | () | method |
public function getReferringTemplates():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 the list of schedule templates which contains a reference to this stage template in the stage list.
Returnsmx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of ReviewTemplatVO referring to this stage template.
|
getStageTemplate | () | method |
public function getStageTemplate():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) |
Returns the Value Object for this template. The function tries to fetch the stage template value object based on the template name, and refreshes the current object with a new value object returned from the server.
Returnsmx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the stageTemplateVO.
|
save | () | method |
public function save():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) |
Saves the template. If save is successful, it refreshes the current object with a new value object returned from the server.
Returnsmx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the created stageTemplateVO.
|
Mon Apr 10 2017, 12:28 PM -07:00