de.innovationgate.webgate.api

Class WGAPIException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.innovationgate.webgate.api.WGException

de.innovationgate.webgate.api.WGAPIException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticationException, ConfigurationException, LockException, ServerConnectionException, WGAuthorisationException, WGBackendException, WGCancelledException, WGClosedSessionException, WGConfigurationException, WGContentStoreVersionException, WGCreationException, WGDeletedException, WGDocumentDoesNotExistException, WGDuplicateKeyException, WGExpressionException, WGHierarchicalDatabaseEventException, WGIllegalArgumentException, WGIllegalStateException, WGInvalidDatabaseException, WGMailException, WGProcedureException, WGQueryException, WGRestrictionException, WGSchemaValidationException, WGSystemException, WGUnavailableException, WGWrongRevisionException

public class WGAPIException
extends WGException

Root class for all exceptions thrown by the WGAPI.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WGAPIException(java.lang.String msg)
WGAPIException(java.lang.String msg, java.lang.String code)
WGAPIException(java.lang.String msg, java.lang.String code, WGDocumentKey causeDocument)
WGAPIException(java.lang.String msg, java.lang.Throwable cause)
WGAPIException(java.lang.String msg, WGDocumentKey causeDocument)
WGAPIException(java.lang.Throwable cause)

Method Summary

Methods

Modifier and Type	Method and Description
WGDocumentKey	getCauseDocumentKey()
java.lang.String	getErrorCode() Returns An error code identifying the error type.

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

Constructor Detail

WGAPIException

public WGAPIException(java.lang.String msg)

WGAPIException

public WGAPIException(java.lang.Throwable cause)

WGAPIException

public WGAPIException(java.lang.String msg,
              java.lang.Throwable cause)

WGAPIException

public WGAPIException(java.lang.String msg,
              WGDocumentKey causeDocument)

WGAPIException

public WGAPIException(java.lang.String msg,
              java.lang.String code)

WGAPIException

public WGAPIException(java.lang.String msg,
              java.lang.String code,
              WGDocumentKey causeDocument)

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Returns An error code identifying the error type. Usable to lookup localized error messages or react on individual error types.

getCauseDocumentKey

public WGDocumentKey getCauseDocumentKey()