ReviewCommentingAndApproval

Package	com.adobe.solutions.rca.services.impl
Class	public class ReviewCommentingAndApproval
Inheritance	ReviewCommentingAndApproval Object
Implements	IReviewCommentingAndApproval

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Implementation for core service of Review Commenting and Approval Building Block 10.0.

Public Properties

	Property		Defined By
		channelSet : ChannelSet Channel set for remote operation calls.	ReviewCommentingAndApproval
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object

Public Methods

	Method		Defined By
		ReviewCommentingAndApproval() The constructor for ReviewCommentingAndApproval class.	ReviewCommentingAndApproval
		addParticipantToStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken This operation adds a new non-moderator participant in an ongoing creation, review, or approval stage.	ReviewCommentingAndApproval
		deleteReviewTemplate(templateName:String):mx.rpc:AsyncToken This API deletes a review template from the system.	ReviewCommentingAndApproval
		exportAssetArchive(reviewId:String, revision:int):mx.rpc:AsyncToken This API returns the native review document, if present or the PDF file of the review document.	ReviewCommentingAndApproval
		getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):mx.rpc:AsyncToken This API retrieves the RSS file of comments, for a particular reviewer.	ReviewCommentingAndApproval
		getDocument(reviewId:String, revision:int, documentPath:String):mx.rpc:AsyncToken This API retrieves a file from the review zone associated with the provided review ID and revision.	ReviewCommentingAndApproval
		getDocumentWithComments(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken This API retrieves a review document with comments, from all reviewers of a review stage.	ReviewCommentingAndApproval
		getReviewByProcessId(assignTaskPid:String):mx.rpc:AsyncToken This operation retrieves the review context for a given process ID.	ReviewCommentingAndApproval
		getReviewContext(reviewId:String, revision:int):mx.rpc:AsyncToken This operation returns ReviewContextVO for the specified review and revision of the review.	ReviewCommentingAndApproval
		getReviewTemplate(templateName:String):mx.rpc:AsyncToken This API fetches a ReviewTemplateVO from the system.	ReviewCommentingAndApproval
		getRevisions(reviewId:String):mx.rpc:AsyncToken Searches for review revisions of the review specified by reviewId.	ReviewCommentingAndApproval
		getStageDocument(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken This API retrieves a prepared stage document.	ReviewCommentingAndApproval
		getUserPreference(domain:String, canonicalName:String):mx.rpc:AsyncToken This operation gets the user preferences for a particular user.	ReviewCommentingAndApproval
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initiateReview(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, reviewDocument:File = null):mx.rpc:AsyncToken This method initiates a multi-stage process consisting of a creation, a review, or an approval stages on an asset.	ReviewCommentingAndApproval
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		purgeReviews(reviewIdList:IList, clearReviewZone:Boolean):mx.rpc:AsyncToken This operation removes data for a particular review from the system.	ReviewCommentingAndApproval
		removeParticipantFromStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken This operation removes a non-moderator participant from an ongoing stage.	ReviewCommentingAndApproval
		resolveStage(reviewId:String, stageNo:int):mx.rpc:AsyncToken This API makes a reference stage inline.	ReviewCommentingAndApproval
		reviseReview(reviewId:String, stageNo:int, reviewDocument:File, changeDescription:String):mx.rpc:AsyncToken This operation generates a new revision of a review from a particular stage.	ReviewCommentingAndApproval
		revokeReview(reviewId:String):mx.rpc:AsyncToken This operation revokes the review specified by review identifier.	ReviewCommentingAndApproval
		searchReviews(reviewSearchFilter:ReviewSearchFilterVO):mx.rpc:AsyncToken Searches for reviews as specified by the reviewSearchFilter.	ReviewCommentingAndApproval
		searchReviewTemplates(templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO):mx.rpc:AsyncToken This API searchs for schedule templates in the system.	ReviewCommentingAndApproval
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):mx.rpc:AsyncToken This API sets the disposition of a stage.	ReviewCommentingAndApproval
		setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):mx.rpc:AsyncToken This operation sets the user preferences for a particular user.	ReviewCommentingAndApproval
		storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):mx.rpc:AsyncToken This internal API stores a file in ADEP Content Repository.	ReviewCommentingAndApproval
		storeReviewTemplate(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken This operation stores a ReviewTemplateVO in the system.	ReviewCommentingAndApproval
		toggleReviewerType(reviewerId:String):mx.rpc:AsyncToken This API is used to mark an optional reviewer mandatory and vice-versa.	ReviewCommentingAndApproval
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):mx.rpc:AsyncToken This operation updates the searchable custom attributes of a review.	ReviewCommentingAndApproval
		updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):mx.rpc:AsyncToken This operation updates the stage duration of an already running RCA Process.	ReviewCommentingAndApproval
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

channelSet

property

channelSet:ChannelSet

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Channel set for remote operation calls.

Implementation
public function get channelSet():ChannelSet
public function set channelSet(value:ChannelSet):void

Constructor Detail

ReviewCommentingAndApproval

()

Constructor

public function ReviewCommentingAndApproval()

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The constructor for ReviewCommentingAndApproval class.

Method Detail

addParticipantToStage

()

method

 public function addParticipantToStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):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)

This operation adds a new non-moderator participant in an ongoing creation, review, or approval stage. The following rules apply for review stages:

A reviewer can only be added in the current revision of a review and approval process. Any future revision, if any, have this new reviewer.
A reviewer can only be added in an ongoing or any future stages of the review and approval process.
A reviewer cannot be added to an approval stage.

The following rules apply to approval stages:

An approver can only be added in the current revision of a review and approval process. Any future revision, if any, have this new approver.
An approver can only be added in an ongoing or any future stage of a review and approval process.
An approver cannot be added to a review stage.

Parameters

	`reviewId:String` — The review identifier to uniquely identify the review.

	`stageNo:int` — The stage number inside the review.

	`stageParticipant:StageParticipantVO` — The `StageParticipantVO` having UMOID or domain or canonical name pair, or both, populated. This must correspond to a valid user in Document Server User Management.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

deleteReviewTemplate

()

method

public function deleteReviewTemplate(templateName:String):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)

This API deletes a review template from the system.

Parameters

templateName:String — The name of the template to be deleted.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a Boolean value, True on successful deletion and False otherwise.

exportAssetArchive

()

method

public function exportAssetArchive(reviewId:String, revision:int):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)

This API returns the native review document, if present or the PDF file of the review document.

Parameters

	`reviewId:String` — A unique identifier of a review.

	`revision:int` — The revision of the review.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the native file if it is present or else the PDF file of the review document.

getCommentsForParticipant

()

method

 public function getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):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)

This API retrieves the RSS file of comments, for a particular reviewer.

Parameters

	`reviewId:String` — The unique identifier for a review zone.

	`revision:int` — The revision of the review

	`stageNo:int` — The stage number of the review stage.

	`participantOid:String` — The UMOID of the reviewer.

Returns

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

getDocument

()

method

public function getDocument(reviewId:String, revision:int, documentPath:String):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)

This API retrieves a file from the review zone associated with the provided review ID and revision.

Parameters

	`reviewId:String` — The unique identifier for a review zone.

	`revision:int` — The revision of the review.

	`documentPath:String` — The path at which the provided document must be stored. This path is a Unix-like path, that is, it contains forward slash points to root of the review zone. Hence, this path should start with a forward slash.

Returns

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

getDocumentWithComments

()

method

public function getDocumentWithComments(reviewId:String, revision:int, stageNo:int):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)

This API retrieves a review document with comments, from all reviewers of a review stage. Comments are embedded in the document (in XFDF format).

Parameters

	`reviewId:String` — The unique identifier for a review zone.

	`revision:int` — The revision of the review.

	`stageNo:int` — The stage number of the review stage.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the review document with comments (in XFDF format).

getReviewByProcessId

()

method

public function getReviewByProcessId(assignTaskPid:String):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)

This operation retrieves the review context for a given process ID.

Parameters

assignTaskPid:String — The unique process ID of the assign task operation.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the ReviewContextVO which triggered process with the passed process ID.

getReviewContext

()

method

public function getReviewContext(reviewId:String, revision:int):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)

This operation returns ReviewContextVO for the specified review and revision of the review.

Parameters

	`reviewId:String` — Review identifier to uniquely identify the review.

	`revision:int` — The revision number of the review.

Returns

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

getReviewTemplate

()

method

public function getReviewTemplate(templateName:String):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)

This API fetches a ReviewTemplateVO from the system.

Parameters

templateName:String — The name of the template to be fetched.

Returns

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

getRevisions

()

method

public function getRevisions(reviewId:String):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)

Searches for review revisions of the review specified by reviewId. Using this API, you can get all the information about a review and its revisions.

Parameters

reviewId:String — The review ID for searching its revisions.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains search results in the form of a list of ReviewContextVO. A ReviewContextVO in the returned list consists of all the details about the review.

getStageDocument

()

method

public function getStageDocument(reviewId:String, revision:int, stageNo:int):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)

This API retrieves a prepared stage document. This document is provided to the non-moderator participants (reviewers, approvers, or author) of a stage.

Parameters

	`reviewId:String` — The unique identifier of a review zone.

	`revision:int` — The revision of the review.

	`stageNo:int` — The stage number inside the review

Returns

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

getUserPreference

()

method

public function getUserPreference(domain:String, canonicalName:String):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)

This operation gets the user preferences for a particular user.

Parameters

	`domain:String` — The domain name of the user.

	`canonicalName:String` — The canonical name of the user.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The result event contains an object of UserPreferenceVO type. A null is returned if no preference exists for a user.

initiateReview

()

method

 public function initiateReview(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, reviewDocument:File = null):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)

This method initiates a multi-stage process consisting of a creation, a review, or an approval stages on an asset.

Parameters

	`reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO` — An instance of the schedule template which contains the stages.

	`reviewDocument:File` (default = `null`) — The PDF file which represents the asset.

Returns

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

purgeReviews

()

method

public function purgeReviews(reviewIdList:IList, clearReviewZone:Boolean):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)

This operation removes data for a particular review from the system. It does not purge the data of an ongoing review. An ongoing review is ignored and a warning is logged. A review must be completed, expired, or revoked, before this API is called. Only the users with RCA Administrator role can invoke this API.

Parameters

	`reviewIdList:IList` — A list of the IDs of the reviews to be purged.

	`clearReviewZone:Boolean` — A Boolean flag. If the value is `True` then corresponding review zone folder is also deleted.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of IDs of the reviews that could not be purged.

removeParticipantFromStage

()

method

 public function removeParticipantFromStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):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)

This operation removes a non-moderator participant from an ongoing stage. The status of StageParticipantVO of the participant to be removed should be PENDING before calling this operation. In case of a parallel review or approval stage, it is possible that a reviewer or approver has completed the tasks before removal.

Parameters

	`reviewId:String` — The review identifier to uniquely identify the review.

	`stageNo:int` — The stage number inside the review.

	`stageParticipant:StageParticipantVO` — The stage participant to be removed.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

resolveStage

()

method

public function resolveStage(reviewId:String, stageNo:int):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)

This API makes a reference stage inline. For a stage that is referring a stage template, this API can make it an inline stage.

Parameters

	`reviewId:String` — The unique identifier for a review.

	`stageNo:int` — The number of the stage.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

reviseReview

()

method

 public function reviseReview(reviewId:String, stageNo:int, reviewDocument:File, changeDescription:String):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)

This operation generates a new revision of a review from a particular stage.

Parameters

	`reviewId:String` — The unique ID of the review.

	`stageNo:int` — The identifier of the stage within the review.

	`reviewDocument:File` — The new `File` to be used in the revision.

	`changeDescription:String` — Description for this revision of the review.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

revokeReview

()

method

public function revokeReview(reviewId:String):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)

This operation revokes the review specified by review identifier. Only a review which is currently running can be revoked.

Parameters

reviewId:String — Review identifier to uniquely identify the review.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

searchReviews

()

method

public function searchReviews(reviewSearchFilter:ReviewSearchFilterVO):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)

Searches for reviews as specified by the reviewSearchFilter.

Parameters

reviewSearchFilter:ReviewSearchFilterVO — Filter to be applied while searching. All the attributes of reviewSearchFilter are considered together for search (equivalent to a logical AND operation).

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the search results in the form of a list of ReviewContextVO. A ReviewContextVO in the returned list contains only the basic information about the review.

searchReviewTemplates

()

method

 public function searchReviewTemplates(templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO):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)

This API searchs for schedule templates in the system.

Parameters

templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO — Filter to be applied while searching.

Returns

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

setStageDisposition

()

method

public function setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):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)

This API sets the disposition of a stage.

Parameters

	`reviewId:String` — The unique identifier of a review.

	`revision:int` — The revision of the review.

	`stageNo:int` — The stage number.

	`disposition:String` — The disposition string.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

setUserPreference

()

method

 public function setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):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)

This operation sets the user preferences for a particular user. It replaces existing user preferences with a new set of preferences.

Parameters

	`domain:String` — The domain name of the user.

	`canonicalName:String` — The canonical name of the user.

	`userPreference:UserPreferenceVO` — An object of `UserPreferenceVO` type.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

storeContentInCRX

()

method

 public function storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):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)

This internal API stores a file in ADEP Content Repository.

Parameters

	`absSpacePath:String` — The absolute space path.

	`fileName:String` — The file name.

	`document:File` — The document to be stored.

	`throwOsgiEventOnly:Boolean` — A flag to generate OSGi event, instead of storing the file.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

storeReviewTemplate

()

method

 public function storeReviewTemplate(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, overwrite:Boolean):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)

This operation stores a ReviewTemplateVO in the system. A schedule name must be unique in the system, unless the intent is to overwrite a previously stored schedule with the same name.

Parameters

	`reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO` — An instance of `ReviewTemplateVO`.

	`overwrite:Boolean` — A Boolean value for error-proof overwriting of schedules. If the value is `True` and a template exists with same name, then the existing template is replaced with the provided `reviewTemplate`.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

toggleReviewerType

()

method

public function toggleReviewerType(reviewerId:String):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)

This API is used to mark an optional reviewer mandatory and vice-versa.

Parameters

reviewerId:String — The unique identifier of the reviewer.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateCustomAttributes

()

method

 public function updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):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)

This operation updates the searchable custom attributes of a review.

Parameters

	`reviewId:String` — The unique ID of the review.

	`revision:int` — The revision of the review.

	`customAttributes:IList` — A list of `CustomAttributeVO`.

	`discardOld:Boolean` — A Boolean value to facilitate discarding old attributes. If `True`, the old custom attributes are discarded.

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateStageDuration

()

method

public function updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):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)

This operation updates the stage duration of an already running RCA Process. Stage duration can only be updated for:

The current revision of a review and approval process. Any future revisions, if any, have the updated duration.
The ongoing or any future stages of a review and approval process.

Parameters

	`reviewId:String` — The unique ID of the review. (required parameter)

	`stageNo:int` — The ID of a stage within a review. (required parameter)

	`duration:int` — New duration of the stage. (required parameter)

	`durationUnit:String` — The unit of stage duration. Valid values for the duration are: Minutes Hours Days (default value) Business days

Returns

mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

Legal Notices | Online Privacy Policy

ReviewCommentingAndApproval - AS3 Review, Commenting, and Approval

Classes x

channelSet

ReviewCommentingAndApproval

addParticipantToStage

deleteReviewTemplate

exportAssetArchive

getCommentsForParticipant

getDocument

getDocumentWithComments

getReviewByProcessId

getReviewContext

getReviewTemplate

getRevisions

getStageDocument

getUserPreference

initiateReview

purgeReviews

removeParticipantFromStage

resolveStage

reviseReview

revokeReview

searchReviews

searchReviewTemplates

setStageDisposition

setUserPreference

storeContentInCRX

storeReviewTemplate

toggleReviewerType

updateCustomAttributes

updateStageDuration