com.adobe.livecycle.rca.ria.client
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	addParticipantToStage(String reviewId, Integer stageNo, StageParticipantTO stageParticipant)
Boolean	deleteReviewTemplate(String templateName)
ReviewContextTO	getReviewByProcessId(String assignTaskPid)
ReviewContextTO	getReviewContext(String reviewId, Integer revision)
ReviewTemplateTO	getReviewTemplate(String templateName)
List	getRevisions(String reviewId)
UserPreferenceTO	getUserPreference(String domain, String canonicalName)
String	initiateReview(ReviewContextTO reviewContext, com.adobe.idp.Document reviewDocument)
List	purgeReviews(List reviewIdList, Boolean clearReviewZone)
void	removeParticipantFromStage(String reviewId, Integer stageNo, StageParticipantTO stageParticipant)
void	reviseReview(String reviewId, Integer stageNo, com.adobe.idp.Document reviewDocument, String changeDescription)
void	revokeReview(String reviewId)
List	searchReviews(ReviewSearchFilterTO reviewSearchFilter)
List	searchReviewTemplates(TemplateSearchFilter templateSearchFilter)
void	setUserPreference(String domain, String canonicalName, UserPreferenceTO userPreference)
void	storeReviewTemplate(ReviewTemplateTO reviewTemplate, Boolean overwrite)
void	updateCustomAttributes(String reviewId, Integer revision, List customAttributes, Boolean discardOld)
void	updateStageDuration(String reviewId, Integer stageNo, Integer duration, String durationUnit)

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(ReviewContextTO reviewContext,
                      com.adobe.idp.Document reviewDocument)
                      throws ICRException

Throws:

ICRException

searchReviews

List searchReviews(ReviewSearchFilterTO reviewSearchFilter)
                   throws ICRException

Throws:

ICRException

getRevisions

List getRevisions(String reviewId)
                  throws ICRException

Throws:

ICRException

updateStageDuration

void updateStageDuration(String reviewId,
                         Integer stageNo,
                         Integer duration,
                         String durationUnit)
                         throws ICRException

Throws:

ICRException

addParticipantToStage

void addParticipantToStage(String reviewId,
                           Integer stageNo,
                           StageParticipantTO stageParticipant)
                           throws ICRException,
                                  TaskAssignmentFailedException

Throws:

ICRException

TaskAssignmentFailedException

revokeReview

void revokeReview(String reviewId)
                  throws ICRException

Throws:

ICRException

getReviewContext

ReviewContextTO getReviewContext(String reviewId,
                                 Integer revision)
                                 throws ICRException

Throws:

ICRException

removeParticipantFromStage

void removeParticipantFromStage(String reviewId,
                                Integer stageNo,
                                StageParticipantTO stageParticipant)
                                throws ICRException

Throws:

ICRException

reviseReview

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

Throws:

ICRException

storeReviewTemplate

void storeReviewTemplate(ReviewTemplateTO reviewTemplate,
                         Boolean overwrite)
                         throws ICRException

Throws:

ICRException

setUserPreference

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

Throws:

ICRException

getUserPreference

UserPreferenceTO getUserPreference(String domain,
                                   String canonicalName)
                                   throws ICRException

Throws:

ICRException

getReviewByProcessId

ReviewContextTO getReviewByProcessId(String assignTaskPid)
                                     throws ICRException

Throws:

ICRException

updateCustomAttributes

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

Throws:

ICRException

searchReviewTemplates

List searchReviewTemplates(TemplateSearchFilter templateSearchFilter)
                           throws ICRException

Throws:

ICRException

deleteReviewTemplate

Boolean deleteReviewTemplate(String templateName)
                             throws ICRException

Throws:

ICRException

purgeReviews

List purgeReviews(List reviewIdList,
                  Boolean clearReviewZone)
                  throws ICRException

Throws:

ICRException

getReviewTemplate

ReviewTemplateTO getReviewTemplate(String templateName)
                                   throws ICRException

Throws:

ICRException