FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Class BaseException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.filenet.wcm.api.BaseException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
PropertyNotFoundException, UntrustedCredentialsException

public class BaseException
extends java.lang.Exception

This is a checked exception class from which other CS Java Connector checked exceptions are inherited.

See Also:
Serialized Form

Constructor Summary
BaseException()
           
BaseException(java.lang.String s)
           
BaseException(java.lang.String s, int faultCode)
           
BaseException(java.lang.String s, java.lang.Integer faultCode)
           
 
Method Summary
 int getFaultCode()
          Returns the fault code, if any.
 void setFaultCode(int faultCode)
          Internal use only.
 java.lang.String toString()
          Returns the fault code, if any, appended to the returned String.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BaseException

public BaseException()

BaseException

public BaseException(java.lang.String s)

BaseException

public BaseException(java.lang.String s,
                     int faultCode)

BaseException

public BaseException(java.lang.String s,
                     java.lang.Integer faultCode)
Method Detail

getFaultCode

public int getFaultCode()
Returns the fault code, if any.

Some exception types have an affiliated numeric code to indicate that a specific problem has occurred. For example, exceptions thrown as a result of problems on the Content Services server typically propagate a SPI status code that a caller can access via this method. SPI status codes and severity levels of the codes are defined in the ContentEngineException class.

Returns:
An int fault code, if any. A value of 0 means no fault code has been set. (Note that a value of 0 does not mean that no fault has occurred.)

setFaultCode

public void setFaultCode(int faultCode)
Internal use only. This method is used internally by the API to propagate the fault code.


toString

public java.lang.String toString()
Returns the fault code, if any, appended to the returned String.

Returns:
A String that includes the fault code, if any.

FileNet Content Services
Java Connector v3.0