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 

StageTemplate  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.domain.impl
Classpublic class StageTemplate
InheritanceStageTemplate Inheritance Stage Inheritance 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)

This class defines a stage template.



Public Properties
 PropertyDefined By
  active : Boolean
A Boolean value to decide if the template is active.
StageTemplate
 InheritedadditionalMetadata : String
This property can be used to store additional metadata while extending the application.
Stage
 InheritedallMemberList : IList
[read-only] The property returns a collection of all members.
Stage
 InheritedassignTaskToInitiatorProcess : String
The process that overrides the default AssignTaskToInitiator process.
Stage
 InheritedassignTaskToParticipantProcess : String
The process that overrides the default AssignTaskToParticipant process.
Stage
 InheritedcalculatedEndDate : Date
The endDate if a review has ended.
Stage
 InheritedcalculatedStartDate : 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
  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
 Inheriteddisposition : String
This property can be used to store a custom status for the stage.
Stage
 Inheritedduration : int
The time period in duration unit after which this stage expires.
Stage
 InheriteddurationUnit : String
The unit for the duration field.
Stage
 InheritedendDate : Date
Date on which the stage execution ended.
Stage
 InheritedganttItems : ArrayCollection
[read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.
Stage
 Inheritedid : String
[read-only] A unique identifier for this stage.
Stage
 InheriteditemEndDate : Date
[read-only] End date of the item.
Stage
 InheriteditemName : String
[read-only] Name of the item.
Stage
 InheriteditemStartDate : Date
[read-only] Start date of the item.
Stage
 InheriteditemState : String
[read-only] State of the item.
Stage
 InheriteditemStatus : String
[read-only] Status of the item.
Stage
 InheriteditemType : 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
 InheritedmemberList : IList
[read-only] The property returns a collection of directly associated members.
Stage
 Inheritedmoderators : IList
[read-only] Returns a list of moderators for this stage.
Stage
 Inheritedname : String
Name of this stage.
Stage
 InheritednonExpiringStage : Boolean
This Boolean flag determines the post-expiry behaviour of a stage.
Stage
 InheritednonModeratorParticipant : IList
[read-only] Returns a list of non-moderator participants (reviewers and approvers) for this stage.
Stage
 InheritedoperationList : ArrayCollection
[read-only] A collection of operations that are available to a user through the context menu in the Gantt chart.
Stage
 Inheritedparticipants : IList
This property holds the collection of participants for this stage.
Stage
 InheritedpostProcessHookName : String
Name of the process that is executed after the start of this stage.
Stage
 InheritedpreProcessHookName : String
Name of the process that is executed before the start of this stage.
Stage
 Inheritedreference : Boolean
This Boolean value decides whether this stage is a reference to a stage template or not.
Stage
 Inheritedreminders : IList
This property holds the collection of reminders associated with this stage.
Stage
 InheritedrequiresInitiatorReview : Boolean
This Boolean value to decide if in a creation stage an initiator review is required after a collateral is produced or not.
Stage
 Inheritedresolved : 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
 InheritedreviewContext : IReviewContext
Review context object for this review stage.
Stage
 InheritedshowChildren : Boolean
A Boolean flag to determine if the children need to be displayed.
Stage
 InheritedshowParent : Boolean
A Boolean flag to determine if the parent needs to be displayed.
Stage
 InheritedsignatureType : String
Type of signature required for an approval stage.
Stage
  stageManagement : IStageManagement
Stage management service instance for a template.
StageTemplate
 InheritedstageNo : int
Number of this stage within the schedule template.
Stage
 InheritedstartDate : Date
Date on which the stage execution started.
Stage
 Inheritedstatus : String
Status of the stage.
Stage
 InheritedtaskType : String
This property determines the mechanism of task delivery to participants.
Stage
 Inheritedtype : String
Defines the type of the stage.
Stage
 InheriteduniqueMemberList : IList
[read-only] The property returns a collection of unique members.
Stage
 Inheritedvo : ReviewStageVO
The Value Object for this stage.
Stage
 InheritedwaitForExpiry : 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
  
The constructor for StageTemplate class.
StageTemplate
 Inherited
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
 Inherited
This remote operation adds a member to the collection and submits the change to the server.
Stage
 Inherited
Adds a participant at the end of the list of participants for this stage.
Stage
 Inherited
Adds a participant at the end of the list of participants for this stage.
Stage
 Inherited
Populates the calculatedStartDate and calculatedEndDate fields.
Stage
 Inherited
Calculates duration for this stage based on start and end dates.
Stage
  
Deletes the template.
StageTemplate
 Inherited
Dispatches an event into the event flow.
Stage
 Inherited
Fetches original document for this stage.
Stage
 Inherited
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
 Inherited
A Boolean function to determine if the item has displayable children.
Stage
 Inherited
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
 Inherited
Removes all the participants in this stage.
Stage
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Stage
 Inherited
This remote operation removes a member from the collection and submits the change to the server.
Stage
 Inherited
Removes a participant at the index from the list of participants for this stage.
Stage
 Inherited
Resolves the reference if this stage is a reference to a stage template.
Stage
  
Saves the template.
StageTemplate
 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
 Inherited
Updates the stage duration for this stage.
Stage
 Inherited
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
 Inherited
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):void

createdBy

property 
createdBy: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 user who created the template.



Implementation
    public function get createdBy():String

createdOn

property 
createdOn: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)

The date on which the template was created.



Implementation
    public function get createdOn():Date

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

lastModifiedBy

property 
lastModifiedBy: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 user who last modified the template.



Implementation
    public function get lastModifiedBy():String

lastModifiedOn

property 
lastModifiedOn: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)

The date on which the template was last modified.



Implementation
    public function get lastModifiedOn():Date

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):void
Constructor 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.

Parameters
value:com.adobe.solutions.rca.vo:StageTemplateVO (default = null) — Stage template value object.
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.

Returns
mx.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.

Returns
mx.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.

Returns
mx.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.

Returns
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the created stageTemplateVO.