ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.livecycle.rca.model.participant 

AbstractParticipant  - AS3 Review, Commenting, and Approval
Packagecom.adobe.livecycle.rca.model.participant
Classpublic class AbstractParticipant
InheritanceAbstractParticipant Inheritance BaseUser Inheritance Object
Subclasses Approver, Reviewer
Deprecated since Review, Commenting, and Approval 10: Please Use com.adobe.solutions.rca.vo.ParticipantVO

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

Defines the basic properties of a participant in a review.


Public Properties
 PropertyDefined By
  additionalMetaData : String
Specifies additional metadata when you extend the application.
AbstractParticipant
 InheritedcanonicalName : String
Specifies the canonical name of the user or group, as defined in Adobe User Management.
BaseUser
  completedBy : BaseUser
Specifies a reference to the user who completed the task.
AbstractParticipant
  completedFromIp : String
Specifies the IP address from which the task was completed.
AbstractParticipant
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  createdAt : String
Specifies the state of the review when this participant was added.
AbstractParticipant
  disposition : String
Specifies a custom status for the stage.
AbstractParticipant
 Inheriteddomain : String
Specifies the domain to which the user or group belongs, as defined in Adobe User Management.
BaseUser
 Inheritedemail : String
Specifies the email ID of the user or group, as defined in Adobe User Management.
BaseUser
  finalComments : String
Specifies the participant's final comments.
AbstractParticipant
 Inheritedid : String
Specifies the user ID of the user, as defined in Adobe User Management.
BaseUser
 InheritedisGroup : Boolean
Specifies whether the user is a group, as defined in Adobe User Management.
BaseUser
 Inheritedname : String
Specifies the name of the user or group as defined in Adobe User Management.
BaseUser
 Inheritedoid : String
Specifies the OID of the user or group, as defined in Adobe User Management.
BaseUser
  processId : String
Specifies the ID of the Process Management process which was used to assign the task to this participant.
AbstractParticipant
  status : String
Specifies the status of the participant.
AbstractParticipant
  useGroupQueue : Boolean
If true, tasks are assigned to the group queue.
AbstractParticipant
Public Methods
 MethodDefined By
  
AbstractParticipant(self:AbstractParticipant)
Constructor.
AbstractParticipant
 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.
BaseUser
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
BaseUser
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BaseUser
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BaseUser
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BaseUser
Property Detail

additionalMetaData

property
additionalMetaData:String

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

Specifies additional metadata when you extend the application.



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

completedBy

property 
completedBy:BaseUser

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

Specifies a reference to the user who completed the task. This user is different from the current user when the task forward and group queue task are used.



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

completedFromIp

property 
completedFromIp:String

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

Specifies the IP address from which the task was completed.



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

createdAt

property 
createdAt:String

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

Specifies the state of the review when this participant was added.

The default value is CreatedAtType.TEMPLATE_CREATION.



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

Related API Elements

CreatedAtType

disposition

property 
disposition:String

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

Specifies a custom status for the stage.



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

finalComments

property 
finalComments:String

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

Specifies the participant's final comments.



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

processId

property 
processId:String

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

Specifies the ID of the Process Management process which was used to assign the task to this participant.



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

status

property 
status:String

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

Specifies the status of the participant.



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

Related API Elements

ReviewerStatus
ApproverStatus

useGroupQueue

property 
useGroupQueue:Boolean

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

If true, tasks are assigned to the group queue. Any member of the group can claim the task later. Otherwise, individual tasks are assigned to all the members of the group. This flag is applicable only if the participant is part of a group configured in Adobe User Management.

The default value is false.



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

AbstractParticipant

()Constructor
public function AbstractParticipant(self:AbstractParticipant)

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

Constructor. The constructor is used as an abstraction. Do not use directly.

Parameters
self:AbstractParticipant — Specifies the approver or reviewer as the participant in a review.

Throws
IllegalOperationError — Indicates an error while initializing the AbstractParticipant object.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy