com.adobe.livecycle.rca
Interface ReviewCommentingAndApproval

public interface ReviewCommentingAndApproval

Signature for Core Service of Review Commenting and Approval

Field Summary

static String

DATE_FORMAT Format of date-time fields used in RCA system.

Method Summary

void	addApprover(String reviewId, Integer stageNo, String domain, String canonicalName) Operation to add a new approver in an already running Review Approval Process.
void	addReviewer(String reviewId, Integer stageNo, String domain, String canonicalName, Boolean isOptional) Operation to add a new reviewer in an already running Review Approval Process.
com.adobe.idp.Document	applyReaderExtension(com.adobe.idp.Document document)
Boolean	deleteReviewTemplate(String templateName) Delete Review Template
com.adobe.idp.Document	getDocument(String reviewID, Integer revision, String documentPath) It retrieves a Document from the review zone associated with the given review ID and revision .
ReviewContextTO	getReviewByProcessId(String assignTaskPid) Retrieve review context for a given process ID.
com.adobe.idp.Document	getReviewContext(String reviewId, Integer revision) This Operation returns the review context.
com.adobe.idp.Document	getReviewDocument(String reviewId, Integer revision) This Operation returns the review document.
com.adobe.idp.Document	getReviewStageDocument(String reviewId, Integer revision, Integer stageNo) This Operation returns the review document for a review stage.
com.adobe.idp.Document	getReviewTemplate(String templateName) Returns the Review Tempalte
com.adobe.idp.Document	getRevisions(String reviewId) 2nd level Search API Returns XML that has the review_context for all the revision of that review.
List	getSupportingDocumentList(String reviewID) Returns list of RCADocument objects representing Supporting documents for a given review
List	getSupportingDocuments(String reviewID) Returns a list of urls of supporting documents for review identified by Review ID
UserPreferenceTO	getUserPreference(String domain, String canonicalName) Gets the user preferences for a particular user
String	initiateReview(com.adobe.idp.Document reviewContext, com.adobe.idp.Document reviewDocument, List supportingDocList) This Operation should be invoked to start an RCA process.
void	initiateReviewLongLived(com.adobe.idp.Document reviewContext, com.adobe.idp.Document reviewDocument, List supportingDocList) This is the long-lived version of initiateReview API.
List	purgeReviews(List listOfReviewIDs, Boolean clearReviewZone) Removes data for a particular review from database and also removes the review zone for particular review from Review Zone Location.
void	removeApprover(String reviewId, Integer stageNo, String domain, String canonicalName) This Operation removes the approver from the running process.
void	removeReviewer(String reviewId, Integer stageNo, String domain, String canonicalName) This Operation removes the reviewer from the running process.
com.adobe.idp.Document	retrieveAuditConfig() This Operation retrieves the audit configuration for RCA.
void	reviseReview(String reviewId, Integer stageNo, com.adobe.idp.Document reviewDocument, String changeDescription) This Operation generates a new revision of a review from a particular stage
void	revokeReview(String reviewId) This Operation can be used for revoking the review.
com.adobe.idp.Document	searchReviews(ReviewSearchFilterTO reviewSearchFilter) 1st level Search API Search reviews based on ReviewSearchFilter.
List	searchReviewTemplates(TemplateSearchFilter templateSearchFilter) Template Search
void	setUserPreference(String domain, String canonicalName, UserPreferenceTO userPreference) Sets the user preferences for a particular user.
void	storeReviewTemplate(com.adobe.idp.Document reviewTemplate, List supportingDocList, Boolean overwrite) This Operation stores a Review Template XML Document in the RCA System.
void	updateCustomAttributes(String reviewId, Integer revision, List customAttributes, Boolean discardOld) Updates the searchable custom attributes of a review.
void	updateReviewStageDuration(String reviewId, Integer stageNo, Integer duration, String durationUnit) This operation updates the Review Stage Duration of an already running Review Approval Process.

Field Detail

DATE_FORMAT

static final String DATE_FORMAT

Format of date-time fields used in RCA system. This format is fixed to yyyy-MM-dd HH:mm:ss.sss Z. Example: 2009-01-30 21:51:01.983 +0530

See Also:

Constant Field Values

Method Detail

initiateReview

String initiateReview(com.adobe.idp.Document reviewContext,
                      com.adobe.idp.Document reviewDocument,
                      List supportingDocList)
                      throws RCAException

This Operation should be invoked to start an RCA process. It does the following:

Validates the passed reviewContext (XML)

A unique ID is auto generated for the Review/Approval process and set in Review Template XML from previous step.

A Review Zone is created using Service ReviewZoneProvider using ID generated in previous step.

Adds supporting documents

com.adobe.idp.Document (Object): Document is first uploaded to ReviewZoneProvider and links to the document are added in Review Context XML passes as parameter

Document Link (String): If Document links' list is passed to this API, the are simply injected in Review Context

Store the original Review Document in Review Zone using Service ReviewZoneProvider

Pass the reviewDocument to RCA Orchestration to Prepare this document for Review

Invoke pre-review Orchestration Hook for the first Stage if given in Review Context XML

Enable passed reviewDocument (PDF) for Shared Review for the first Stage: Injects Acrobat specific JavaScript in the document

Store a copy of prepared reviewDocument in Review Zone using Service ReviewZoneProvider

Store a copy of updated reviewContext in Review Zone using Service ReviewZoneProvider

Invoke the Core Review Process (for Parallel or Sequential Review) passing it the Review Context and Review Document

Please note, this operation triggers the Core Review Process (Orchestration). It assumes the Review Context to be final and ready for the Review to begin. So, one should invoke operation addSupportingDocument before invoking this Operation, if needed.

Parameters:

reviewContext - Document instance of Review Context (XML) (Required Parameter)

reviewDocument - Document to be reviewed (Required Parameter)

supportingDocList - List of RCADocument (Required Parameter)

Returns:

String Review Id of the initiated review.

Throws:

InvalidReviewContextException - If passed reviewContext is invalid, i.e. it doesn't comply to RCA ReviewContext Schema.

InvalidReviewDocumentException - If passed reviewDocument is not a valid PDF which can be sent for Shared Review.

ReviewZoneCreationException - If review zone creation fails

UserNotFoundException - If a user mentioned in Review Context is not found in LC UM

RCAException

initiateReviewLongLived

void initiateReviewLongLived(com.adobe.idp.Document reviewContext,
                             com.adobe.idp.Document reviewDocument,
                             List supportingDocList)
                             throws RCAException

This is the long-lived version of initiateReview API. This operation when invoked from within a long lived process will exit only when all the stages of the Review/Approval process complete. The exit criteria of this operation is:
1. All stages complete
2. The document was REJECTED in one of the Approval stage
3. A stage of the Review/Approval process expires (timeout).
4. The Review/Approval process is Revoked by a moderator/initiator.
This operation survives multiple revisions of a Review/Approval process i.e. this operation doesn't return on a reviseReview call.

Parameters:

reviewContext - Same as that of initiateReview

reviewDocument - Same as that of initiateReview

supportingDocList - Same as that of initiateReview

Throws:

RCAException

searchReviews

com.adobe.idp.Document searchReviews(ReviewSearchFilterTO reviewSearchFilter)
                                     throws RCAException

1st level Search API Search reviews based on ReviewSearchFilter.

Parameters:

ReviewSearchFilter - Filter to be applied while searching. All the attributes of ReviewSearchFilter will be ANDed.

Returns:

Document Search result XML in form of com.adobe.idp.Document. The XML conforms to SearchResult schema. It returns an XML comprising of XML Tags named Review. Review does not consist of all details about the review, but it contains few basic information about the review. This API is complemented by another API called getRevisions, which takes a review ID.

Throws:

RCAException

getRevisions

com.adobe.idp.Document getRevisions(String reviewId)
                                    throws RCAException

2nd level Search API Returns XML that has the review_context for all the revision of that review. Using this api, you can get all the information about a review and its revisions.

Parameters:

reviewId -

Returns:

Document Search result XML in form of com.adobe.idp.Document. The XML conforms to SearchResult schema. The returned XML has the review_context for all the revision of that review.

Throws:

RCAException

getSupportingDocuments

List getSupportingDocuments(String reviewID)
                            throws RCAException

Returns a list of urls of supporting documents for review identified by Review ID

Parameters:

reviewID - Unique ID of the review

Returns:

List List of urls of supporting documents.

Throws:

RCAException

updateReviewStageDuration

void updateReviewStageDuration(String reviewId,
                               Integer stageNo,
                               Integer duration,
                               String durationUnit)
                               throws RCAException

This operation updates the Review Stage Duration of an already running Review Approval Process.

• Stage Duration can only be updated for the current Revision of a Review and Approval Process. Any future revision (if any) will have the updated duration.
• Stage Duration can only be updated for the current (already running) OR any future stage of the Review and Approval Process.

Parameters:

reviewId - Unique ID of the review (Required Parameter)

stageNo - ID of the stage within a review (Required Parameter)

duration - stage duration

durationUnit - Unit of stage duration. valid values are:

• DAYS
• HOURS
• MINUTES

Default value is DAYS

Throws:

RCAException - Any Exception generated in RCA Core

addReviewer

void addReviewer(String reviewId,
                 Integer stageNo,
                 String domain,
                 String canonicalName,
                 Boolean isOptional)
                 throws RCAException,
                        TaskAssignmentFailedException

Operation to add a new reviewer in an already running Review Approval Process. Following rules apply:

• A reviewer can only be added in the current Revision of a Review and Approval Process. Any future revision (if any) will have this new reviewer.
• A reviewer can only be added in current (already running) OR any future stage of the Review and Approval Process.
• A reviewer cannot be added to an Approval Stage.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

stageNo - Unique identifier of the stage within a review. Integer >= 1. (Required Parameter)

domain - Reviewer domain (Required Parameter)

canonicalName - Canonical Name (Required Parameter)

isOptional - This flag indicates if the reviewer to be added is optional or required. If null then it is defaulted to false. (Optional Parameter)

Throws:

RCAException - Any Exception generated in RCA Core.

TaskAssignmentFailedException

addApprover

void addApprover(String reviewId,
                 Integer stageNo,
                 String domain,
                 String canonicalName)
                 throws RCAException,
                        TaskAssignmentFailedException

Operation to add a new approver in an already running Review Approval Process. Following rules apply:

• An approver can only be added in the current Revision of a Review and Approval Process. Any future revision (if any) will have this new approver.
• An approver can only be added in current (already running) OR any future stage of the Review and Approval Process.
• An approver cannot be added to a Review Stage.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

stageNo - Unique identifier of the stage within a review. Integer >= 1. (Required Parameter)

domain - Reviewer domain (Required Parameter)

canonicalName - Canonical Name (Required Parameter)

Throws:

RCAException - Any Exception generated in RCA Core.

TaskAssignmentFailedException

revokeReview

void revokeReview(String reviewId)
                  throws RCAException

This Operation can be used for revoking the review. Only a review which is currently running can be revoked.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

Throws:

RCAException - Any Exception generated in RCA Core.

getReviewStageDocument

com.adobe.idp.Document getReviewStageDocument(String reviewId,
                                              Integer revision,
                                              Integer stageNo)
                                              throws RCAException

This Operation returns the review document for a review stage.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

revision - Revision (Required Parameter)

stageNo - Stage Id of the stage

Returns:

Document PDF document for the review stage

Throws:

RCAException - Any Exception generated in RCA Core.

getReviewDocument

com.adobe.idp.Document getReviewDocument(String reviewId,
                                         Integer revision)
                                         throws RCAException

This Operation returns the review document.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

revision - Revision (Required Parameter)

Returns:

Document PDF document for the review.

Throws:

RCAException - Any Exception generated in RCA Core.

getReviewContext

com.adobe.idp.Document getReviewContext(String reviewId,
                                        Integer revision)
                                        throws RCAException

This Operation returns the review context.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

revision - Revision (Required Parameter)

Returns:

Document review context document.

Throws:

RCAException - Any Exception generated in RCA Core.

removeReviewer

void removeReviewer(String reviewId,
                    Integer stageNo,
                    String domain,
                    String canonicalName)
                    throws RCAException

This Operation removes the reviewer from the running process. The status of the reviewer, that need to be removed, should be PENDING before calling this operation. In case of parallel review, it is possible that reviewer completes his/her task before removal.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

stageNo - Stage Id of the stage (Required parameter)

domain - domain name of the reviewer. (Required parameter)

canonicalName - canonical name of the reviewer. (Required parameter)

Throws:

RCAException - Any Exception generated in RCA Core.

removeApprover

void removeApprover(String reviewId,
                    Integer stageNo,
                    String domain,
                    String canonicalName)
                    throws RCAException

This Operation removes the approver from the running process. The status of the approver, that need to be removed, should be PENDING before calling this operation. In case of parallel approval, it is possible that approver completes his/her task before removal.

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

stageNo - Stage Id of the stage (Required parameter)

domain - domain name of the approver (Required parameter)

canonicalName - canonical name of the approver (Required parameter)

Throws:

RCAException - Any Exception generated in RCA Core.

reviseReview

void reviseReview(String reviewId,
                  Integer stageNo,
                  com.adobe.idp.Document reviewDocument,
                  String changeDescription)
                  throws RCAException

This Operation generates a new revision of a review from a particular stage

Parameters:

reviewId - Unique ID of the review. (Required Parameter)

stageNo - Stage Id of the stage (Required parameter)

reviewDocument - New document that would be used in the revision (Required parameter).

Throws:

RCAException

storeReviewTemplate

void storeReviewTemplate(com.adobe.idp.Document reviewTemplate,
                         List supportingDocList,
                         Boolean overwrite)
                         throws RCAException

This Operation stores a Review Template XML Document in the RCA System. It picks up the review template name from the XML while storing. So, Review Template Name should be unique unless you want to overwrite a previously stored review template. It also hosts the supporting document at template level

Parameters:

reviewTemplate - Document instance of Review Template (XML) (Required Parameter)

supportingDocList - List. This is a list of supporting documents that would be hosted at template level.

overwrite - If true and a template exists with same name, it silently replaces the old one.

Throws:

RCAException

retrieveAuditConfig

com.adobe.idp.Document retrieveAuditConfig()
                                           throws RCAException

This Operation retrieves the audit configuration for RCA.

Returns:

Document Audit Configuration Document.

Throws:

RCAException

RCAException

setUserPreference

void setUserPreference(String domain,
                       String canonicalName,
                       UserPreferenceTO userPreference)
                       throws RCAException

Sets the user preferences for a particular user. It deletes existing user preferences and replace it with new user preferences.

Parameters:

domain - User Domain name

canonicalName - User Canonical Name

userPreference - User Preferences object

Throws:

RCAException

getUserPreference

UserPreferenceTO getUserPreference(String domain,
                                   String canonicalName)
                                   throws RCAException

Gets the user preferences for a particular user

Parameters:

domain - User Domain name

canonicalName - User Canonical Name

Returns:

User preference object

Throws:

RCAException

getReviewByProcessId

ReviewContextTO getReviewByProcessId(String assignTaskPid)
                                     throws RCAException

Retrieve review context for a given process ID.

Parameters:

assignTaskPid - Process ID of the assign Task operation.

Returns:

Throws:

RCAException

updateCustomAttributes

void updateCustomAttributes(String reviewId,
                            Integer revision,
                            List customAttributes,
                            Boolean discardOld)
                            throws RCAException

Updates the searchable custom attributes of a review.

Parameters:

reviewId - Review ID

revision - Review Revision

customAttributes - list of CustomAttributeTO

discardOld - If true, old custom attributes are discarded

Throws:

RCAException

searchReviewTemplates

List searchReviewTemplates(TemplateSearchFilter templateSearchFilter)
                           throws RCAException

Template Search

Parameters:

templateSearchFilter -

Returns:

Throws:

RCAException

deleteReviewTemplate

Boolean deleteReviewTemplate(String templateName)
                             throws RCAException

Delete Review Template

Parameters:

templateName -

Returns:

Throws:

RCAException

purgeReviews

List purgeReviews(List listOfReviewIDs,
                  Boolean clearReviewZone)
                  throws RCAException

Removes data for a particular review from database and also removes the review zone for particular review from Review Zone Location. It will not purge a review if it is in progress. Review must be completed/expired/revoked before this api is called. Any such review will be ignored and a warning will be printed. Only users with RCA Administrator role shall be able to call this api.

Parameters:

listOfReviewIDs - List of ReviewIDs to be purged

clearReviewZone - boolean flag, if true then corresponding review zone folder is also deleted.

Returns:

List of ReviewIDs that could not be purged.

Throws:

RCAException

RCAException

getReviewTemplate

com.adobe.idp.Document getReviewTemplate(String templateName)
                                         throws RCAException

Returns the Review Tempalte

Parameters:

templateName -

Returns:

Throws:

RCAException

getDocument

com.adobe.idp.Document getDocument(String reviewID,
                                   Integer revision,
                                   String documentPath)
                                   throws RCAException

It retrieves a Document from the review zone associated with the given review ID and revision .

Parameters:

reviewID - Unique identifier for a Review Zone (Required Parameter)

revision - Revision of the review (Required Parameter)

documentPath - Path at which the passed Document should be stored. This path is Unix like, i.e. / (forward slash) points to root of the Review Zone. Hence this path should start with a / (forward slash) (Required Parameter)

Returns:

Document stored at the passed path (documentPath)

Throws:

PersistenceException, - ReviewZoneNotFoundException If there is no Review Zone associated with the given review ID

PersistenceException, - DocumentNotFoundException If no Document is found at the passed path

PersistenceException, - InvalidPathException If the passed path is invalid.

RCAException

applyReaderExtension

com.adobe.idp.Document applyReaderExtension(com.adobe.idp.Document document)
                                            throws RCAException

Throws:

RCAException

getSupportingDocumentList

List getSupportingDocumentList(String reviewID)
                               throws RCAException

Returns list of RCADocument objects representing Supporting documents for a given review

Parameters:

reviewID - Unique Review Identifier

Returns:

List of RCADocument, if no supporting is found returns null.

Throws:

RCAException