Package com.arbortext.epic.cms

Class CMSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.arbortext.epic.cms.CMSException

All Implemented Interfaces:

Serializable

public class CMSException
extends Exception

Defines the exception thrown by the methods and properties in the Arbortext Object Model (AOM) that work with content management systems (CMS). CMSException objects contain an error code, an error message, and an optional detailed message.

The code field stores one of the CMSExceptionCode constants to indicate the error condition. Arbortext defines the error codes.

The message field contains a human-readable description of the error. These messages should be localized.

The detail field contains an in-depth description of the error that may be written to a log. The description could be something like a Java stack trace or a detailed error description provided by the CMS. Detailed error descriptions do not need to be localized.

Since:

Epic 5.2

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final short	ADAPTER_ALREADY_REGISTERED_ERR	An adapter with the same qualified name has already been registered.
static final short	ADAPTER_INIT_FAILED_ERR	Adapter failed to initialize.
static final short	ADAPTER_LOAD_FAILED_ERR	Adapter failed to load.
static final short	BAD_ARG_ERR	Invalid argument.
static final short	BAD_EXTENSION_ERR	Extension operation does not exist.
static final short	CANT_ALLOC_ERR	Can't allocate resource.
static final short	CANT_CONNECT_ERR	Error connecting.
static final short	CANT_CREATE_ERR	Can't create object.
static final short	CANT_DISCONNECT_ERR	Error disconnecting.
static final short	CANT_FIND_SYM_ERR	Can't find program symbol.
static final short	CANT_INIT_ERR	Adapter initialization failed.
static final short	CANT_LOCK_ERR	Can't lock object.
static final short	CANT_LOGIN_ERR	Invalid login.
static final short	CANT_OPEN_ERR	Can't open object.
static final short	CANT_UNLOCK_ERR	Can't unlock object.
final short	code
static final short	CONTAINER_ERR	Object is a container.
static final short	DECLS_LOCKED_ERR	Declarations are locked by another user.
final String	detail
static final short	FAIL_ERR	General failure.
static final short	FOLDER_ERR	Object is a folder.
static final short	INVALID_ATTR_ERR	Attribute value is invalid.
static final short	INVALID_CMSADAPTER_ERR	CMSAdapter object is invalid (adapter may have been unloaded).
static final short	INVALID_CMSOBJECT_ERR	CMSObject object is invalid (session may have been disconnected or document may have been closed).
static final short	INVALID_CMSSESSION_ERR	CMSSession object is invalid (session may have been disconnected).
static final short	INVALID_LOGID_ERR	Invalid logical ID format.
static final short	INVALID_POID_ERR	Invalid POID format.
static final short	INVOCATION_FAILED_ERR	Error invoking the adapter method.
static final short	INVOKE_FAILED_ERR	Adapter method call failed.
static final short	LEAF_ERR	Object is a leaf.
static final short	LOCKED_BY_OTHER_ERR	Object is locked by another.
static final short	LOCKED_BY_YOU_ERR	Object is already locked by locker.
static final short	LOG_ERR	Error opening a log output device.
static final short	NO_CONFIG_ERR	Error opening configuration file.
static final short	NO_LICENSE_ERR	Unable to obtain a license for the adapter.
static final short	NO_NESTED_TRANS_ERR	Adapter does not support nested transactions.
static final short	NO_SGML_INCLUDE_ERR	Xinclude cannot be used with SGML documents.
static final short	NOMORE_ERR	No more entries.
static final short	NOT_CONTAINER_ERR	Object is not a container.
static final short	OBJECT_NOT_FOUND_ERR	Object doesn't exist.
static final short	OPERATION_CANCELED_ERR	Operation was canceled.
static final short	OPERATION_NOT_ENABLED_ERR	Method cannot be called in the current state.
static final short	PARENT_UNLOCKED_ERR	Operation failed because parent is not locked.
static final short	PARSE_ERR	Parse error.
static final short	READ_ONLY_ERR	Object is read-only.
static final short	RESOURCE_ERR	Out of resource.
static final short	SESS_PREFIX_EXISTS_ERR	Connection already established for this session.
static final short	STILL_CONNECTED_ERR	Session still connected.
static final short	TOO_MANY_ADAPTERS_ERR	No more adapters can be registered.
static final short	TOO_MANY_SESSIONS_ERR	Too many open connections.
static final short	UNIMP_ERR	Unimplemented operation.
static final short	UNLOCK_ERR	Object is locked.
static final short	UNSUP_ATTR_ERR	Unsupported attribute.
static final short	UNSUP_PROTO_ERR	This version of the adapter is not supported.

Constructor Summary

Constructors

Constructor	Description
CMSException(short code)
CMSException(short code, String message)
CMSException(short code, String message, String detail)

Method Summary

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

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

Field Details

code

public final short code

detail

public final String detail

NO_NESTED_TRANS_ERR

public static final short NO_NESTED_TRANS_ERR

Adapter does not support nested transactions.

See Also:

• Constant Field Values

INVALID_POID_ERR

public static final short INVALID_POID_ERR

Invalid POID format.

See Also:

• Constant Field Values

INVALID_LOGID_ERR

public static final short INVALID_LOGID_ERR

Invalid logical ID format.

See Also:

• Constant Field Values

INVOKE_FAILED_ERR

public static final short INVOKE_FAILED_ERR

Adapter method call failed.

See Also:

• Constant Field Values

BAD_EXTENSION_ERR

public static final short BAD_EXTENSION_ERR

Extension operation does not exist.

See Also:

• Constant Field Values

NO_LICENSE_ERR

public static final short NO_LICENSE_ERR

Unable to obtain a license for the adapter.

See Also:

• Constant Field Values

OBJECT_NOT_FOUND_ERR

public static final short OBJECT_NOT_FOUND_ERR

Object doesn't exist.

See Also:

• Constant Field Values

NO_CONFIG_ERR

public static final short NO_CONFIG_ERR

Error opening configuration file.

See Also:

• Constant Field Values

UNSUP_PROTO_ERR

public static final short UNSUP_PROTO_ERR

This version of the adapter is not supported.

See Also:

• Constant Field Values

STILL_CONNECTED_ERR

public static final short STILL_CONNECTED_ERR

Session still connected.

See Also:

• Constant Field Values

CANT_CONNECT_ERR

public static final short CANT_CONNECT_ERR

Error connecting.

See Also:

• Constant Field Values

CANT_DISCONNECT_ERR

public static final short CANT_DISCONNECT_ERR

Error disconnecting.

See Also:

• Constant Field Values

CANT_LOGIN_ERR

public static final short CANT_LOGIN_ERR

Invalid login.

See Also:

• Constant Field Values

CANT_INIT_ERR

public static final short CANT_INIT_ERR

Adapter initialization failed.

See Also:

• Constant Field Values

CANT_ALLOC_ERR

public static final short CANT_ALLOC_ERR

Can't allocate resource.

See Also:

• Constant Field Values

NO_SGML_INCLUDE_ERR

public static final short NO_SGML_INCLUDE_ERR

Xinclude cannot be used with SGML documents.

See Also:

• Constant Field Values

PARENT_UNLOCKED_ERR

public static final short PARENT_UNLOCKED_ERR

Operation failed because parent is not locked.

See Also:

• Constant Field Values

OPERATION_CANCELED_ERR

public static final short OPERATION_CANCELED_ERR

Operation was canceled.

See Also:

• Constant Field Values

DECLS_LOCKED_ERR

public static final short DECLS_LOCKED_ERR

Declarations are locked by another user.

See Also:

• Constant Field Values

UNSUP_ATTR_ERR

public static final short UNSUP_ATTR_ERR

Unsupported attribute.

See Also:

• Constant Field Values

NOMORE_ERR

public static final short NOMORE_ERR

No more entries.

See Also:

• Constant Field Values

UNLOCK_ERR

public static final short UNLOCK_ERR

Object is locked.

See Also:

• Constant Field Values

PARSE_ERR

public static final short PARSE_ERR

Parse error.

See Also:

• Constant Field Values

RESOURCE_ERR

public static final short RESOURCE_ERR

Out of resource.

See Also:

• Constant Field Values

FOLDER_ERR

public static final short FOLDER_ERR

Object is a folder.

See Also:

• Constant Field Values

READ_ONLY_ERR

public static final short READ_ONLY_ERR

Object is read-only.

See Also:

• Constant Field Values

LEAF_ERR

public static final short LEAF_ERR

Object is a leaf.

See Also:

• Constant Field Values

CONTAINER_ERR

public static final short CONTAINER_ERR

Object is a container.

See Also:

• Constant Field Values

CANT_CREATE_ERR

public static final short CANT_CREATE_ERR

Can't create object.

See Also:

• Constant Field Values

CANT_UNLOCK_ERR

public static final short CANT_UNLOCK_ERR

Can't unlock object.

See Also:

• Constant Field Values

CANT_LOCK_ERR

public static final short CANT_LOCK_ERR

Can't lock object.

See Also:

• Constant Field Values

CANT_OPEN_ERR

public static final short CANT_OPEN_ERR

Can't open object.

See Also:

• Constant Field Values

BAD_ARG_ERR

public static final short BAD_ARG_ERR

Invalid argument.

See Also:

• Constant Field Values

UNIMP_ERR

public static final short UNIMP_ERR

Unimplemented operation.

See Also:

• Constant Field Values

FAIL_ERR

public static final short FAIL_ERR

General failure.

See Also:

• Constant Field Values

NOT_CONTAINER_ERR

public static final short NOT_CONTAINER_ERR

Object is not a container.

See Also:

• Constant Field Values

LOCKED_BY_YOU_ERR

public static final short LOCKED_BY_YOU_ERR

Object is already locked by locker.

See Also:

• Constant Field Values

LOCKED_BY_OTHER_ERR

public static final short LOCKED_BY_OTHER_ERR

Object is locked by another.

See Also:

• Constant Field Values

TOO_MANY_SESSIONS_ERR

public static final short TOO_MANY_SESSIONS_ERR

Too many open connections.

See Also:

• Constant Field Values

TOO_MANY_ADAPTERS_ERR

public static final short TOO_MANY_ADAPTERS_ERR

No more adapters can be registered.

See Also:

• Constant Field Values

SESS_PREFIX_EXISTS_ERR

public static final short SESS_PREFIX_EXISTS_ERR

Connection already established for this session.

See Also:

• Constant Field Values

ADAPTER_INIT_FAILED_ERR

public static final short ADAPTER_INIT_FAILED_ERR

Adapter failed to initialize.

See Also:

• Constant Field Values

CANT_FIND_SYM_ERR

public static final short CANT_FIND_SYM_ERR

Can't find program symbol.

See Also:

• Constant Field Values

ADAPTER_LOAD_FAILED_ERR

public static final short ADAPTER_LOAD_FAILED_ERR

Adapter failed to load.

See Also:

• Constant Field Values

INVALID_ATTR_ERR

public static final short INVALID_ATTR_ERR

Attribute value is invalid.

See Also:

• Constant Field Values

INVOCATION_FAILED_ERR

public static final short INVOCATION_FAILED_ERR

Error invoking the adapter method.

See Also:

• Constant Field Values

LOG_ERR

public static final short LOG_ERR

Error opening a log output device.

See Also:

• Constant Field Values

INVALID_CMSADAPTER_ERR

public static final short INVALID_CMSADAPTER_ERR

CMSAdapter object is invalid (adapter may have been unloaded).

See Also:

• Constant Field Values

INVALID_CMSSESSION_ERR

public static final short INVALID_CMSSESSION_ERR

CMSSession object is invalid (session may have been disconnected).

See Also:

• Constant Field Values

INVALID_CMSOBJECT_ERR

public static final short INVALID_CMSOBJECT_ERR

CMSObject object is invalid (session may have been disconnected or document may have been closed).

See Also:

• Constant Field Values

ADAPTER_ALREADY_REGISTERED_ERR

public static final short ADAPTER_ALREADY_REGISTERED_ERR

An adapter with the same qualified name has already been registered.

See Also:

• Constant Field Values

OPERATION_NOT_ENABLED_ERR

public static final short OPERATION_NOT_ENABLED_ERR

Method cannot be called in the current state. Some adapters support more than one mode, such as online versus offline editing, and not all operations are allowed in every mode. For example, you might not be able to create new CMS folders while working offline.

See Also:

• Constant Field Values

Constructor Details

CMSException

public CMSException(short code,
 String message,
 String detail)

CMSException

public CMSException(short code,
 String message)

CMSException

public CMSException(short code)