Package com.lexmark.saperion.exceptions.mappings

Enum RuntimeExceptionFactory.RuntimeErrors

java.lang.Object

java.lang.Enum<RuntimeExceptionFactory.RuntimeErrors>

com.lexmark.saperion.exceptions.mappings.RuntimeExceptionFactory.RuntimeErrors

All Implemented Interfaces:

ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>, java.io.Serializable, java.lang.Comparable<RuntimeExceptionFactory.RuntimeErrors>

Enclosing class:

RuntimeExceptionFactory

public static enum RuntimeExceptionFactory.RuntimeErrors
extends java.lang.Enum<RuntimeExceptionFactory.RuntimeErrors>
implements ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Runtime error definitions.

Author:

owaeldrich

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKEND_CONNECTION_ERROR
BACKEND_EVENT_PROCESSING_ERROR
BACKEND_UN_PROCESSABLE_OPERATION_ERROR
CLIENT_ACCESS_DENIED
CLIENT_CONCURRENT_WRITE_ERROR
CLIENT_ILLEGAL_RETENTION_ERROR
CLIENT_MANDATORY_CONSTRAINT_VIOLATION_ERROR
CLIENT_NO_LICENSE_AVAILABLE_ERROR
CLIENT_OBJECT_LOCKED_ERROR
CLIENT_RETENTION_VIOLATION_ERROR
CLIENT_SEARCH_ERROR
CLIENT_STORAGE_PROFILE_ASSIGNMENT_ERROR
CLIENT_SYSTEM_FIELD_WRITE_ERROR
CLIENT_UNIQUE_CONSTRAINT_VIOLATION_ERROR
CLIENT_WRONG_ARCHIVE_TYPE_ERROR
GENERAL_ERROR
ILLEGAL_INPUT_ERROR
INTERNAL_SERVER_ERROR
RESOURCE_NOT_FOUND_ERROR

Method Summary

Modifier and Type	Method	Description
com.lexmark.saperion.exceptions.EcmRuntimeException	createException(com.lexmark.saperion.exceptions.ErrorType error, java.lang.Throwable cause)	Creates a new exception for the given server fault.
com.lexmark.saperion.exceptions.EcmRuntimeException	createException(java.lang.String message)	Creates a new exception for the given server fault.
com.lexmark.saperion.exceptions.EcmRuntimeException	createException(java.lang.String message, java.lang.Throwable cause)	Creates a new exception for the given server fault.
com.lexmark.saperion.exceptions.EcmRuntimeException	createException(java.lang.Throwable cause)	Creates a new exception for the given server fault.
com.lexmark.saperion.exceptions.ErrorCodeType	getErrorCode()	Returns the error code this exception mapping applies to.
boolean	validate()	Validates the integrity of the exception mapping.
static RuntimeExceptionFactory.RuntimeErrors	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static RuntimeExceptionFactory.RuntimeErrors[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GENERAL_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors GENERAL_ERROR

INTERNAL_SERVER_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors INTERNAL_SERVER_ERROR

RESOURCE_NOT_FOUND_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors RESOURCE_NOT_FOUND_ERROR

ILLEGAL_INPUT_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors ILLEGAL_INPUT_ERROR

CLIENT_SEARCH_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_SEARCH_ERROR

CLIENT_MANDATORY_CONSTRAINT_VIOLATION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_MANDATORY_CONSTRAINT_VIOLATION_ERROR

CLIENT_SYSTEM_FIELD_WRITE_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_SYSTEM_FIELD_WRITE_ERROR

CLIENT_UNIQUE_CONSTRAINT_VIOLATION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_UNIQUE_CONSTRAINT_VIOLATION_ERROR

CLIENT_ACCESS_DENIED

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_ACCESS_DENIED

CLIENT_WRONG_ARCHIVE_TYPE_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_WRONG_ARCHIVE_TYPE_ERROR

CLIENT_CONCURRENT_WRITE_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_CONCURRENT_WRITE_ERROR

BACKEND_CONNECTION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors BACKEND_CONNECTION_ERROR

CLIENT_OBJECT_LOCKED_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_OBJECT_LOCKED_ERROR

CLIENT_STORAGE_PROFILE_ASSIGNMENT_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_STORAGE_PROFILE_ASSIGNMENT_ERROR

CLIENT_ILLEGAL_RETENTION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_ILLEGAL_RETENTION_ERROR

CLIENT_RETENTION_VIOLATION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_RETENTION_VIOLATION_ERROR

BACKEND_EVENT_PROCESSING_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors BACKEND_EVENT_PROCESSING_ERROR

CLIENT_NO_LICENSE_AVAILABLE_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors CLIENT_NO_LICENSE_AVAILABLE_ERROR

BACKEND_UN_PROCESSABLE_OPERATION_ERROR

public static final RuntimeExceptionFactory.RuntimeErrors BACKEND_UN_PROCESSABLE_OPERATION_ERROR

Method Detail

values

public static RuntimeExceptionFactory.RuntimeErrors[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RuntimeExceptionFactory.RuntimeErrors c : RuntimeExceptionFactory.RuntimeErrors.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RuntimeExceptionFactory.RuntimeErrors valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

createException

public com.lexmark.saperion.exceptions.EcmRuntimeException createException(com.lexmark.saperion.exceptions.ErrorType error,
                                                                           java.lang.Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Parameters:

error - the server error

cause - the exception cause

Returns:

the new exception

createException

public com.lexmark.saperion.exceptions.EcmRuntimeException createException(java.lang.String message)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Parameters:

message - the error message

Returns:

the new exception

createException

public com.lexmark.saperion.exceptions.EcmRuntimeException createException(java.lang.String message,
                                                                           java.lang.Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Parameters:

message - the error message

cause - the exception cause

Returns:

the new exception

createException

public com.lexmark.saperion.exceptions.EcmRuntimeException createException(java.lang.Throwable cause)

Description copied from interface: ExceptionMapping

Creates a new exception for the given server fault.

Specified by:

createException in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Parameters:

cause - the exception cause

Returns:

the new exception

getErrorCode

public com.lexmark.saperion.exceptions.ErrorCodeType getErrorCode()

Description copied from interface: ExceptionMapping

Returns the error code this exception mapping applies to.

Specified by:

getErrorCode in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Returns:

the exception mapping's error code

validate

public boolean validate()

Description copied from interface: ExceptionMapping

Validates the integrity of the exception mapping. An exception mapping is valid if the mapped exception class can be instantiated and an appropriate factory constructor exists. Appropriate exception implementations must provide a factory constructors that consume an ErrorType and a Throwable.

Specified by:

validate in interface ExceptionMapping<com.lexmark.saperion.exceptions.EcmRuntimeException>

Returns:

true if the mapping is valid and the mapped exception fits the design rules, otherwise false