com.ibm.workplace.wcm.api.exceptions
Class WCMException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.workplace.wcm.api.exceptions.WCMException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthorizationException, ComponentNotFoundException, DocumentCreationException, DocumentDeleteException, DocumentIdCreationException, DocumentNotFoundException, DocumentRetrievalException, DocumentSaveException, DuplicateChildException, DuplicateComponentException, DuplicateMappingException, IllegalDocumentTypeException, IllegalTypeChangeException, NoMoreWorkflowStagesException, OperationFailedException, PropertyRetrievalException, ServiceNotAvailableException

public abstract class WCMException

extends java.lang.Exception

The base Lotus Workplace Web Content Management API Exception.

See Also:

Serialized Form

Field Summary

static java.lang.String	COPYRIGHT Copyright statement
static int	ERR_APTRIX The default error code

Constructor Summary

WCMException(java.lang.String detail)
Constructor that requires detail

WCMException(java.lang.String detail, java.lang.Throwable cause)
Constructor that requires detail plus a cause exception

Method Summary

java.lang.Throwable	getCause() Retrieves the cause exception for this exception
int	getErrorCode() The error code for this exception.
java.lang.String	getMessage() Retrieves the message that accompanies this exception.
void	printStackTrace() Overridden to include cause
void	printStackTrace(java.io.PrintStream s) Overridden to include cause
void	printStackTrace(java.io.PrintWriter s) Overridden to include cause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

ERR_APTRIX

public static final int ERR_APTRIX

The default error code

See Also:

Constant Field Values

Constructor Detail

WCMException

public WCMException(java.lang.String detail)

Constructor that requires detail

Parameters:

detail - a message describing extra information about the exception

WCMException

public WCMException(java.lang.String detail,
                    java.lang.Throwable cause)

Constructor that requires detail plus a cause exception

Parameters:

detail - a message description extra information about the exception

cause - the exception that caused this exception

Method Detail

getMessage

public java.lang.String getMessage()

Retrieves the message that accompanies this exception. The message also includes the causes exception if there is a cause exception.

Returns:

the exception's message

getCause

public java.lang.Throwable getCause()

Retrieves the cause exception for this exception

Returns:

the cause exception or null if there was no cause exception.

getErrorCode

public int getErrorCode()

The error code for this exception.

Note:This implementation is the default error code for the AptrixException. Subclasses may override this for a more appropriate error number.

Returns:

the error code for this exception.

printStackTrace

public void printStackTrace()

Overridden to include cause

printStackTrace

public void printStackTrace(java.io.PrintStream s)

Overridden to include cause

printStackTrace

public void printStackTrace(java.io.PrintWriter s)

Overridden to include cause