com.adobe.livecycle.rca.common.exception
Class ErrorCode

java.lang.Object
  java.lang.Enum
      com.adobe.livecycle.rca.common.exception.ErrorCode

All Implemented Interfaces:

Serializable, Comparable

public final class ErrorCode
extends Enum

Set of Error Codes. Matched by error strings in rcaerrors.properties.

See Also:

Serialized Form

Field Summary

static ErrorCode	ACCESS_DENIED_INITIATE_REVIEW Used when initiateReview is invoked by user not having RCA_INITIATE_REVIEW permission.
static ErrorCode	ACCESS_DENIED_INVITE_EXTERNAL_USER Used when an attempt is made by a user to invite external user provided this user is not RCA Administrator.
static ErrorCode	ACCESS_DENIED_PURGE_REVIEW Used when an attempt is made by non RCA Administrator user to purge a review.
static ErrorCode	ACCESS_DENIED_READ_TEMPLATE Used when getTemplateList/getTemplate API is invoked by user not having RCA_TEMPLATE_READ permission.
static ErrorCode	ACCESS_DENIED_SET_USER_PREF Used when an attempt is made by a user to set the user preference of another user provided this user is not RCA Administrator.
static ErrorCode	ACCESS_DENIED_WRITE_TEMPLATE Used when storeReviewTemplate API is invoked by user not having RCA_TEMPLATE_WRITE permission.
static ErrorCode	ADD_PARTICIPANT_EXCEPTION Used in addReviewer/addApprover APIs if the particpant is already present.
static ErrorCode	ADD_REVIEWER_INVOKED Logs invocation of operation addReviewer in ReviewCommentingAndApprovalService
static ErrorCode	APPROVER_CANNOT_BE_REMOVED_FROM_REVIEW_STAGE Used when in removeApprover API, the stage no.
static ErrorCode	ASSIGN_READ_WRITE_PERMISSION For Internal Use ONLY
static ErrorCode	ATTEMPTING_TO_ACQUIRE_LOCK Used whenever a method tries to acquire lock on a review.
static ErrorCode	AUDIT_CONFIG_ALREADY_EXISTS Used when RCA audit configuration already exist in audit DB..
static ErrorCode	AUDIT_CONFIG_DOESNT_EXISTS Used when an attempt to audit is made but configuration does not exists in Database.
static ErrorCode	AUTHOR_ALREADY_EXIST
static ErrorCode	BOOTSTRAP_GENERAL_ERROR Used when when error is encountered in DSC bootstrap
static ErrorCode	CANNOT_REMOVE_ONLY_APPROVER Used when an attempt is made to remove the only approver from an Approval stage.
static ErrorCode	CANNOT_REMOVE_ONLY_REVIEWER Used when an attempt is made to remove the only Reviewer (Optional/Mandatory) in a review stage.
static ErrorCode	CANNOT_REMOVE_ONLY_RQD_REVIEWER Used when an attempt is made to remove the only mandatory reviewer from a Review stage.
static ErrorCode	CANNOT_REMOVE_PARTICIPANT_PRESENT_SINCE_TEMPLATE_CREATION Used when an attempt is made to remove a Reviewer/Approver if the participant was added at the template creation time.
static ErrorCode	CREATE_EVENT Used in logging, Logged when RCA throws a RCA Event.
static ErrorCode	CUSTOM_PROCESS_INPUT_PARAM_MISMATCH Used when custom process exist but doesn't have the required input parameters.
static ErrorCode	CUSTOM_PROCESS_OUTPUT_PARAM_MISMATCH Used when custom process exist but doesn't have the required output parameters.
static ErrorCode	DOCUMENT_ALREADY_EXISTS Used when storing the document for a review in Review Zone and it already exist.
static ErrorCode	DOCUMENT_NOT_FOUND Used when exception is encountered while retrieving review document from Review Zone
static ErrorCode	DUP_REVIEW_TEMPLATE Used in storeReviewTemplate API if template already exist and overwrite flag is false.
static ErrorCode	DUPLICATE_REVIEW_ZONE Used when review zone already exist while creating a new review zone.
static ErrorCode	EMPTY_INITIATOR_EMAIL Used when the initiator's email address is null or empty string in a Review stage.
static ErrorCode	EMPTY_REVIEW_SERVER_PATH Used when no smb/webdav path is defined while enabling the document for shared review.
static ErrorCode	ENTER Used in logging.
static ErrorCode	ERR_UPDATE_APPROVERS_SIGNATURE_TYPE Used in addApprover/removeApprover APIs if the signature type is client side in an approval stage.
static ErrorCode	ERROR_ATTACHING_SUPPORTING_DOC Used when exception is encountered in fetching supporting document from review zone.
static ErrorCode	ERROR_IN_LISTENER
static ErrorCode	ERROR_LIST_OF_PROCESS_USERS Used when exception is encountered while retrieving the list of users for a given process id.
static ErrorCode	ERROR_PURGING_REVIEW Used in case of exception while purging a review.
static ErrorCode	EVENT_THROW_FAILED Used when an exception is encountered while throwing a LC event.
static ErrorCode	EXIT Used in logging.
static ErrorCode	FAILED_TO_ASSIGN_TASK Used when an exception is encountered while assigning task to a Reviewer/Approver/Initiator.
static ErrorCode	FAILED_TO_CHANGE_TASK_DEADLINE
static ErrorCode	FAILED_TO_FETCH_TASK_LIST
static ErrorCode	FAILED_TO_NOTIFY Used to confirm lock acquisition.
static ErrorCode	FAILED_TO_READ_AUDIT_CONFIG_FROM_REPOSITORY Used when the audit configuration file from RCA LCA is not found and the one packaged in DSC is used.
static ErrorCode	FAILED_TO_REGISTER_AUDIT Used when exception is encountered while registering audit configuration with audit service.
static ErrorCode	FAILED_TO_REVOKE_PERMISSION Used when the permission from comment RSS files couldn't be revoked.
static ErrorCode	FAILED_TO_REVOKE_TASK Used at places where an exception is encountered while revoking user task example: stage expire/revoke etc.
static ErrorCode	FILE_FORMAT_NOT_SUPPORTED Used when a file of unsupported content type is used as a supporting document.
static ErrorCode	GENERATED_HQL Logged whenever RCA fires a DB Query in HQL (Hibernate Query Language).
static ErrorCode	INACTIVE_REVIEW_TEMPLATE Used when an attempt is made to initiate a review with an inactive template.
static ErrorCode	INITIATOR_CANNOT_BE_GROUP Used when in ReviewTemplate xml, the initiator is marked as Group (with the isGroup="true" attribute).
static ErrorCode	INPROGRESS_REVIEW_CANNOT_BE_PURGED Used when an attempt is made to purge an Ongoing review.
static ErrorCode	INVALID_APPROVER_STATUS_FOR_REMOVAL Used when an attempt is made to remove an approver whose status is not Pending.
static ErrorCode	INVALID_ARG_EXCEPTION Illegal argument exception
static ErrorCode	INVALID_CUSTOM_PROCESS_NAME Used when custom process specified in Review Context is invalid.
static ErrorCode	INVALID_OPERATION_ON_CUSTOM_PROCESS Used when custom process exist but operation name is not matched.
static ErrorCode	INVALID_PRINCIPAL_TYPE Used when a given principal object is neither a User or Group.
static ErrorCode	INVALID_RCA_DOCUMENT Used when given RCADocument is invalid.
static ErrorCode	INVALID_RCA_PERMISSION Invalid Review Commenting and Approval permission, Used if hasPermission is called with an invalid permission
static ErrorCode	INVALID_REVIEW_CONTEXT Used in getReviewContext API when the review context is grammatically incorrect.
static ErrorCode	INVALID_REVIEWER
static ErrorCode	INVALID_REVIEWER_STATUS_FOR_REMOVE Used when an attempt is made to remove a reviewer whose status is not one of Pending/Declined.
static ErrorCode	INVALID_REVISION_FOR_REVIEW Used when the given reviewId/revision is invalid in any of the API taking these two parameters in ReviewCommentingAndApprovalService.
static ErrorCode	INVALID_SPACE_CONTENT_PATH Used when given path to a content/space is invalid.
static ErrorCode	INVALID_STAGE_DURATION Used when given stage duraton is negative.
static ErrorCode	INVALID_STAGE_TYPE Used when the passed stage type is not valid
static ErrorCode	INVALID_SUPPORTING_DOCUMENT_TYPE Used when the parameter RCADocument (as supporting document) has invalid properties (uri/document).
static ErrorCode	INVALID_SUPPORTING_DOCUMENT_TYPE_DOCUMENT
static ErrorCode	INVALID_SUPPORTING_DOCUMENT_TYPE_REF
static ErrorCode	INVALID_TEMPLATE_NAME
static ErrorCode	LOCK_ACQUIRED Used to confirm lock acquisition.
static ErrorCode	MULTIPLE_USERS_FOUND_WITH_EMAIL Used while searching for a LC UM user having a particular email address.
static ErrorCode	NO_AUDIT_LEVEL_IN_MODULE Used while trying to audit with an invalid audit level.
static ErrorCode	NO_CONTENT_PRESENT_IN_INPUT_DOC Used when the input document is empty in initiateReview API.
static ErrorCode	NO_ERROR_CODE Rarely used, when an exception is thrown without error code
static ErrorCode	NO_GROUP_FOUND Used when in ReviewTemplate xml there's a reviewer of type group having invalid domain and/or cannonical name.
static ErrorCode	NO_REVIEW_EXISTS Used when an exception is encountered while searching for a review by reviewId, revision etc.
static ErrorCode	NO_SUPPORTING_DOC Used when review is initiated without any supporting document.
static ErrorCode	NO_USER_WITH_EMAIL_FOUND Used while searching for a LC UM user having a particular email address.
static ErrorCode	NOTIFICATION_DISPATCH_FAILED
static ErrorCode	NULL_EMAIL_ID Used when the email address of a reviewer/approver/moderator/initiator is null/empty string.
static ErrorCode	NULL_SUPPORTING_DOCUMENT_IN_RCA_DOCUMENT Used when supporting document wrapped in RCADocument is null.
static ErrorCode	ONLY_APPROVER_CAN_BE_ADDED_TO_APPROVAL_STAGE Used when in addReviewer API, the stage no.
static ErrorCode	ONLY_AUTHOR_CAN_BE_ADDED_TO_CREATION_STAGE
static ErrorCode	ONLY_REVIEWERS_CAN_BE_ADDED_TO_REVIEW_STAGE Used when in addApprover API, the stage no.
static ErrorCode	PARTICIPANT_NOT_FOUND Used in preAssignTask when the passed participantId is invalid.
static ErrorCode	PERM_NOT_FOUND Used when certain permission does not exist during DSC bootstrap.
static ErrorCode	PREPARE_DOCUMENT_SERIVCE_NOT_CONFIGURED used in logging, Logged when the configuration prepareDocumentProcessName is null or empty string
static ErrorCode	REMINDER_EVENT_WASTED Used when a reminder event is received for a stage which is completed.
static ErrorCode	REMOVE_PARTICIPANT_INVOKED Logs invocation of operation removeReviewer in ReviewCommentingAndApprovalService
static ErrorCode	RES_TYPE_NOT_FOUND Used if resource type does not exist during DSC bootstrap.
static ErrorCode	REVIEW_DOCUMENT_NULL Used when review document is null in postStraightThroughProcessing operation.
static ErrorCode	REVIEW_STAGE_HAS_COMPLETED Used when one tries to update an already completed stage of a Review.
static ErrorCode	REVIEW_STARTDT_AFTER_ENDDT Used when the review start date is greater than or equal to review end date.
static ErrorCode	REVIEW_STATUS_NOT_ONGOING Used when an attempt is made to revoke/update a review which is not ongoing.
static ErrorCode	REVIEW_TEMPLATE_DOESNT_EXIST Used in getReviewTemplate API if no template exist with the given name.
static ErrorCode	REVIEW_TEMPLATE_NULL
static ErrorCode	REVIEW_TEMPLATE_REPLACED Used in storeReviewTempalte API if template already exist and overwrite flag is true.
static ErrorCode	REVIEW_ZONE_CANT_BE_CRTD Used when exception is encountered while creating supporting document space.
static ErrorCode	REVIEW_ZONE_CREATION_FAILED Used when exception is encountered while creating Review Zone for a review.
static ErrorCode	REVIEW_ZONE_DOESNT_EXIST Used when Review Zone is missing from Review Zone while storing document/granting permission etc.
static ErrorCode	REVIEW_ZONE_ROOT_NOT_CONFIGURED For Internal Use Only
static ErrorCode	REVIEW_ZONE_SHARED_ROOT_NOT_SENT For Internal Use Only
static ErrorCode	REVIEWER_CANNOT_BE_REMOVED_FROM_APPROVAL_STAGE Used when in removeReviewer API, the stage no.
static ErrorCode	REVISION_STAGE_NUMBER_NULL Used when revision stage number is not supplied in postStraightThroughProcessing operation.
static ErrorCode	REVOKE_REVIEW_INVOKED Logs invocation of operation revokeReview in ReviewCommentingAndApprovalService
static ErrorCode	RZP_ROOT_NOT_CONFIGURED Used in ReviewZoneProvider implementation if review zone root is not configured.
static ErrorCode	RZP_STORENAME_NOT_CONFIGURED Used in ReviewZoneProvider implementation if store name is not configured.
static ErrorCode	RZP_WEBDAV_LOCATION_NOT_CONFIGURED Used in ReviewZoneProvider implementation if webDAV location for review zone root is not configured.
static ErrorCode	SAME_STAGE_DURATION Used when updateStageDuration API is invoked with the same duration that is already set.
static ErrorCode	SERVICE_INVOCATION Used in logging, Logged when a service is invoked by DSC
static ErrorCode	SERVICE_INVOCATION_WITH_RETURN Used in Logging, Logged when a service is invoked by DSC has returned
static ErrorCode	SIGNATURE_SHEET_GENERATION_FAILURE Used when exception is encountered while generating signature sheet.
static ErrorCode	SPACE_CANT_BE_CRTD Used if exception is encountered while creating a space in Review zone.
static ErrorCode	SPACE_DOESNT_EXIST Used if a space doesn't exist while fetching/retrieving content.
static ErrorCode	SPACE_EXIST Used if space exist on the given path in retrieveContent API.
static ErrorCode	STAGE_DURATION_CANT_BE_CHANGED Used when an attempt is made to update the stage duration of a stage which is not Ongoing/Pending.
static ErrorCode	STAGE_DURATION_CANT_BE_NEGETIVE Used when an attempt is made to update the stage duration of a stage with new duration less than 1 unit.
static ErrorCode	STAGE_DURATION_TOO_SMALL Used when the given stage duration is less than 10 min.
static ErrorCode	STAGE_NO_OUT_OF_RANGE Used when the passed stage number is greater than the maximum number of stages in the review OR is less than 1.
static ErrorCode	STAGE_NOT_FOUND Used in expireStage call when the stageId passed is invalid.
static ErrorCode	STAGE_NOT_REFERENCE
static ErrorCode	STAGE_TEMPLATE_ALREADY_EXIST
static ErrorCode	SUPPORTING_SHEET_GEN_ERROR Used when exception is encountered in generating supporting document sheet.
static ErrorCode	SUPPORTING_SHEET_NOT_AVAILABLE Used when no supporting documents are attached with the review.
static ErrorCode	TEMPLATE_NAME_MISSING_IN_REVIEW_TEMPLATE
static ErrorCode	TEMPLATE_NAME_MISSING_IN_STAGE_TEMPLATE
static ErrorCode	TRACKING_SHEET_NOT_AVAILABLE Used when no processes are defined to generate ARS/RTS.
static ErrorCode	UNEXPECTED_EXCEPTION ErrorCode which is used when the cause/type of an underlying exception is unknown.
static ErrorCode	UNKNOWN_ERROR Used when the cause/type of an underlying error is unknown.
static ErrorCode	UNKNOWN_EXCEPTION Used when the cause/type of an underlying exception is unknown.
static ErrorCode	UNSUPPORTED_REVIEW_DOCUMENT Used when the given document is not PDF/convertible to PDF.
static ErrorCode	UPDATE_ACCESS_RESTRICTED Used when an Update stage API is invoked by a user who's not one of the Initiator/Moderator(s) of the stage.
static ErrorCode	UPDATE_REVIEW_STAGE_DURATION Used in logging, Logs invocation of operation updateReviewStageDuration in ReviewCommentingAndApprovalService
static ErrorCode	USER_EMAIL_NOT_SET Used when the ReviewTemplate xml has a reviewer whose email address is not set in LC UM.
static ErrorCode	USER_IS_NOT_LC_USER Logged in user is not a valid LiveCycle User
static ErrorCode	USER_NOT_FOUND Used while searching for a LC UM user based on Domain and Cannonical name.
static ErrorCode	USER_NOT_FOUND_WITH_OID Used when there exist no user in LC UM with the given unique id.

Method Summary

static ErrorCode	getByErrorCode(int errorCode) Creates the ErrorCode object from errorCode and minorCode
ICRError	getError(Object[] parameters) Returns ICRError object, for this particular error code.
int	getErrorCode()
static ErrorCode	valueOf(String name)
static ErrorCode[]	values()

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ENTER

public static final ErrorCode ENTER

Used in logging. Logs when entering a method.

EXIT

public static final ErrorCode EXIT

Used in logging. Logs when exiting a method.

UNEXPECTED_EXCEPTION

public static final ErrorCode UNEXPECTED_EXCEPTION

ErrorCode which is used when the cause/type of an underlying exception is unknown.

UNKNOWN_ERROR

public static final ErrorCode UNKNOWN_ERROR

Used when the cause/type of an underlying error is unknown.

NO_ERROR_CODE

public static final ErrorCode NO_ERROR_CODE

Rarely used, when an exception is thrown without error code

BOOTSTRAP_GENERAL_ERROR

public static final ErrorCode BOOTSTRAP_GENERAL_ERROR

Used when when error is encountered in DSC bootstrap

UNKNOWN_EXCEPTION

public static final ErrorCode UNKNOWN_EXCEPTION

Used when the cause/type of an underlying exception is unknown.

PREPARE_DOCUMENT_SERIVCE_NOT_CONFIGURED

public static final ErrorCode PREPARE_DOCUMENT_SERIVCE_NOT_CONFIGURED

used in logging, Logged when the configuration prepareDocumentProcessName is null or empty string

SERVICE_INVOCATION

public static final ErrorCode SERVICE_INVOCATION

Used in logging, Logged when a service is invoked by DSC

SERVICE_INVOCATION_WITH_RETURN

public static final ErrorCode SERVICE_INVOCATION_WITH_RETURN

Used in Logging, Logged when a service is invoked by DSC has returned

UPDATE_REVIEW_STAGE_DURATION

public static final ErrorCode UPDATE_REVIEW_STAGE_DURATION

Used in logging, Logs invocation of operation updateReviewStageDuration in ReviewCommentingAndApprovalService

CREATE_EVENT

public static final ErrorCode CREATE_EVENT

Used in logging, Logged when RCA throws a RCA Event.

ADD_REVIEWER_INVOKED

public static final ErrorCode ADD_REVIEWER_INVOKED

Logs invocation of operation addReviewer in ReviewCommentingAndApprovalService

REVOKE_REVIEW_INVOKED

public static final ErrorCode REVOKE_REVIEW_INVOKED

Logs invocation of operation revokeReview in ReviewCommentingAndApprovalService

REMOVE_PARTICIPANT_INVOKED

public static final ErrorCode REMOVE_PARTICIPANT_INVOKED

Logs invocation of operation removeReviewer in ReviewCommentingAndApprovalService

ERROR_IN_LISTENER

public static final ErrorCode ERROR_IN_LISTENER

GENERATED_HQL

public static final ErrorCode GENERATED_HQL

Logged whenever RCA fires a DB Query in HQL (Hibernate Query Language). At times the HQL is constructed depending on the input (like while Review search, the HQL is constructed

NO_CONTENT_PRESENT_IN_INPUT_DOC

public static final ErrorCode NO_CONTENT_PRESENT_IN_INPUT_DOC

Used when the input document is empty in initiateReview API.

EMPTY_INITIATOR_EMAIL

public static final ErrorCode EMPTY_INITIATOR_EMAIL

Used when the initiator's email address is null or empty string in a Review stage.

EMPTY_REVIEW_SERVER_PATH

public static final ErrorCode EMPTY_REVIEW_SERVER_PATH

Used when no smb/webdav path is defined while enabling the document for shared review.

REVIEW_STARTDT_AFTER_ENDDT

public static final ErrorCode REVIEW_STARTDT_AFTER_ENDDT

Used when the review start date is greater than or equal to review end date.

REVIEW_STAGE_HAS_COMPLETED

public static final ErrorCode REVIEW_STAGE_HAS_COMPLETED

Used when one tries to update an already completed stage of a Review.

STAGE_NO_OUT_OF_RANGE

public static final ErrorCode STAGE_NO_OUT_OF_RANGE

Used when the passed stage number is greater than the maximum number of stages in the review OR is less than 1.

NO_USER_WITH_EMAIL_FOUND

public static final ErrorCode NO_USER_WITH_EMAIL_FOUND

Used while searching for a LC UM user having a particular email address.

MULTIPLE_USERS_FOUND_WITH_EMAIL

public static final ErrorCode MULTIPLE_USERS_FOUND_WITH_EMAIL

Used while searching for a LC UM user having a particular email address.

EVENT_THROW_FAILED

public static final ErrorCode EVENT_THROW_FAILED

Used when an exception is encountered while throwing a LC event.

NO_REVIEW_EXISTS

public static final ErrorCode NO_REVIEW_EXISTS

Used when an exception is encountered while searching for a review by reviewId, revision etc. This call happens in almost all the APIs of ReviewCommentingAndApprovalService.

REVIEW_STATUS_NOT_ONGOING

public static final ErrorCode REVIEW_STATUS_NOT_ONGOING

Used when an attempt is made to revoke/update a review which is not ongoing.

CANNOT_REMOVE_ONLY_RQD_REVIEWER

public static final ErrorCode CANNOT_REMOVE_ONLY_RQD_REVIEWER

Used when an attempt is made to remove the only mandatory reviewer from a Review stage.

FAILED_TO_ASSIGN_TASK

public static final ErrorCode FAILED_TO_ASSIGN_TASK

Used when an exception is encountered while assigning task to a Reviewer/Approver/Initiator.

INVALID_REVIEWER_STATUS_FOR_REMOVE

public static final ErrorCode INVALID_REVIEWER_STATUS_FOR_REMOVE

Used when an attempt is made to remove a reviewer whose status is not one of Pending/Declined.

INVALID_REVIEWER

public static final ErrorCode INVALID_REVIEWER

ONLY_APPROVER_CAN_BE_ADDED_TO_APPROVAL_STAGE

public static final ErrorCode ONLY_APPROVER_CAN_BE_ADDED_TO_APPROVAL_STAGE

Used when in addReviewer API, the stage no. passed is not a Review stage.

ONLY_REVIEWERS_CAN_BE_ADDED_TO_REVIEW_STAGE

public static final ErrorCode ONLY_REVIEWERS_CAN_BE_ADDED_TO_REVIEW_STAGE

Used when in addApprover API, the stage no. passed is not an Approval stage.

ONLY_AUTHOR_CAN_BE_ADDED_TO_CREATION_STAGE

public static final ErrorCode ONLY_AUTHOR_CAN_BE_ADDED_TO_CREATION_STAGE

REVIEWER_CANNOT_BE_REMOVED_FROM_APPROVAL_STAGE

public static final ErrorCode REVIEWER_CANNOT_BE_REMOVED_FROM_APPROVAL_STAGE

Used when in removeReviewer API, the stage no. passed is not a Review stage.

APPROVER_CANNOT_BE_REMOVED_FROM_REVIEW_STAGE

public static final ErrorCode APPROVER_CANNOT_BE_REMOVED_FROM_REVIEW_STAGE

Used when in removeApprover API, the stage no. passed is not an Approval stage.

CANNOT_REMOVE_ONLY_APPROVER

public static final ErrorCode CANNOT_REMOVE_ONLY_APPROVER

Used when an attempt is made to remove the only approver from an Approval stage.

USER_NOT_FOUND

public static final ErrorCode USER_NOT_FOUND

Used while searching for a LC UM user based on Domain and Cannonical name.

AUTHOR_ALREADY_EXIST

public static final ErrorCode AUTHOR_ALREADY_EXIST

INVALID_APPROVER_STATUS_FOR_REMOVAL

public static final ErrorCode INVALID_APPROVER_STATUS_FOR_REMOVAL

Used when an attempt is made to remove an approver whose status is not Pending.

NULL_SUPPORTING_DOCUMENT_IN_RCA_DOCUMENT

public static final ErrorCode NULL_SUPPORTING_DOCUMENT_IN_RCA_DOCUMENT

Used when supporting document wrapped in RCADocument is null.

INITIATOR_CANNOT_BE_GROUP

public static final ErrorCode INITIATOR_CANNOT_BE_GROUP

Used when in ReviewTemplate xml, the initiator is marked as Group (with the isGroup="true" attribute).

USER_EMAIL_NOT_SET

public static final ErrorCode USER_EMAIL_NOT_SET

Used when the ReviewTemplate xml has a reviewer whose email address is not set in LC UM.

USER_IS_NOT_LC_USER

public static final ErrorCode USER_IS_NOT_LC_USER

Logged in user is not a valid LiveCycle User

INVALID_ARG_EXCEPTION

public static final ErrorCode INVALID_ARG_EXCEPTION

Illegal argument exception

ERR_UPDATE_APPROVERS_SIGNATURE_TYPE

public static final ErrorCode ERR_UPDATE_APPROVERS_SIGNATURE_TYPE

Used in addApprover/removeApprover APIs if the signature type is client side in an approval stage.

NO_GROUP_FOUND

public static final ErrorCode NO_GROUP_FOUND

Used when in ReviewTemplate xml there's a reviewer of type group having invalid domain and/or cannonical name.

UPDATE_ACCESS_RESTRICTED

public static final ErrorCode UPDATE_ACCESS_RESTRICTED

Used when an Update stage API is invoked by a user who's not one of the Initiator/Moderator(s) of the stage.

PERM_NOT_FOUND

public static final ErrorCode PERM_NOT_FOUND

Used when certain permission does not exist during DSC bootstrap. For Internal Use Only.

RES_TYPE_NOT_FOUND

public static final ErrorCode RES_TYPE_NOT_FOUND

Used if resource type does not exist during DSC bootstrap. For internal Use Only

STAGE_NOT_FOUND

public static final ErrorCode STAGE_NOT_FOUND

Used in expireStage call when the stageId passed is invalid.

PARTICIPANT_NOT_FOUND

public static final ErrorCode PARTICIPANT_NOT_FOUND

Used in preAssignTask when the passed participantId is invalid.

ADD_PARTICIPANT_EXCEPTION

public static final ErrorCode ADD_PARTICIPANT_EXCEPTION

Used in addReviewer/addApprover APIs if the particpant is already present.

CANNOT_REMOVE_ONLY_REVIEWER

public static final ErrorCode CANNOT_REMOVE_ONLY_REVIEWER

Used when an attempt is made to remove the only Reviewer (Optional/Mandatory) in a review stage.

CANNOT_REMOVE_PARTICIPANT_PRESENT_SINCE_TEMPLATE_CREATION

public static final ErrorCode CANNOT_REMOVE_PARTICIPANT_PRESENT_SINCE_TEMPLATE_CREATION

Used when an attempt is made to remove a Reviewer/Approver if the participant was added at the template creation time.

INVALID_SUPPORTING_DOCUMENT_TYPE

public static final ErrorCode INVALID_SUPPORTING_DOCUMENT_TYPE

Used when the parameter RCADocument (as supporting document) has invalid properties (uri/document).

STAGE_DURATION_CANT_BE_CHANGED

public static final ErrorCode STAGE_DURATION_CANT_BE_CHANGED

Used when an attempt is made to update the stage duration of a stage which is not Ongoing/Pending.

STAGE_DURATION_CANT_BE_NEGETIVE

public static final ErrorCode STAGE_DURATION_CANT_BE_NEGETIVE

Used when an attempt is made to update the stage duration of a stage with new duration less than 1 unit.

USER_NOT_FOUND_WITH_OID

public static final ErrorCode USER_NOT_FOUND_WITH_OID

Used when there exist no user in LC UM with the given unique id.

FAILED_TO_REVOKE_TASK

public static final ErrorCode FAILED_TO_REVOKE_TASK

Used at places where an exception is encountered while revoking user task example: stage expire/revoke etc.

INACTIVE_REVIEW_TEMPLATE

public static final ErrorCode INACTIVE_REVIEW_TEMPLATE

Used when an attempt is made to initiate a review with an inactive template.

INVALID_RCA_DOCUMENT

public static final ErrorCode INVALID_RCA_DOCUMENT

Used when given RCADocument is invalid.

FILE_FORMAT_NOT_SUPPORTED

public static final ErrorCode FILE_FORMAT_NOT_SUPPORTED

Used when a file of unsupported content type is used as a supporting document.

NULL_EMAIL_ID

public static final ErrorCode NULL_EMAIL_ID

Used when the email address of a reviewer/approver/moderator/initiator is null/empty string.

FAILED_TO_REVOKE_PERMISSION

public static final ErrorCode FAILED_TO_REVOKE_PERMISSION

Used when the permission from comment RSS files couldn't be revoked.

INVALID_REVISION_FOR_REVIEW

public static final ErrorCode INVALID_REVISION_FOR_REVIEW

Used when the given reviewId/revision is invalid in any of the API taking these two parameters in ReviewCommentingAndApprovalService.

STAGE_DURATION_TOO_SMALL

public static final ErrorCode STAGE_DURATION_TOO_SMALL

Used when the given stage duration is less than 10 min. System sets the duration to minimum (10 min) and logs with this code.

SAME_STAGE_DURATION

public static final ErrorCode SAME_STAGE_DURATION

Used when updateStageDuration API is invoked with the same duration that is already set.

INVALID_RCA_PERMISSION

public static final ErrorCode INVALID_RCA_PERMISSION

Invalid Review Commenting and Approval permission, Used if hasPermission is called with an invalid permission

ACCESS_DENIED_INITIATE_REVIEW

public static final ErrorCode ACCESS_DENIED_INITIATE_REVIEW

Used when initiateReview is invoked by user not having RCA_INITIATE_REVIEW permission.

ACCESS_DENIED_READ_TEMPLATE

public static final ErrorCode ACCESS_DENIED_READ_TEMPLATE

Used when getTemplateList/getTemplate API is invoked by user not having RCA_TEMPLATE_READ permission.

ACCESS_DENIED_WRITE_TEMPLATE

public static final ErrorCode ACCESS_DENIED_WRITE_TEMPLATE

Used when storeReviewTemplate API is invoked by user not having RCA_TEMPLATE_WRITE permission.

INVALID_STAGE_DURATION

public static final ErrorCode INVALID_STAGE_DURATION

Used when given stage duraton is negative.

ERROR_LIST_OF_PROCESS_USERS

public static final ErrorCode ERROR_LIST_OF_PROCESS_USERS

Used when exception is encountered while retrieving the list of users for a given process id.

INVALID_PRINCIPAL_TYPE

public static final ErrorCode INVALID_PRINCIPAL_TYPE

Used when a given principal object is neither a User or Group.

ERROR_PURGING_REVIEW

public static final ErrorCode ERROR_PURGING_REVIEW

Used in case of exception while purging a review.

ACCESS_DENIED_PURGE_REVIEW

public static final ErrorCode ACCESS_DENIED_PURGE_REVIEW

Used when an attempt is made by non RCA Administrator user to purge a review.

INPROGRESS_REVIEW_CANNOT_BE_PURGED

public static final ErrorCode INPROGRESS_REVIEW_CANNOT_BE_PURGED

Used when an attempt is made to purge an Ongoing review.

INVALID_STAGE_TYPE

public static final ErrorCode INVALID_STAGE_TYPE

Used when the passed stage type is not valid

TEMPLATE_NAME_MISSING_IN_STAGE_TEMPLATE

public static final ErrorCode TEMPLATE_NAME_MISSING_IN_STAGE_TEMPLATE

STAGE_TEMPLATE_ALREADY_EXIST

public static final ErrorCode STAGE_TEMPLATE_ALREADY_EXIST

TEMPLATE_NAME_MISSING_IN_REVIEW_TEMPLATE

public static final ErrorCode TEMPLATE_NAME_MISSING_IN_REVIEW_TEMPLATE

FAILED_TO_CHANGE_TASK_DEADLINE

public static final ErrorCode FAILED_TO_CHANGE_TASK_DEADLINE

FAILED_TO_FETCH_TASK_LIST

public static final ErrorCode FAILED_TO_FETCH_TASK_LIST

INVALID_TEMPLATE_NAME

public static final ErrorCode INVALID_TEMPLATE_NAME

STAGE_NOT_REFERENCE

public static final ErrorCode STAGE_NOT_REFERENCE

REVIEW_TEMPLATE_NULL

public static final ErrorCode REVIEW_TEMPLATE_NULL

INVALID_REVIEW_CONTEXT

public static final ErrorCode INVALID_REVIEW_CONTEXT

Used in getReviewContext API when the review context is grammatically incorrect.

FAILED_TO_REGISTER_AUDIT

public static final ErrorCode FAILED_TO_REGISTER_AUDIT

Used when exception is encountered while registering audit configuration with audit service.

FAILED_TO_READ_AUDIT_CONFIG_FROM_REPOSITORY

public static final ErrorCode FAILED_TO_READ_AUDIT_CONFIG_FROM_REPOSITORY

Used when the audit configuration file from RCA LCA is not found and the one packaged in DSC is used.

AUDIT_CONFIG_ALREADY_EXISTS

public static final ErrorCode AUDIT_CONFIG_ALREADY_EXISTS

Used when RCA audit configuration already exist in audit DB..

AUDIT_CONFIG_DOESNT_EXISTS

public static final ErrorCode AUDIT_CONFIG_DOESNT_EXISTS

Used when an attempt to audit is made but configuration does not exists in Database.

NO_AUDIT_LEVEL_IN_MODULE

public static final ErrorCode NO_AUDIT_LEVEL_IN_MODULE

Used while trying to audit with an invalid audit level.

ATTEMPTING_TO_ACQUIRE_LOCK

public static final ErrorCode ATTEMPTING_TO_ACQUIRE_LOCK

Used whenever a method tries to acquire lock on a review. Used for logging purpose

LOCK_ACQUIRED

public static final ErrorCode LOCK_ACQUIRED

Used to confirm lock acquisition. Used for logging purpose

FAILED_TO_NOTIFY

public static final ErrorCode FAILED_TO_NOTIFY

Used to confirm lock acquisition.

INVALID_CUSTOM_PROCESS_NAME

public static final ErrorCode INVALID_CUSTOM_PROCESS_NAME

Used when custom process specified in Review Context is invalid.

INVALID_OPERATION_ON_CUSTOM_PROCESS

public static final ErrorCode INVALID_OPERATION_ON_CUSTOM_PROCESS

Used when custom process exist but operation name is not matched. In case of process, operation name is invoke. Unless you specify service name instead of process, this error would never occur.

CUSTOM_PROCESS_INPUT_PARAM_MISMATCH

public static final ErrorCode CUSTOM_PROCESS_INPUT_PARAM_MISMATCH

Used when custom process exist but doesn't have the required input parameters.

CUSTOM_PROCESS_OUTPUT_PARAM_MISMATCH

public static final ErrorCode CUSTOM_PROCESS_OUTPUT_PARAM_MISMATCH

Used when custom process exist but doesn't have the required output parameters.

TRACKING_SHEET_NOT_AVAILABLE

public static final ErrorCode TRACKING_SHEET_NOT_AVAILABLE

Used when no processes are defined to generate ARS/RTS.

SUPPORTING_SHEET_NOT_AVAILABLE

public static final ErrorCode SUPPORTING_SHEET_NOT_AVAILABLE

Used when no supporting documents are attached with the review.

SUPPORTING_SHEET_GEN_ERROR

public static final ErrorCode SUPPORTING_SHEET_GEN_ERROR

Used when exception is encountered in generating supporting document sheet.

ERROR_ATTACHING_SUPPORTING_DOC

public static final ErrorCode ERROR_ATTACHING_SUPPORTING_DOC

Used when exception is encountered in fetching supporting document from review zone.

NO_SUPPORTING_DOC

public static final ErrorCode NO_SUPPORTING_DOC

Used when review is initiated without any supporting document.

SIGNATURE_SHEET_GENERATION_FAILURE

public static final ErrorCode SIGNATURE_SHEET_GENERATION_FAILURE

Used when exception is encountered while generating signature sheet.

REVISION_STAGE_NUMBER_NULL

public static final ErrorCode REVISION_STAGE_NUMBER_NULL

Used when revision stage number is not supplied in postStraightThroughProcessing operation.

REVIEW_DOCUMENT_NULL

public static final ErrorCode REVIEW_DOCUMENT_NULL

Used when review document is null in postStraightThroughProcessing operation.

REMINDER_EVENT_WASTED

public static final ErrorCode REMINDER_EVENT_WASTED

Used when a reminder event is received for a stage which is completed.

REVIEW_ZONE_ROOT_NOT_CONFIGURED

public static final ErrorCode REVIEW_ZONE_ROOT_NOT_CONFIGURED

For Internal Use Only

REVIEW_ZONE_SHARED_ROOT_NOT_SENT

public static final ErrorCode REVIEW_ZONE_SHARED_ROOT_NOT_SENT

For Internal Use Only

DUPLICATE_REVIEW_ZONE

public static final ErrorCode DUPLICATE_REVIEW_ZONE

Used when review zone already exist while creating a new review zone.

REVIEW_ZONE_CANT_BE_CRTD

public static final ErrorCode REVIEW_ZONE_CANT_BE_CRTD

Used when exception is encountered while creating supporting document space.

REVIEW_ZONE_DOESNT_EXIST

public static final ErrorCode REVIEW_ZONE_DOESNT_EXIST

Used when Review Zone is missing from Review Zone while storing document/granting permission etc.

DOCUMENT_NOT_FOUND

public static final ErrorCode DOCUMENT_NOT_FOUND

Used when exception is encountered while retrieving review document from Review Zone

DOCUMENT_ALREADY_EXISTS

public static final ErrorCode DOCUMENT_ALREADY_EXISTS

Used when storing the document for a review in Review Zone and it already exist.

REVIEW_TEMPLATE_DOESNT_EXIST

public static final ErrorCode REVIEW_TEMPLATE_DOESNT_EXIST

Used in getReviewTemplate API if no template exist with the given name.

DUP_REVIEW_TEMPLATE

public static final ErrorCode DUP_REVIEW_TEMPLATE

Used in storeReviewTemplate API if template already exist and overwrite flag is false.

INVALID_SPACE_CONTENT_PATH

public static final ErrorCode INVALID_SPACE_CONTENT_PATH

Used when given path to a content/space is invalid.

REVIEW_TEMPLATE_REPLACED

public static final ErrorCode REVIEW_TEMPLATE_REPLACED

Used in storeReviewTempalte API if template already exist and overwrite flag is true.

REVIEW_ZONE_CREATION_FAILED

public static final ErrorCode REVIEW_ZONE_CREATION_FAILED

Used when exception is encountered while creating Review Zone for a review.

INVALID_SUPPORTING_DOCUMENT_TYPE_DOCUMENT

public static final ErrorCode INVALID_SUPPORTING_DOCUMENT_TYPE_DOCUMENT

ASSIGN_READ_WRITE_PERMISSION

public static final ErrorCode ASSIGN_READ_WRITE_PERMISSION

For Internal Use ONLY

INVALID_SUPPORTING_DOCUMENT_TYPE_REF

public static final ErrorCode INVALID_SUPPORTING_DOCUMENT_TYPE_REF

RZP_STORENAME_NOT_CONFIGURED

public static final ErrorCode RZP_STORENAME_NOT_CONFIGURED

Used in ReviewZoneProvider implementation if store name is not configured. Default is used instead.

RZP_ROOT_NOT_CONFIGURED

public static final ErrorCode RZP_ROOT_NOT_CONFIGURED

Used in ReviewZoneProvider implementation if review zone root is not configured. Default is used instead.

RZP_WEBDAV_LOCATION_NOT_CONFIGURED

public static final ErrorCode RZP_WEBDAV_LOCATION_NOT_CONFIGURED

Used in ReviewZoneProvider implementation if webDAV location for review zone root is not configured. Default is used instead.

SPACE_CANT_BE_CRTD

public static final ErrorCode SPACE_CANT_BE_CRTD

Used if exception is encountered while creating a space in Review zone.

SPACE_DOESNT_EXIST

public static final ErrorCode SPACE_DOESNT_EXIST

Used if a space doesn't exist while fetching/retrieving content.

SPACE_EXIST

public static final ErrorCode SPACE_EXIST

Used if space exist on the given path in retrieveContent API. Used for logging purposes only

UNSUPPORTED_REVIEW_DOCUMENT

public static final ErrorCode UNSUPPORTED_REVIEW_DOCUMENT

Used when the given document is not PDF/convertible to PDF.

ACCESS_DENIED_SET_USER_PREF

public static final ErrorCode ACCESS_DENIED_SET_USER_PREF

Used when an attempt is made by a user to set the user preference of another user provided this user is not RCA Administrator.

ACCESS_DENIED_INVITE_EXTERNAL_USER

public static final ErrorCode ACCESS_DENIED_INVITE_EXTERNAL_USER

Used when an attempt is made by a user to invite external user provided this user is not RCA Administrator.

NOTIFICATION_DISPATCH_FAILED

public static final ErrorCode NOTIFICATION_DISPATCH_FAILED

Method Detail

values

public static ErrorCode[] values()

valueOf

public static ErrorCode valueOf(String name)

getError

public ICRError getError(Object[] parameters)

Returns ICRError object, for this particular error code.

Parameters:

parameters - paremeters to be inserted into the error message

Returns:

ICRError object

getByErrorCode

public static ErrorCode getByErrorCode(int errorCode)

Creates the ErrorCode object from errorCode and minorCode

Parameters:

errorCode -

minorCode -

Returns:

getErrorCode

public int getErrorCode()