com.adobe.livecycle.rca.client
Class ReviewCommentingAndApprovalUtilClient

java.lang.Object
  com.adobe.livecycle.rca.client.ReviewCommentingAndApprovalUtilClient

public class ReviewCommentingAndApprovalUtilClient
extends Object

Constructor Summary

ReviewCommentingAndApprovalUtilClient(com.adobe.idp.dsc.clientsdk.ServiceClientFactory serviceClientFactory)
Create ManagedReviewAndApprovalUtilClient instance.

Method Summary

Map	findCustomRCAProcesses() Returns a Map of Processes that can be used as Process Hooks or for ARS/RTS Creation .
String	findProcessHooks() Returns the name of all the processes that matches the search for pre and post hook processes.
String	findTrackingSheetProcess() Returns the name of all the processes that matches the search for Approval Routing Slip/Review Tracking Sheet generation process.
String	findUsers(String domainName, String partialUserName) Returns list of users matching the criteria.
Boolean	hasPermission(List permissionList) This method checks if the invoker has all the permissions specified in list of permissions.
void	refreshReviewTemplateList() Migrates old review templates to newer version of review templates.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReviewCommentingAndApprovalUtilClient

public ReviewCommentingAndApprovalUtilClient(com.adobe.idp.dsc.clientsdk.ServiceClientFactory serviceClientFactory)

Create ManagedReviewAndApprovalUtilClient instance.

Parameters:

serviceClientFactory - serviceClientFactory to be used

Method Detail

findUsers

public String findUsers(String domainName,
                        String partialUserName)
                 throws com.adobe.idp.dsc.DSCException

Returns list of users matching the criteria.

Parameters:

domainName - User Management Domain name

partialUserName - Partial user name to be searched

Returns:

STR_SEP separated string that includes common name, user id, email id and oid for each matched user.

Throws:

ICRException - if no such match is found.

com.adobe.idp.dsc.DSCException

findProcessHooks

public String findProcessHooks()
                        throws com.adobe.idp.dsc.DSCException

Returns the name of all the processes that matches the search for pre and post hook processes. Any process having OR_HOOK_IN_1, OR_HOOK_IN_2 as input parameters and OR_HOOK_OUT_1 as output parameter is returned

Returns:

STR_SEP separated string that includes process names

Throws:

com.adobe.idp.dsc.DSCException

findCustomRCAProcesses

public Map findCustomRCAProcesses()
                           throws com.adobe.idp.dsc.DSCException

Returns a Map of Processes that can be used as Process Hooks or for ARS/RTS Creation . The return format is

PROCESS_HOOK_KEY - List of Custom Hooks Processes

TRACKING_SHEET_KEY - List of ARS/RTS Creation Processes

Returns:

Map<String, List>.

Throws:

com.adobe.idp.dsc.DSCException

findTrackingSheetProcess

public String findTrackingSheetProcess()
                                throws com.adobe.idp.dsc.DSCException

Returns the name of all the processes that matches the search for Approval Routing Slip/Review Tracking Sheet generation process. Any process having OR_TRACKING_SHEET_IN_1, TRACKING_SHEET_INPUT_PARAM_2 as input parameters and OR_TRACKING_SHEET_OUT_1 as output parameter is returned.

Returns:

STR_SEP separated string that includes process names

Throws:

com.adobe.idp.dsc.DSCException

hasPermission

public Boolean hasPermission(List permissionList)
                      throws ICRException

This method checks if the invoker has all the permissions specified in list of permissions.

Parameters:

permissionList - List of permission names.

Returns:

true if invoker has has all the permissions.

Throws:

ICRException - if the permission is not a valid RCAPermission

refreshReviewTemplateList

public void refreshReviewTemplateList()
                               throws ICRException

Migrates old review templates to newer version of review templates. In previous release, template information was not stoed in database. In this release, we have also started storing relevant template information in database. This api populates RCA database with template information and allow customer to use older templates.

Throws:

ICRException