TFORMer SDK - JAVA  7.0
Public Member Functions | Static Public Attributes
TFormerException Class Reference

This class implements exceptions that are thrown by the native TFORMer DLL. More...

List of all members.

Public Member Functions

 TFormerException (String sMessage)
 Constructor with text message.
 TFormerException (String sMessage, Throwable cause)
 Constructor with text message and original exception.
 TFormerException (String sMessage, int nErrorCode)
 Constructor with text message and error code.
 TFormerException (String code, String description, String information, String sourceReference)
 Constructor with all information available from TFORMer SDK.
long getErrorCode ()
 Returns the internal error code of the TFORMer SDK.
String getInformation ()
 Returns the description of the error.
String getSourceReference ()
 Returns the source reference of the error.
String getWin32ErrorCode ()
 Returns the internal error code of the TFORMer SDK.
boolean isErrorCodeSet ()
 Tests if this is an internal error code of the TFORMer SDK.

Static Public Attributes

static final long ERR_ELEMENT_NOT_FOUND = 2147647531L
 Element not found (0x8002802B).
static final long ERR_OBJECT_NOT_FOUND = 4312
 Object not found.
static final long ERR_OK = 0
 The error code for "no error".

Detailed Description

This class implements exceptions that are thrown by the native TFORMer DLL.


Constructor & Destructor Documentation

TFormerException ( String  sMessage)

Constructor with text message.

Parameters:
sMessageError message text
TFormerException ( String  sMessage,
Throwable  cause 
)

Constructor with text message and original exception.

Parameters:
sMessageError message text
causeOriginal exception
TFormerException ( String  sMessage,
int  nErrorCode 
)

Constructor with text message and error code.

@param sMessage
       error message text
@param nErrorCode
       TFORMer error code
Deprecated:
Use TFormerException(String, String, String, String) instead}
TFormerException ( String  code,
String  description,
String  information,
String  sourceReference 
)

Constructor with all information available from TFORMer SDK.

Parameters:
codeError code in hexadecimal format
descriptionDescription of the error in TFORMer library
informationAdditional information of the error in TFORMer library
sourceReferenceReferences of the error in the TFORMer source library

Member Function Documentation

long getErrorCode ( )

Returns the internal error code of the TFORMer SDK.

Returns:
Internal error code
String getInformation ( )

Returns the description of the error.

This method returns the value of the function GetLastErrorInformation of the TFORMer SDK

Returns:
null if this information is unavailable
String getSourceReference ( )

Returns the source reference of the error.

This method returns the value of the function GetLastErrorSource of the TFORMer SDK

Returns:
null if this information is unavailable
String getWin32ErrorCode ( )

Returns the internal error code of the TFORMer SDK.

Returns:
Internal error code
boolean isErrorCodeSet ( )

Tests if this is an internal error code of the TFORMer SDK.

Returns:
true for an internal error code, otherwise false
See also:
getErrorCode()

© 2006-2012 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Tue Oct 23 2012 16:33:20 for TFORMer SDK - JAVA with doxygen 1.8.0