com.lexmark.saperion.exceptions

Class EcmException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.lexmark.saperion.exceptions.EcmException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationException, SystemException

public class EcmException
extends Exception

Base implementation for all ECM Service checked exceptions. Each ECM Service exception has an unique error code. The error code uniquely identifies a service error. It is documented and only used for its defined purpose. Additionally, an ECM Service exception MAY contain optional error description parameters and error details. Description parameters are a map of name-value pairs. Description parameters provide additional error information. The description parameter names are therefore potentially subject to localization. They SHOULD be used for message identifiers. Error details are any error related information that is used by calling applications to handle an error.

Author:

owaeldrich

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EcmException(ErrorConstantType errorCode) Creates a new exception with the given error code.
EcmException(ErrorConstantType errorCode, ErrorDetailsType errorDetails, Map<String,String> parameters, String message, Throwable cause) Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.
EcmException(ErrorConstantType errorCode, ErrorDetailsType errorDetails, String message, Throwable cause) Creates a new exception with the given error code, error details, exception cause and exception message.
EcmException(ErrorConstantType errorCode, String message) Creates a new exception with the given error code and exception message.
EcmException(ErrorConstantType errorCode, String message, ErrorDetailsType errorDetails) Creates a new exception with the given error code and exception message.
EcmException(ErrorConstantType errorCode, Throwable cause) Creates a new exception with the given error code and exception cause.
EcmException(ErrorConstantType errorCode, Throwable cause, ErrorDetailsType errorDetails) Creates a new exception with the given error code and exception cause.
EcmException(ErrorType error, Throwable cause) Deserialization constructor.

Method Summary

Modifier and Type	Method and Description
ErrorType	createError() Creates a new error representation for this exception.
Map<String,String>	getDescriptionParameters() Returns the error description parameters.
ErrorCodeType	getErrorCode() Returns the exception error code.
ErrorDetailsType	getErrorDetails() Returns the exception error details.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EcmException

public EcmException(ErrorConstantType errorCode)

Creates a new exception with the given error code.

Parameters:

errorCode - the error code

EcmException

public EcmException(ErrorConstantType errorCode,
                    ErrorDetailsType errorDetails,
                    Map<String,String> parameters,
                    String message,
                    Throwable cause)

Creates a new exception with the given error code, error details, error parameters, exception cause and exception message.

Parameters:

errorCode - the error code

errorDetails - the error details

parameters - the error parameters

message - the exception message

cause - the exception cause

EcmException

public EcmException(ErrorConstantType errorCode,
                    ErrorDetailsType errorDetails,
                    String message,
                    Throwable cause)

Creates a new exception with the given error code, error details, exception cause and exception message.

Parameters:

errorCode - the error code

errorDetails - the error details

message - the exception message

cause - the exception cause

EcmException

public EcmException(ErrorConstantType errorCode,
                    String message)

Creates a new exception with the given error code and exception message.

Parameters:

errorCode - the error code

message - the exception message

EcmException

public EcmException(ErrorConstantType errorCode,
                    String message,
                    ErrorDetailsType errorDetails)

Creates a new exception with the given error code and exception message.

Parameters:

errorCode - the error code

message - the exception message

errorDetails - the error details

EcmException

public EcmException(ErrorConstantType errorCode,
                    Throwable cause)

Creates a new exception with the given error code and exception cause.

Parameters:

errorCode - the error code

cause - the exception cause

EcmException

public EcmException(ErrorConstantType errorCode,
                    Throwable cause,
                    ErrorDetailsType errorDetails)

Creates a new exception with the given error code and exception cause.

Parameters:

errorCode - the error code

cause - the exception cause

errorDetails - the error details

EcmException

public EcmException(ErrorType error,
                    Throwable cause)

Deserialization constructor. This constructor is used for exception deserialization.

Parameters:

error - the server error

cause - the exception cause

Method Detail

createError

public ErrorType createError()

Creates a new error representation for this exception.

Returns:

the error entity

getDescriptionParameters

public Map<String,String> getDescriptionParameters()

Returns the error description parameters.

Returns:

the error description parameters

getErrorCode

public ErrorCodeType getErrorCode()

Returns the exception error code.

Returns:

the errorCode

getErrorDetails

public ErrorDetailsType getErrorDetails()

Returns the exception error details.

Returns:

the errorDetails