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 

ParticipantVO  - AS3 Review, Commenting, and Approval

Packagecom.adobe.solutions.rca.vo
Classpublic class ParticipantVO
InheritanceParticipantVO Inheritance NamedVO Inheritance BaseVO Inheritance Object
Subclasses InitiatorVO, StageParticipantVO

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

ParticipantVO represents a participant in a review. A participant can be an initiator, a reviewer, a moderator, or an approver. It is the super class of InitiatorVO, ReviewerVO, ModeratorVO, ApproverVO.



Public Properties
 PropertyDefined By
  additionalMetadata : String
This property can be used to store additional metadata, while extending the application.
ParticipantVO
  canonicalName : String
Canonical name of the user or group as defined in User Manager.
ParticipantVO
  completedBy : String
This property stores a reference to the user who completed the task.
ParticipantVO
  completedFromIP : String
This property holds the IP from which the task was completed.
ParticipantVO
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  disposition : String
Current disposition of participant, if any.
ParticipantVO
  domainName : String
Domain to which the user or group belongs as defined in User Manager.
ParticipantVO
 InheritedentityPath : String
Gets the entity name in the content repository.
NamedVO
  finalComments : String
The final comments made by a participant after reviewing or approving a document.
ParticipantVO
 Inheritedid : String
Get the ID of the VO.
BaseVO
  reviewContext : ReviewContextVO
The details of the review version.
ParticipantVO
  status : String
Current status of the participant.
ParticipantVO
  umOid : String
The Document Server User Manager OID of the participant.
ParticipantVO
Public Methods
 MethodDefined By
  
The constructor for ParticipantVO class.
ParticipantVO
 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

canonicalName

property 
canonicalName:String

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

Canonical name of the user or group as defined in User Manager.



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

completedBy

property 
completedBy: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 stores a reference to the user who completed the task.



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

completedFromIP

property 
completedFromIP: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 holds the IP from which the task was completed.



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

Current disposition of participant, if any.



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

domainName

property 
domainName:String

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

Domain to which the user or group belongs as defined in User Manager.



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

finalComments

property 
finalComments:String

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

The final comments made by a participant after reviewing or approving a document.



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

The details of the review version.



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

Current status of the participant.



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

umOid

property 
umOid:String

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

The Document Server User Manager OID of the participant.



Implementation
    public function get umOid():String
    public function set umOid(value:String):void
Constructor Detail

ParticipantVO

()Constructor
public function ParticipantVO()

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 ParticipantVO class.