IReviewTemplate

Package	com.adobe.solutions.rca.domain
Interface	public interface IReviewTemplate extends IReviewContext , IGanttDataItem , IMemberCollection
Implementors	ReviewTemplate

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Defines a schedule template,

Public Properties

	Property		Defined By
		active : Boolean A Boolean flag to determine if a template is active.	IReviewTemplate
		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
		appName : String Name of the application that created a template.	IReviewTemplate
		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
		author : String Author of a template.	IReviewTemplate
		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
		createdOn : Date [read-only] The date on which a template was created.	IReviewTemplate
		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
		description : String Description of a template.	IReviewTemplate
		duration : Number [read-only] Duration of a schedule template in miliseconds.	IReviewTemplate
		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
		lastModifiedBy : String [read-only] Name of the user who last modified a template.	IReviewTemplate
		lastModifiedOn : Date [read-only] The date on which a template was last modified.	IReviewTemplate
		memberList : IList [read-only] The property returns a collection of directly associated members.	IMemberCollection
		name : String Name of a template.	IReviewTemplate
		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
		addMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation adds a member to the collection and submits the change to the server.	IMemberCollection
		addStage(stage:IStage):void Adds stage to the review after the last stage.	IReviewContext
		addStageAt(stage:IStage, index:int):void Adds stage to the review at the specified index from the beginning.	IReviewContext
		addSupportingDocument(doc:ISupportingDocument):void Adds the supporting document at the end of the list of supportingDocuments for this review.	IReviewContext
		addSupportingDocumentAt(doc:ISupportingDocument, index:int):void Adds the supporting document at the index in the list of supportingDocuments for this review.	IReviewContext
		calculateDates():void Populates the calculatedStartDate and calculatedEndDate fields.	IReviewContext
		clearIds():void Clears ID for a reviewContext object for persisting it at another location in the repository.	IReviewContext
		fetchAssetArchive():mx.rpc:AsyncToken Returns an asset archive for this review.	IReviewContext
		fetchLargeThumbnail():mx.rpc:AsyncToken Returns largeThumbnail for this review version.	IReviewContext
		fetchNativeDocument():mx.rpc:AsyncToken Returns the original file submitted for review.	IReviewContext
		fetchReviewContext():mx.rpc:AsyncToken Returns the review context value object for this review.	IReviewContext
		fetchReviewDocument():mx.rpc:AsyncToken Returns the review document for this review.	IReviewContext
		fetchSmallThumbnail():mx.rpc:AsyncToken Returns smallThumbnail for this review version.	IReviewContext
		fetchTemplate():mx.rpc:AsyncToken Returns a schedule template.	IReviewTemplate
		hasChildren():Boolean A Boolean function to determine if the item has displayable children.	IGanttDataItem
		removeAllStages():void Removes all stages from a review.	IReviewContext
		removeAllSupportingDocument():void Removes all supporting documents from the list of supportingDocuments for this review.	IReviewContext
		removeMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation removes a member from the collection and submits the change to the server.	IMemberCollection
		removeStageAt(index:int):IStage Removes a stage at the specified index from the beginning of the review.	IReviewContext
		removeSupportingDocumentAt(index:int):ISupportingDocument Removes a supporting document at the index from the list of supportingDocuments for this review.	IReviewContext
		save():mx.rpc:AsyncToken Persists the schedule template.	IReviewTemplate
		updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken This remote operation updates the tile of a member present in collection and submits the change to the server.	IMemberCollection

Property Detail

active

property

active: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 flag to determine if a template is active.

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

appName

property

appName: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 application that created a template.

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

author

property

author:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Author of a template.

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

createdOn

property

createdOn:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The date on which a template was created.

Implementation
public function get createdOn():Date

description

property

description: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 a template.

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

duration

property

duration:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Duration of a schedule template in miliseconds. It is the sum of durations of the contained stages.

Implementation
public function get duration():Number

lastModifiedBy

property

lastModifiedBy:String [read-only]

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 user who last modified a template.

Implementation
public function get lastModifiedBy():String

lastModifiedOn

property

lastModifiedOn:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The date on which a template was last modified.

Implementation
public function get lastModifiedOn():Date

name

property

name: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 a template.

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

Method Detail

fetchTemplate

()

method

public function fetchTemplate():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 a schedule template. The function tries to fetch the template value object based on a template name, and refreshes current object with new value object returned from the server.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the ReviewTemplateVO.

Related API Elements

com.adobe.solutions.rca.vo.ReviewTemplateVO

save

()

method

public function save():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)

Persists the schedule template. If save is successful, it refreshes current object with new value object returned from server.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the saved ReviewTemplateVO.

Related API Elements

com.adobe.solutions.rca.vo.ReviewTemplateVO

Legal Notices | Online Privacy Policy

IReviewTemplate - AS3 Review, Commenting, and Approval

Classes x

active

appName

author

createdOn

description

duration

lastModifiedBy

lastModifiedOn

name

fetchTemplate

save