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

ReviewStageVO  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.vo
Classpublic class ReviewStageVO
InheritanceReviewStageVO Inheritance NamedVO Inheritance BaseVO Inheritance Object
Subclasses StageTemplateVO

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

Defines the Value Object for a stage inside a schedule template.



Public Properties
 PropertyDefined By
  additionalMetadata : String
This property can be used to store additional metadata, while extending the application.
ReviewStageVO
  assignTaskToInitiatorProcess : String
Process that can be used to override the default AssignTaskToInitiator process.
ReviewStageVO
  assignTaskToParticipantProcess : String
Process that can be used to override the default AssignTaskToParticipant process.
ReviewStageVO
 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 custom status for the stage.
ReviewStageVO
  duration : int
Duration determines the time period after which a stage expires.
ReviewStageVO
  durationUnit : String
Duration unit determines the unit for duration field.
ReviewStageVO
  endDate : Date
Date on which the stage execution ended.
ReviewStageVO
 InheritedentityPath : String
Gets the entity name in the content repository.
NamedVO
 Inheritedid : String
Get the ID of the VO.
BaseVO
  name : String
The name of the stage.
ReviewStageVO
  nonExpiringStage : Boolean
This Boolean flag determines the post-expiry behaviour of the stage.
ReviewStageVO
  participants : IList
This property holds the collection of participants for this stage.
ReviewStageVO
  postProcessHookName : String
Post-process hook is a process that is executed after a stage ends.
ReviewStageVO
  preProcessHookName : String
Pre-process hook is a process that is executed before the start of a stage.
ReviewStageVO
  reference : Boolean
A Boolean flag to indicate whether this stage is a reference to a stage template or not.
ReviewStageVO
  reminders : IList
This property holds the collection of reminders associated with this stage.
ReviewStageVO
  requiresInitiatorReview : Boolean
A Boolean flag to indicate whether an initiator review is required in a creation stage, after a collateral is produced, or not.
ReviewStageVO
  resolved : Boolean
This Boolean flag indicates whether the reference has been resolved, if this stage is a reference to a stage template.
ReviewStageVO
  reviewContext : ReviewContextVO
Review context object for this review stage.
ReviewStageVO
  signatureType : String
Type of digital signature required for an approval stage.
ReviewStageVO
  stageNo : int
Number of stage in the schedule.
ReviewStageVO
  startDate : Date
Date on which the stage execution started.
ReviewStageVO
  status : String
Status of the stage.
ReviewStageVO
  taskType : String
This property determines the mechanism of task delivery to participants.
ReviewStageVO
  type : String
This property defines the type of the stage.
ReviewStageVO
  waitForExpiry : Boolean
If this Boolean flag is set to True, the stage waits for the complete duration even if all the stage participants have completed their tasks.
ReviewStageVO
Public Methods
 MethodDefined By
  
The constructor for ReviewStageVO class.
ReviewStageVO
 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
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
Returns the primitive value of the specified object.
Object
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

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)

Process that can be used to override 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)

Process that can be used to override the default AssignTaskToParticipant process.



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

Duration determines the time period after which a 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)

Duration unit determines the unit for 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

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)

The name of the 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 the stage.



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

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.



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)

Post-process hook is a process that is executed after a stage ends.



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)

Pre-process hook is a process that is executed before the start of a 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)

A Boolean flag to indicate 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)

A Boolean flag to indicate whether an initiator review is required in a creation stage, 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)

This Boolean flag indicates whether the reference has been resolved, if this stage is a reference to a stage template.



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

reviewContext

property 
reviewContext:ReviewContextVO

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():ReviewContextVO
    public function set reviewContext(value:ReviewContextVO):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 digital 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 stage in the schedule. The first stage is numbered one.



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)

This property defines the type of the stage.



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

Related API Elements

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)

If this Boolean flag is set to True, the stage waits for the complete duration even if all the stage participants have completed their tasks.



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

ReviewStageVO

()Constructor
public function ReviewStageVO()

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

The constructor for ReviewStageVO class.