com.adobe.livecycle.rca.ria
Interface ReviewAndApproval


public interface ReviewAndApproval

Signature for Core Service of Review and Approval service


Field Summary
static String DATE_FORMAT
           
 
Method Summary
 void addParticipantToStage(String reviewId, Integer stageNo, StageParticipantTO stageParticipant)
           
 Boolean deleteReviewTemplate(String templateName)
           
 void expireStage(String stageId, Integer duration)
           
 com.adobe.livecycle.content.File exportAssetArchive(String reviewId, int revision)
           
 com.adobe.livecycle.content.File getCommentsForParticipant(String reviewId, int revision, int stageNo, String participantOid)
           
 com.adobe.livecycle.content.File getDocument(String reviewId, Integer revision, String documentPath)
           
 com.adobe.livecycle.content.File getDocumentWithComments(String reviewId, Integer revision, Integer stageNo)
           
 String getProcessId(String participantId)
           
 ReviewContextTO getReviewByProcessId(String assignTaskPid)
           
 ReviewContextTO getReviewContext(String reviewId, Integer revision)
           
 com.adobe.livecycle.content.File getReviewDocument(String reviewId, Integer revision)
           
 ReviewTemplateTO getReviewTemplate(String templateName)
           
 List getRevisions(String reviewId)
           
 com.adobe.livecycle.content.File getStageDocument(String reviewId, Integer revision, Integer stageNo)
           
 UserPreferenceTO getUserPreference(String domain, String canonicalName)
           
 void handleTaskReassignment(String processId, String userId, Integer taskEventType)
           
 String initiateReview(ReviewTemplateTO reviewTemplate, com.adobe.livecycle.content.File reviewDocument)
           
 String initiateReview(ReviewTemplateTO reviewTemplate, com.adobe.livecycle.content.File nativeDocument, com.adobe.livecycle.content.File reviewDocument)
           
 com.adobe.livecycle.content.File postAssignTask(String reviewId, ParticipantTO participantTO, com.adobe.livecycle.content.File taskDocument)
           
 void postStraightThroughProcessingAssignTask(String reviewId, Integer revision, Boolean reviseReview, Integer revisionStageNo, com.adobe.livecycle.content.File reviewDocument, String changeDescription)
           
 void preAssignTask(String reviewId, ParticipantTO participantTO, String assignTaskPid)
           
 List purgeReviews(List reviewIdList, Boolean clearReviewZone)
           
 void removeParticipantFromStage(String reviewId, Integer stageNo, StageParticipantTO stageParticipant)
           
 void resolveStage(String reviewId, int stageNo)
           
 void reviseReview(String reviewId, Integer stageNo, com.adobe.livecycle.content.File reviewDocument, String changeDescription)
           
 void revokeReview(String reviewId)
           
 List searchReviews(ReviewSearchFilterTO reviewSearchFilter)
           
 List searchReviewTemplates(TemplateSearchFilter templateSearchFilter)
           
 void sendReminder(String stageId, Integer duration, String reminderId)
           
 void setStageDisposition(String reviewId, Integer revision, Integer stageNo, String disposition)
           
 void setUserPreference(String domain, String canonicalName, UserPreferenceTO userPreference)
           
 void storeContentInCRX(String absSpacePath, String fileName, com.adobe.livecycle.content.File document, Boolean throwOsgiEventOnly)
           
 void storeReviewTemplate(ReviewTemplateTO reviewTemplate, Boolean overwrite)
           
 void toggleReviewerType(String reviewerId)
           
 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
See Also:
Constant Field Values
Method Detail

initiateReview

String initiateReview(ReviewTemplateTO reviewTemplate,
                      com.adobe.livecycle.content.File reviewDocument)
                      throws ICRException
Throws:
ICRException

initiateReview

String initiateReview(ReviewTemplateTO reviewTemplate,
                      com.adobe.livecycle.content.File nativeDocument,
                      com.adobe.livecycle.content.File 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.livecycle.content.File 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

getDocument

com.adobe.livecycle.content.File getDocument(String reviewId,
                                             Integer revision,
                                             String documentPath)
                                             throws ICRException
Throws:
ICRException

getStageDocument

com.adobe.livecycle.content.File getStageDocument(String reviewId,
                                                  Integer revision,
                                                  Integer stageNo)
                                                  throws ICRException
Throws:
ICRException

getReviewDocument

com.adobe.livecycle.content.File getReviewDocument(String reviewId,
                                                   Integer revision)
                                                   throws ICRException
Throws:
ICRException

getCommentsForParticipant

com.adobe.livecycle.content.File getCommentsForParticipant(String reviewId,
                                                           int revision,
                                                           int stageNo,
                                                           String participantOid)
                                                           throws ICRException
Throws:
ICRException

getDocumentWithComments

com.adobe.livecycle.content.File getDocumentWithComments(String reviewId,
                                                         Integer revision,
                                                         Integer stageNo)
                                                         throws ICRException
Throws:
ICRException

expireStage

void expireStage(String stageId,
                 Integer duration)
                 throws ICRException
Throws:
ICRException

preAssignTask

void preAssignTask(String reviewId,
                   ParticipantTO participantTO,
                   String assignTaskPid)
                   throws ICRException
Throws:
ICRException

postAssignTask

com.adobe.livecycle.content.File postAssignTask(String reviewId,
                                                ParticipantTO participantTO,
                                                com.adobe.livecycle.content.File taskDocument)
                                                throws ICRException
Throws:
ICRException

postStraightThroughProcessingAssignTask

void postStraightThroughProcessingAssignTask(String reviewId,
                                             Integer revision,
                                             Boolean reviseReview,
                                             Integer revisionStageNo,
                                             com.adobe.livecycle.content.File reviewDocument,
                                             String changeDescription)
                                             throws ICRException
Throws:
ICRException

sendReminder

void sendReminder(String stageId,
                  Integer duration,
                  String reminderId)
                  throws ICRException
Throws:
ICRException

handleTaskReassignment

void handleTaskReassignment(String processId,
                            String userId,
                            Integer taskEventType)
                            throws ICRException
Throws:
ICRException

setStageDisposition

void setStageDisposition(String reviewId,
                         Integer revision,
                         Integer stageNo,
                         String disposition)
                         throws ICRException
Throws:
ICRException

getProcessId

String getProcessId(String participantId)
                    throws PersistenceException
Throws:
PersistenceException

resolveStage

void resolveStage(String reviewId,
                  int stageNo)
                  throws ICRException
Throws:
ICRException

toggleReviewerType

void toggleReviewerType(String reviewerId)
                        throws ICRException
Throws:
ICRException

exportAssetArchive

com.adobe.livecycle.content.File exportAssetArchive(String reviewId,
                                                    int revision)
                                                    throws ICRException
Throws:
ICRException

storeContentInCRX

void storeContentInCRX(String absSpacePath,
                       String fileName,
                       com.adobe.livecycle.content.File document,
                       Boolean throwOsgiEventOnly)
                       throws ICRException
Throws:
ICRException


[an error occurred while processing this directive] [an error occurred while processing this directive]