| Paket | com.adobe.solutions.rca.service |
| Gränssnitt | public interface IReviewCommentingAndApproval |
| Implementorer | ReviewCommentingAndApproval |
| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
Publika metoder
| Metod | Definieras med | ||
|---|---|---|---|
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. | IReviewCommentingAndApproval | ||
This API deletes a review template from the system. | IReviewCommentingAndApproval | ||
This API returns the native review document, if present or the PDF file of the review document. | IReviewCommentingAndApproval | ||
getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):mx.rpc:AsyncToken
This API retrieves the RSS file of comments, for a particular reviewer. | IReviewCommentingAndApproval | ||
This API retrieves a file from the review zone associated with the provided review ID and revision. | IReviewCommentingAndApproval | ||
This API retrieves a review document with comments, from all reviewers of a review stage. | IReviewCommentingAndApproval | ||
This operation retrieves the review context for a given process ID. | IReviewCommentingAndApproval | ||
This operation returns ReviewContextVO for the specified review and revision of the review. | IReviewCommentingAndApproval | ||
This API fetches a ReviewTemplateVO from the system. | IReviewCommentingAndApproval | ||
Searches for review revisions of the review specified by reviewId. | IReviewCommentingAndApproval | ||
This API retrieves a prepared stage document. | IReviewCommentingAndApproval | ||
This operation gets the user preferences for a particular user. | IReviewCommentingAndApproval | ||
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. | IReviewCommentingAndApproval | ||
This operation removes data for a particular review from the system. | IReviewCommentingAndApproval | ||
removeParticipantFromStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken
This operation removes a non-moderator participant from an ongoing stage. | IReviewCommentingAndApproval | ||
This API makes a reference stage inline. | IReviewCommentingAndApproval | ||
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. | IReviewCommentingAndApproval | ||
This operation revokes the review specified by review identifier. | IReviewCommentingAndApproval | ||
Searches for reviews as specified by the reviewSearchFilter. | IReviewCommentingAndApproval | ||
searchReviewTemplates(templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO):mx.rpc:AsyncToken
This API searchs for schedule templates in the system. | IReviewCommentingAndApproval | ||
setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):mx.rpc:AsyncToken
This API sets the disposition of a stage. | IReviewCommentingAndApproval | ||
setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):mx.rpc:AsyncToken
This operation sets the user preferences for a particular user. | IReviewCommentingAndApproval | ||
storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):mx.rpc:AsyncToken
This internal API stores a file in ADEP Content Repository. | IReviewCommentingAndApproval | ||
storeReviewTemplate(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken
This operation stores a ReviewTemplateVO in the system. | IReviewCommentingAndApproval | ||
This API is used to mark an optional reviewer mandatory and vice-versa. | IReviewCommentingAndApproval | ||
updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):mx.rpc:AsyncToken
This operation updates the searchable custom attributes of a review. | IReviewCommentingAndApproval | ||
updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):mx.rpc:AsyncToken
This operation updates the stage duration of an already running RCA Process. | IReviewCommentingAndApproval | ||
Metoddetaljer
addParticipantToStage | () | metod |
public function addParticipantToStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
- 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.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
deleteReviewTemplate | () | metod |
public function deleteReviewTemplate(templateName:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API deletes a review template from the system.
Parametrar
templateName:String — The name of the template to be deleted.
|
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 | () | metod |
public function exportAssetArchive(reviewId:String, revision:int):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API returns the native review document, if present or the PDF file of the review document.
Parametrar
reviewId:String — A unique identifier of a review.
| |
revision:int — The revision of the review.
|
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 | () | metod |
public function getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API retrieves the RSS file of comments, for a particular reviewer.
Parametrar
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.
|
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 | () | metod |
public function getDocument(reviewId:String, revision:int, documentPath:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API retrieves a file from the review zone associated with the provided review ID and revision.
Parametrar
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.
|
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 | () | metod |
public function getDocumentWithComments(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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).
Parametrar
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.
|
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 | () | metod |
public function getReviewByProcessId(assignTaskPid:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This operation retrieves the review context for a given process ID.
Parametrar
assignTaskPid:String — The unique process ID of the assign task operation.
|
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 | () | metod |
public function getReviewContext(reviewId:String, revision:int):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This operation returns ReviewContextVO for the specified review and revision of the review.
Parametrar
reviewId:String — Review identifier to uniquely identify the review.
| |
revision:int — The revision number of the review.
|
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 | () | metod |
public function getReviewTemplate(templateName:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API fetches a ReviewTemplateVO from the system.
Parametrar
templateName:String — The name of the template to be fetched.
|
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 | () | metod |
public function getRevisions(reviewId:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
reviewId:String — The review ID for searching its revisions.
|
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 | () | metod |
public function getStageDocument(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
reviewId:String — The unique identifier of a review zone.
| |
revision:int — The revision of the review.
| |
stageNo:int — The stage number inside the review
|
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 | () | metod |
public function getUserPreference(domain:String, canonicalName:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This operation gets the user preferences for a particular user.
Parametrar
domain:String — The domain name of the user.
| |
canonicalName:String — The canonical name of the user.
|
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 | () | metod |
public function initiateReview(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, reviewDocument:File = null):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO — An instance of the schedule template which contains the stages.
| |
reviewDocument:File (default = null) |
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 | () | metod |
public function purgeReviews(reviewIdList:IList, clearReviewZone:Boolean):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
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.
|
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 | () | metod |
public function removeParticipantFromStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
resolveStage | () | metod |
public function resolveStage(reviewId:String, stageNo:int):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
reviewId:String — The unique identifier for a review.
| |
stageNo:int — The number of the stage.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
reviseReview | () | metod |
public function reviseReview(reviewId:String, stageNo:int, reviewDocument:File, changeDescription:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This operation generates a new revision of a review from a particular stage.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
revokeReview | () | metod |
public function revokeReview(reviewId:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
reviewId:String — Review identifier to uniquely identify the review.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
searchReviews | () | metod |
public function searchReviews(reviewSearchFilter:ReviewSearchFilterVO):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
Searches for reviews as specified by the reviewSearchFilter.
Parametrar
reviewSearchFilter:ReviewSearchFilterVO — Filter to be applied while searching. All the attributes of reviewSearchFilter are considered together for search (equivalent to a logical AND operation).
|
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 | () | metod |
public function searchReviewTemplates(templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API searchs for schedule templates in the system.
Parametrar
templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO — Filter to be applied while searching.
|
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 | () | metod |
public function setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API sets the disposition of a stage.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
setUserPreference | () | metod |
public function setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
domain:String — The domain name of the user.
| |
canonicalName:String — The canonical name of the user.
| |
userPreference:UserPreferenceVO — An object of UserPreferenceVO type.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
storeContentInCRX | () | metod |
public function storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This internal API stores a file in ADEP Content Repository.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
storeReviewTemplate | () | metod |
public function storeReviewTemplate(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
toggleReviewerType | () | metod |
public function toggleReviewerType(reviewerId:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This API is used to mark an optional reviewer mandatory and vice-versa.
Parametrar
reviewerId:String — The unique identifier of the reviewer.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
updateCustomAttributes | () | metod |
public function updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | Flash Player 10.2, AIR (unsupported) |
This operation updates the searchable custom attributes of a review.
Parametrar
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.
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
updateStageDuration | () | metod |
public function updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):mx.rpc:AsyncToken| Språkversion: | ActionScript 3.0 |
| Produktversion: | Review, Commenting, and Approval Building Block 10 |
| Körningsmiljöversioner: | 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.
Parametrar
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:
|
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.
|
Tue Jun 12 2018, 01:40 PM Z