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 

ReviewContextVO  - AS3 Review, Commenting, and Approval
Packagecom.adobe.solutions.rca.vo
Classpublic class ReviewContextVO
InheritanceReviewContextVO Inheritance NamedVO Inheritance BaseVO Inheritance Object
Subclasses ReviewTemplateVO

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

This is the top-level object containing details of a particular review version.


Public Properties
 PropertyDefined By
  additionalMetadata : String
Any review specific data can be preserved in this field.
ReviewContextVO
  arsProcessName : String
Name of the process used to generate Approval Routing Sheet (ARS).
ReviewContextVO
  auditLevel : String
The level of audit associated with this review.
ReviewContextVO
  changeDescription : String
This field is used if the review is revised.
ReviewContextVO
  commentServerPath : String
Server location where Adobe Acrobat stores the inline comments.
ReviewContextVO
  commentVisibility : String
Visibility of inline comment, in Adobe Acrobat, across stages.
ReviewContextVO
  complianceCode : String
Compliance code of the schedule template.
ReviewContextVO
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  currentRevision : Boolean
A Boolean flag to indicate whether this is the current revision or not.
ReviewContextVO
  currentStage : int
Stage number this review is currently in (starts with 1).
ReviewContextVO
  customAttributes : IList
List of custom attributes.
ReviewContextVO
  endDate : Date
End date of the review.
ReviewContextVO
 InheritedentityPath : String
Gets the entity name in the content repository.
NamedVO
 Inheritedid : String
Get the ID of the VO.
BaseVO
  initiator : InitiatorVO
Initiator of the review.
ReviewContextVO
  invocationId : String
The ID of the invocation request when a review is initiated.
ReviewContextVO
  nativeFileName : String
Path of the file in the content repository on which the review is initiated.
ReviewContextVO
  purpose : String
Review purpose.
ReviewContextVO
  reviewId : String
Review ID.
ReviewContextVO
  reviewType : String
Review type like, REGULATED or AD-HOC.
ReviewContextVO
  revision : int
Review revision number.
ReviewContextVO
  rtsProcessName : String
Name of the process used to generate Review Tracking Sheet (RTS).
ReviewContextVO
  stageList : IList
List of stages in the review.
ReviewContextVO
  startDate : Date
Start date of the review.
ReviewContextVO
  status : String
Status of the review.
ReviewContextVO
  stp : Boolean
A Boolean field to enable or disable Straight Through Processing (STP).
ReviewContextVO
  supportingDocumentList : IList
List of supporting documents.
ReviewContextVO
  templateAuthor : String
Name of the template author.
ReviewContextVO
  templateDescription : String
Description of the schedule template used to initiate this review.
ReviewContextVO
  templateName : String
Name of the schedule template used to initiate this review.
ReviewContextVO
  title : String
Review title.
ReviewContextVO
Public Methods
 MethodDefined By
  
ReviewContextVO()
The constructor for ReviewContextVO class.
ReviewContextVO
 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
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
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)

Any review specific data can be preserved in this field.



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

arsProcessName

property 
arsProcessName:String

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 process used to generate Approval Routing Sheet (ARS).



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

auditLevel

property 
auditLevel:String

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

The level of audit associated with this review.



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

changeDescription

property 
changeDescription:String

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

This field is used if the review is revised. While revising, one can specify the change desciption.



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

commentServerPath

property 
commentServerPath:String

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

Server location where Adobe Acrobat stores the inline comments.



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

commentVisibility

property 
commentVisibility:String

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

Visibility of inline comment, in Adobe Acrobat, across stages.



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

complianceCode

property 
complianceCode:String

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

Compliance code of the schedule template.



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

currentRevision

property 
currentRevision: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 is the current revision or not.



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

currentStage

property 
currentStage:int

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

Stage number this review is currently in (starts with 1).



Implementation
    public function get currentStage():int
    public function set currentStage(value:int):void

customAttributes

property 
customAttributes:IList

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

List of custom attributes.



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

End date of the review.



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

initiator

property 
initiator:InitiatorVO

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

Initiator of the review.



Implementation
    public function get initiator():InitiatorVO
    public function set initiator(value:InitiatorVO):void

invocationId

property 
invocationId:String

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

The ID of the invocation request when a review is initiated.



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

nativeFileName

property 
nativeFileName:String

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

Path of the file in the content repository on which the review is initiated.



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

purpose

property 
purpose:String

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

Review purpose.



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

reviewId

property 
reviewId:String

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

Review ID.



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

reviewType

property 
reviewType:String

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

Review type like, REGULATED or AD-HOC.



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

revision

property 
revision:int

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

Review revision number.



Implementation
    public function get revision():int
    public function set revision(value:int):void

rtsProcessName

property 
rtsProcessName:String

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 process used to generate Review Tracking Sheet (RTS).



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

stageList

property 
stageList:IList

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

List of stages in the review.



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

Start date of the review.



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 review. It can be one of the following:

  • ONGOING
  • COMPLETED
  • EXPIRED
  • REVOKED
  • REVISED


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

stp

property 
stp: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 field to enable or disable Straight Through Processing (STP).



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

supportingDocumentList

property 
supportingDocumentList:IList

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

List of supporting documents.



Implementation
    public function get supportingDocumentList():IList
    public function set supportingDocumentList(value:IList):void

templateAuthor

property 
templateAuthor:String

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 template author.



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

templateDescription

property 
templateDescription: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 the schedule template used to initiate this review.



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

templateName

property 
templateName:String

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 schedule template used to initiate this review.



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

title

property 
title:String

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

Review title.



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

ReviewContextVO

()Constructor
public function ReviewContextVO()

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




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

 

Legal Notices | Online Privacy Policy