| Package | com.adobe.solutions.rca.domain |
| Interface | public interface IReviewContext extends IGanttDataItem , IMemberCollection |
| Implementors | ReviewContext |
| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| additionalMetadata : String
Any review-specific data can be preserved in this field. | IReviewContext | ||
 | allMemberList : IList [read-only]
The property returns a collection of all members. | IMemberCollection | |
| arsProcessName : String
Name of the process used to generate Approval Routing Sheet (ARS). | IReviewContext | ||
| auditLevel : String
The level of audit associated with this review. | IReviewContext | ||
| calculatedEndDate : Date
The endDate if the review has ended. | IReviewContext | ||
| calculatedStartDate : Date
The startDate if the review has started. | IReviewContext | ||
| changeDescription : String
This field is used to store the change desciption, if a review is revised. | IReviewContext | ||
| commentServerPath : String
Server location where Adobe ® Acrobat ® stores the inline comments. | IReviewContext | ||
| commentVisibility : String
Adobe Acrobat's inline comment visibility across stages. | IReviewContext | ||
| complianceCode : String
Compliance code of the schedule template. | IReviewContext | ||
| currentRevision : Boolean
A Boolean value to decide whether this is the current revision of the review or not. | IReviewContext | ||
| currentStage : int
Stage number in progress for this review (starts with 1). | IReviewContext | ||
| customAttributes : IList
List of custom attributes. | IReviewContext | ||
| endDate : Date
End date of a review. | IReviewContext | ||
| ganttItems : ArrayCollection [read-only]
A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True. | IGanttDataItem | |
| id : String [read-only]
A unique identifier for this review version. | IReviewContext | ||
| initiator : IInitiator
Initiator of a review. | IReviewContext | ||
| invocationId : String
The ID of the invocation request when a review is initiated. | IReviewContext | ||
| itemEndDate : Date [read-only]
End date of the item. | IGanttDataItem | |
| itemName : String [read-only]
Name of the item. | IGanttDataItem | |
| itemStartDate : Date [read-only]
Start date of the item. | IGanttDataItem | |
| itemState : String [read-only]
State of the item. | IGanttDataItem | |
| itemStatus : String [read-only]
Status of the item. | IGanttDataItem | |
| itemType : String [read-only]
Type of item. | IGanttDataItem | |
| largeThumbnail : File
Large thumbnail image of a document under review. | IReviewContext | ||
| memberList : IList [read-only]
The property returns a collection of directly associated members. | IMemberCollection | |
| nativeFileName : String
Path of the file, in the content repository, on which the review is initiated. | IReviewContext | ||
| operationList : ArrayCollection [read-only]
A collection of operations that are available to a user through the context menu in the Gantt chart. | IGanttDataItem | |
| purpose : String
Review purpose. | IReviewContext | ||
| reviewCommentingAndApproval : IReviewCommentingAndApproval
An instance of Review Commenting and Approval service for this review. | IReviewContext | ||
| reviewId : String
A unique identifier of the review. | IReviewContext | ||
| reviewType : String
Type of review like Regulated or Ad-hoc. | IReviewContext | ||
| revision : int
Review revision number. | IReviewContext | ||
| rtsProcessName : String
Name of the process used to generate Review Tracking Sheet (RTS). | IReviewContext | ||
| showChildren : Boolean
A Boolean flag to determine if the children need to be displayed. | IGanttDataItem | |
| showParent : Boolean
A Boolean flag to determine if the parent needs to be displayed. | IGanttDataItem | |
| smallThumbnail : File
Small thumbnail image of a document under review. | IReviewContext | ||
| stageList : IList
List of stages in a review. | IReviewContext | ||
| startDate : Date
Start date of a review. | IReviewContext | ||
| status : String
Review purpose. | IReviewContext | ||
| stp : Boolean
A Boolean field to enable or disable Straight Through Processing (STP). | IReviewContext | ||
| supportingDocumentList : IList
List of supporting documents for a review. | IReviewContext | ||
| templateAuthor : String
Name of the schedule template author. | IReviewContext | ||
| templateDescription : String
Description of the schedule template used to initiate this review. | IReviewContext | ||
| templateName : String
Name of the schedule template used to initiate this review. | IReviewContext | ||
| title : String
Review title. | IReviewContext | ||
| uniqueMemberList : IList [read-only]
The property returns a collection of unique members. | IMemberCollection | |
| vo : ReviewContextVO
The Value Object for this review version. | IReviewContext | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
|
This remote operation adds a member to the collection and submits the change to the server. | IMemberCollection | |
Adds stage to the review after the last stage. | IReviewContext | ||
Adds stage to the review at the specified index from the beginning. | IReviewContext | ||
Adds the supporting document at the end of the list of supportingDocuments for this review. | IReviewContext | ||
Adds the supporting document at the index in the list of supportingDocuments for this review. | IReviewContext | ||
Populates the calculatedStartDate and calculatedEndDate fields. | IReviewContext | ||
Clears ID for a reviewContext object for persisting it at another location in the repository. | IReviewContext | ||
Returns an asset archive for this review. | IReviewContext | ||
Returns largeThumbnail for this review version. | IReviewContext | ||
Returns the original file submitted for review. | IReviewContext | ||
Returns the review context value object for this review. | IReviewContext | ||
Returns the review document for this review. | IReviewContext | ||
Returns smallThumbnail for this review version. | IReviewContext | ||
|
A Boolean function to determine if the item has displayable children. | IGanttDataItem | |
Removes all stages from a review. | IReviewContext | ||
Removes all supporting documents from the list of supportingDocuments for this review. | IReviewContext | ||
|
This remote operation removes a member from the collection and submits the change to the server. | IMemberCollection | |
Removes a stage at the specified index from the beginning of the review. | IReviewContext | ||
Removes a supporting document at the index from the list of supportingDocuments for this review. | IReviewContext | ||
|
This remote operation updates the tile of a member present in collection and submits the change to the server. | IMemberCollection | |
Property Detail
additionalMetadata | property |
additionalMetadata:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidarsProcessName | property |
arsProcessName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidauditLevel | property |
auditLevel: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 level of audit associated with this review.
Implementation
public function get auditLevel():String public function set auditLevel(value:String):voidcalculatedEndDate | 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 review has ended. Otherwise the expected ended date.
Implementation
public function get calculatedEndDate():Date public function set calculatedEndDate(value:Date):voidcalculatedStartDate | 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 review has started. Otherwise the expected start date.
Implementation
public function get calculatedStartDate():Date public function set calculatedStartDate(value:Date):voidRelated API Elements
IReviewContext.startDate
changeDescription | property |
changeDescription:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This field is used to store the change desciption, if a review is revised.
Implementation
public function get changeDescription():String public function set changeDescription(value:String):voidcommentServerPath | property |
commentServerPath:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidcommentVisibility | property |
commentVisibility:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Adobe Acrobat's inline comment visibility across stages.
Implementation
public function get commentVisibility():String public function set commentVisibility(value:String):voidcomplianceCode | property |
complianceCode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidcurrentRevision | property |
currentRevision:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A Boolean value to decide whether this is the current revision of the review or not.
Implementation
public function get currentRevision():Boolean public function set currentRevision(value:Boolean):voidcurrentStage | property |
currentStage:int| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Stage number in progress for this review (starts with 1).
Implementation
public function get currentStage():int public function set currentStage(value:int):voidcustomAttributes | property |
customAttributes:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
List of custom attributes.
Implementation
public function get customAttributes():IList public function set customAttributes(value:IList):voidendDate | property |
id | property |
initiator | property |
initiator:IInitiator| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Initiator of a review.
Implementation
public function get initiator():IInitiator public function set initiator(value:IInitiator):voidinvocationId | property |
invocationId: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 ID of the invocation request when a review is initiated.
Implementation
public function get invocationId():String public function set invocationId(value:String):voidlargeThumbnail | property |
largeThumbnail:File| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Large thumbnail image of a document under review.
Implementation
public function get largeThumbnail():File public function set largeThumbnail(value:File):voidnativeFileName | property |
nativeFileName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidpurpose | property |
reviewCommentingAndApproval | property |
reviewCommentingAndApproval:IReviewCommentingAndApproval| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
An instance of Review Commenting and Approval service for this review.
Implementation
public function get reviewCommentingAndApproval():IReviewCommentingAndApproval public function set reviewCommentingAndApproval(value:IReviewCommentingAndApproval):voidRelated API Elements
IReviewCommentingAndApproval
reviewId | property |
reviewId:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A unique identifier of the review.
Implementation
public function get reviewId():String public function set reviewId(value:String):voidreviewType | property |
reviewType:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Type of review like Regulated or Ad-hoc.
Implementation
public function get reviewType():String public function set reviewType(value:String):voidrevision | property |
rtsProcessName | property |
rtsProcessName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidsmallThumbnail | property |
smallThumbnail:File| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Small thumbnail image of a document under review.
Implementation
public function get smallThumbnail():File public function set smallThumbnail(value:File):voidstageList | property |
stageList:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
List of stages in a review.
Implementation
public function get stageList():IList public function set stageList(value:IList):voidstartDate | property |
status | property |
stp | property |
stp:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidsupportingDocumentList | property |
supportingDocumentList:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
List of supporting documents for a review.
Implementation
public function get supportingDocumentList():IList public function set supportingDocumentList(value:IList):voidtemplateAuthor | property |
templateAuthor:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Name of the schedule template author.
Implementation
public function get templateAuthor():String public function set templateAuthor(value:String):voidtemplateDescription | property |
templateDescription:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidtemplateName | property |
templateName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| 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):voidtitle | property |
vo | property |
vo:ReviewContextVO| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The Value Object for this review version.
Implementation
public function get vo():ReviewContextVO public function set vo(value:ReviewContextVO):voidMethod Detail
addStage | () | method |
public function addStage(stage:IStage):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Adds stage to the review after the last stage.
Parameters
stage:IStage — Stage instance that needs to be added.
|
addStageAt | () | method |
public function addStageAt(stage:IStage, index:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Adds stage to the review at the specified index from the beginning.
Parameters
stage:IStage — Stage instance that needs to be added.
| |
index:int — Index at which this stage needs to be added.
|
addSupportingDocument | () | method |
public function addSupportingDocument(doc:ISupportingDocument):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Adds the supporting document at the end of the list of supportingDocuments for this review.
Parameters
doc:ISupportingDocument — Supporting document that needs to be added.
|
Related API Elements
addSupportingDocumentAt | () | method |
public function addSupportingDocumentAt(doc:ISupportingDocument, index:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Adds the supporting document at the index in the list of supportingDocuments for this review.
Parameters
doc:ISupportingDocument — Supporting document that needs to be added.
| |
index:int — Index at which the supporting document needs to be added.
|
Related API Elements
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.
Related API Elements
clearIds | () | method |
public function clearIds():void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Clears ID for a reviewContext object for persisting it at another location in the repository.
fetchAssetArchive | () | method |
public function fetchAssetArchive():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns an asset archive for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains the asset archive for this review.
|
fetchLargeThumbnail | () | method |
public function fetchLargeThumbnail():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns largeThumbnail for this review version.
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains largeThumbnail for this review version.
|
Related API Elements
fetchNativeDocument | () | method |
public function fetchNativeDocument():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns the original file submitted for review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains original file submitted for review.
|
fetchReviewContext | () | method |
public function fetchReviewContext():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns the review context value object for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review context value object for this review.
|
fetchReviewDocument | () | method |
public function fetchReviewDocument():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns the review document for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review document for this review.
|
fetchSmallThumbnail | () | method |
public function fetchSmallThumbnail():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Returns smallThumbnail for this review version.
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains smallThumbnail for this review version.
|
Related API Elements
removeAllStages | () | method |
public function removeAllStages():void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Removes all stages from a review.
removeAllSupportingDocument | () | method |
public function removeAllSupportingDocument():void| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Removes all supporting documents from the list of supportingDocuments for this review.
removeStageAt | () | method |
public function removeStageAt(index:int):IStage| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Removes a stage at the specified index from the beginning of the review. Returns the removed stage.
Parameters
index:int — The index of the stage that needs to be removed.
|
IStage — Stage instance that has been removed.
|
removeSupportingDocumentAt | () | method |
public function removeSupportingDocumentAt(index:int):ISupportingDocument| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Removes a supporting document at the index from the list of supportingDocuments for this review.
Parameters
index:int — Index of the supporting document that needs to be removed.
|
ISupportingDocument — Supporting document that has been removed.
|
Mon Nov 28 2011, 06:48 AM -08:00