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 

IStageParticipant  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.domain
Interfacepublic interface IStageParticipant extends IParticipant , IGanttDataItem , IMember
Implementors StageParticipant

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 basic properties of a participant of a creation, a review, or an approval stage.



Public Properties
 PropertyDefined By
 InheritedadditionalMetadata : String
This property can be used to store additional metadata, while extending the application.
IParticipant
 InheritedassignedTo : IMemberCollection
[read-only] Reference to the member collection to which this member is assigned.
IMember
  calculatedDuration : Number
Duration calculated from calculatedStartDate and calculatedEndDate.
IStageParticipant
  calculatedEndDate : Date
The endDate if the participant task has ended.
IStageParticipant
  calculatedStartDate : Date
The startDate if the participant task has started.
IStageParticipant
 InheritedcanonicalName : String
[read-only] CanonicalName of the member as defined in Document Server User Management.
IMember
 InheritedcompletedBy : String
This property stores the reference to the user who completed the task assigned to a participant.
IParticipant
 InheritedcompletedFromIP : String
This property holds the IP from which a task assigned to a participant is completed.
IParticipant
  createdAt : String
The state of review when this participant was added
IStageParticipant
 Inheriteddisposition : String
Current disposition of a participant, if any.
IParticipant
 InheriteddomainName : String
[read-only] Domain name of the member as defined in Document Server User Management.
IMember
 Inheritedemail : String
[read-only] Email of the member.
IMember
  endDate : Date
End date of participant's role in the stage.
IStageParticipant
 InheritedfinalComments : String
The final comments made by the participant after reviewing or approving a document.
IParticipant
 InheritedganttItems : ArrayCollection
[read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.
IGanttDataItem
 Inheritedid : String
[read-only] Unique identifier for a participant.
IParticipant
 InheriteditemEndDate : Date
[read-only] End date of the item.
IGanttDataItem
 InheriteditemName : String
[read-only] Name of the item.
IGanttDataItem
 InheriteditemStartDate : Date
[read-only] Start date of the item.
IGanttDataItem
 InheriteditemState : String
[read-only] State of the item.
IGanttDataItem
 InheriteditemStatus : String
[read-only] Status of the item.
IGanttDataItem
 InheriteditemType : String
[read-only] Type of item.
IGanttDataItem
 Inheritedname : String
[read-only] Name of the member.
IMember
 InheritedoperationList : ArrayCollection
[read-only] A collection of operations that are available to a user through the context menu in the Gantt chart.
IGanttDataItem
 InheritedreviewContext : IReviewContext
The details of the review version of which a participant is a part.
IParticipant
  reviewStage : IStage
Stage object which has this participant object in its list of participants.
IStageParticipant
 Inheritedrole : String
[read-only] Role of the member in the workflow.
IMember
 InheritedshowChildren : Boolean
A Boolean flag to determine if the children need to be displayed.
IGanttDataItem
 InheritedshowParent : Boolean
A Boolean flag to determine if the parent needs to be displayed.
IGanttDataItem
  startDate : Date
Start date of participant's role in the stage.
IStageParticipant
 Inheritedstatus : String
Current status of a participant.
IParticipant
 Inheritedtitle : String
[read-only] Title of the member in the workflow.
IMember
 Inheriteduser : IUser
The user object for a participant.
IParticipant
 Inheritedvo : ParticipantVO
The Value Object for a participant.
IParticipant
Public Methods
 MethodDefined By
  
Populates the calculatedStartDate and calculatedEndDate fields.
IStageParticipant
 Inherited
A Boolean function to determine if the item has displayable children.
IGanttDataItem
Property Detail

calculatedDuration

property
calculatedDuration:Number

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

Duration calculated from calculatedStartDate and calculatedEndDate.



Implementation
    public function get calculatedDuration():Number
    public function set calculatedDuration(value:Number):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 the participant task 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 the participant task has started. Otherwise the expected start date.



Implementation
    public function get calculatedStartDate():Date
    public function set calculatedStartDate(value:Date):void

createdAt

property 
createdAt: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 state of review when this participant was added



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

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)

End date of participant's role in the stage.



Implementation
    public function get endDate():Date
    public function set endDate(value:Date):void

reviewStage

property 
reviewStage:IStage

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

Stage object which has this participant object in its list of participants.



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

Start date of participant's role in the stage.



Implementation
    public function get startDate():Date
    public function set startDate(value:Date):void
Method Detail

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.