com.candle.roma.kxc
Class RomaError

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.candle.roma.kxc.RomaError
All Implemented Interfaces:
Roma, java.io.Serializable

public class RomaError
extends java.lang.Exception
implements Roma

This class represents Roma error information.

See Also:
Serialized Form

Fields inherited from interface com.candle.roma.kxc.Roma
ACTION_ALERT, ACTION_DEFAULT, ACTION_EMS, ACTION_EMSRAW, ACTION_LOG, ACTION_NOACTION, ACTION_NOTIFY, ACTION_RESET, ACTION_SYSLOG, ADVISORY, ANY_THEME, APP_EXCLUSIVE, APP_MQSERIES_FASTPATH, APP_MQSERIES_XACTION, APP_NON_XACTIONAL, APP_NONE, APP_ROLLBK_OS_XACT, APPTYPE_BRIDGE, APPTYPE_CLIENT, APPTYPE_NATIVE_CLIENT, APPTYPE_NATIVE_SERVER, APPTYPE_SERVER, APPTYPE_UNKNOWN, BACKOUT_UNSUPPORTED, BY_CORRELID, BY_MSGID, BY_MSGID_AND_CORRELID, BY_MSGID_AND_THEME, BY_NONE, BY_THEME, CALLTYPE_APPLICATION, CALLTYPE_BRIDGEGET, CALLTYPE_BRIDGEPUT, CALLTYPE_BUILDTHEME, CALLTYPE_CLOSEHANDLE, CALLTYPE_CLOSESTORAGEQ, CALLTYPE_COMMIT, CALLTYPE_DELETESTORAGEQ, CALLTYPE_DIRDELETEITEM, CALLTYPE_DIRGETDN, CALLTYPE_DIRGETMODCOUNT, CALLTYPE_DIRLOOKUP, CALLTYPE_DIRSETACCESS, CALLTYPE_DIRUPDATEITEM, CALLTYPE_FREEBUFFER, CALLTYPE_GETBUFFER, CALLTYPE_GETERROR, CALLTYPE_GETFROMSTORAGEQ, CALLTYPE_GETILSDATA, CALLTYPE_GETREQUEST, CALLTYPE_GETRESPONSE, CALLTYPE_INITIALIZE, CALLTYPE_INTERPRETMSG, CALLTYPE_NUMCALLS, CALLTYPE_OPENSTORAGEQ, CALLTYPE_PURGEQTOEMS, CALLTYPE_PUTEXCEPTION, CALLTYPE_PUTREQUEST, CALLTYPE_PUTRESPONSE, CALLTYPE_PUTTOSTORAGEQ, CALLTYPE_QMGRCONNECT, CALLTYPE_QUERY, CALLTYPE_QUERYCONTEXT, CALLTYPE_QUERYTHEME, CALLTYPE_REPORTERROR, CALLTYPE_ROLLBACK, CALLTYPE_SENDALERT, CALLTYPE_SETILSDATA, CALLTYPE_SETLDAPSERVICE, CALLTYPE_TERMINATE, CALLTYPE_WRITELOG, CALLTYPE_WRITESYSLOG, CALLTYPE_XPORTDATA, CC_FAILED, CC_OK, CC_WARNING, CODEPAGE_PROFILE, CODEPAGE_USER, CONFIRM_ARRIVAL, CONFIRM_DELIVERY, DATAGRAM, ELEMENT_ALL_GET, ELEMENT_ALL_PUT, ELEMENT_CONFIG, ELEMENT_ERROR, ELEMENT_MESSAGE, ELEMENT_NONE, ELEMENT_SYSCONFIG, ELEMENT_TIMESTAMP, ELEMENT_USERDATA, ELEMENT_WORKFLOW, ENCODING_DEFAULT, ENCODING_NORMAL, ENCODING_PROFILE, ENCODING_REVERSED, ENVOS_AIX, ENVOS_DUX, ENVOS_HPUX102, ENVOS_HPUX11, ENVOS_MVSBATCH, ENVOS_MVSCICS, ENVOS_OS400, ENVOS_SUN, ENVOS_WIN95, ENVOS_WINNT, ENVTYPE_INTEL, ENVTYPE_MVS, ENVTYPE_OS400, ENVTYPE_UNIX, ENVTYPE_VMS, ERROR_COMPACT, ERROR_FULL, ERROR_STATUS_BOTH, ERROR_STATUS_MAIN, ERROR_STATUS_NONE, ERROR_STATUS_PRIMARY, ERROR_TEXT_COMPACT, ERROR_TEXT_FULL, ETYPE_API, ETYPE_CRITICAL, ETYPE_ERROR, ETYPE_TRANSIENT, EXACTMATCH, EXPIRY_NEVER, EXPIRY_PROFILE, FORCE, FORMAT_BINARY, FORMAT_BINARY_ENC, FORMAT_BINARY_SIGN, FORMAT_BINARY_SIGN_ENC, FORMAT_HEXDUMP, FORMAT_NONE, FORMAT_NOSEVERITY, FORMAT_NOTIMESTAMP, FORMAT_PROFILE, FORMAT_STRING, FORMAT_STRING_ENC, FORMAT_STRING_SIGN, FORMAT_STRING_SIGN_ENC, FORMAT_USENAME, FORMAT_USER, GET_FIRST, GET_PEEKED, GOWAIT_INDEFINITE, GOWAIT_PROFILE, ILS_TYPE_ERROR, ILS_TYPE_ROUTER, ILS_TYPE_SYSMGMT, ILS_TYPE_USER, ILS_TYPE_WEB, ILS_TYPE_XPORT, ILS_TYPE_XPTDATA, INTMSG_THEME, MAX_LEN, MAX_TAGLEN, MUST_EXIST, MUST_NOT_EXIST, NEGATIVE_COA, NEGATIVE_COD, NEGATIVE_PUBSUB, NOTIFICATION, ONELEVEL, OP_BMQ, OP_CICS, OP_CTLIB, OP_KXC, OP_LDAP, OP_LDIF, OP_LIB, OP_MQSERIES, OP_MQSI, OP_MSMQ, OP_OS, OP_RPC, OP_TIB, OP_USER, OPEN_DEFAULT, OPEN_DELETE_ON_CLOSE, OPEN_EXCLUSIVE, OPEN_INPUT, OPEN_MUST_EXIST, OPEN_NON_XACTIONAL, OPEN_OUTPUT, OPEN_PEEK, PEEK_FIRST, PEEK_NEXT, PEEK_SAME, PERSISTENCE_NO, PERSISTENCE_PROFILE, PERSISTENCE_YES, POSITIVE_COA, POSITIVE_COD, POSITIVE_PUBSUB, PRIMARY_INFO, PRIORITY_DEFAULT, PRIORITY_PROFILE, PS_NONE, PUB_RETAIN, PUBLICATION, RC_ACCESS_DENIED, RC_BACKED_OUT, RC_BRIDGE_UNAVAILABLE, RC_BUFFER_ERROR, RC_BUFFER_EXISTS, RC_BUFFER_OVERFLOW, RC_BUFFER_TOO_SMALL, RC_CACHE_FAILURE, RC_CALL_IN_PROGRESS, RC_CANNOT_REDEFINE_DIR_ACCESS, RC_CICS_CALL_ABANDONED, RC_CICS_COMMAND_TIMEOUT, RC_CICS_COMMIT_ROLLBACK, RC_CICS_CONN_QUIESCE, RC_CICS_EXEC_WAIT_ERROR, RC_CICS_GETMAIN_FAILURE, RC_CICS_GETSIG_FAIL, RC_CICS_INVALID_POSTCODE, RC_CICS_KXCCCDIR_UNAVAILABLE, RC_CICS_KXCCTPI_UNAVAILABLE, RC_CICS_NO_TCTLS, RC_CICS_QMGR_QUIESCE, RC_CICS_TRUE_INACTIVE, RC_CICS_WAITFAIL, RC_CMQI_CALL_ABANDONED, RC_CONFIG_ERROR, RC_CONTEXT_MISMATCH, RC_DELETE_FAILED, RC_DIRECTORY_UNAVAILABLE, RC_EXCEPTION_CAUGHT, RC_EXIT_FAILURE, RC_FASTPATH_ERROR, RC_GET_ATTRIBUTE_FAILURE, RC_HANDLE_BROKEN, RC_INVALID_APPDEF, RC_INVALID_COMPONENT, RC_INVALID_CONTEXT, RC_INVALID_ELEMENT, RC_INVALID_FILENAME, RC_INVALID_HANDLE, RC_INVALID_MESSAGE, RC_INVALID_MSGTYPE, RC_INVALID_OPTIONS, RC_INVALID_PARAMETER, RC_INVALID_QNAME, RC_INVALID_RESPONSE, RC_INVALID_ROUTE, RC_INVALID_SECURITY, RC_INVALID_SERVERNAME, RC_INVALID_SERVICE, RC_INVALID_SYNCTYPE, RC_INVALID_THEME, RC_INVALID_TRAILER, RC_LDAP_ADD_FAILURE, RC_LDAP_BIND_FAILURE, RC_LDAP_CONNECTION_LOST, RC_LDAP_COUNT_ENTRIES_FAILURE, RC_LDAP_DELETE_FAILURE, RC_LDAP_EXPORT_FAILURE, RC_LDAP_FIRST_ENTRY_FAILURE, RC_LDAP_GET_DN_FAILURE, RC_LDAP_GET_FAILURE, RC_LDAP_GET_VALUES_FAILURE, RC_LDAP_IMPORT_FAILURE, RC_LDAP_INVALID_GATEWAY, RC_LDAP_INVALID_RECORD, RC_LDAP_MODCOUNT_FAILURE, RC_LDAP_MODIFY_FAILURE, RC_LDAP_MODRDN_FAILURE, RC_LDAP_MSGFREE_FAILURE, RC_LDAP_NEXT_ENTRY_FAILURE, RC_LDAP_OPEN_FAILURE, RC_LDAP_SEARCH_FAILURE, RC_LDAP_UNBIND_FAILURE, RC_LDAP_VALUE_FREE_FAILURE, RC_LDIF_ADD_FAILURE, RC_LDIF_CORRELID_NOT_SUPPORTED, RC_LDIF_COUNT_ENTRIES_FAILURE, RC_LDIF_DELETE_FAILURE, RC_LDIF_GET_DN_FAILURE, RC_LDIF_GET_FAILURE, RC_LDIF_GET_VALUES_FAILURE, RC_LDIF_INVALID_ATTR_FAILURE, RC_LDIF_INVALID_GATEWAY, RC_LDIF_INVALID_PS_OPTIONS, RC_LDIF_INVALID_SUBJECT, RC_LDIF_MODIFY_FAILURE, RC_LDIF_MSGID_NOT_SUPPORTED, RC_LDIF_NEXT_ENTRY_FAILURE, RC_LDIF_OPEN_FAILURE, RC_LDIF_PERSISTENCE_NOT_SUPPORTED, RC_LDIF_RENAME_FAILURE, RC_LDIF_SEARCH_FAILURE, RC_LDIF_THREAD_INIT_FAILURE, RC_MARSHALLING_ERROR, RC_MESSAGE_SUPPRESSED, RC_MSG_UNAVAILABLE, RC_MUTEX_FAILURE, RC_NO_AVAILABLE_ELEMENT, RC_NO_DATA_AVAILABLE, RC_NO_MSG_AVAILABLE, RC_NON_LOCALQ, RC_NONXACTIONAL, RC_NOT_ACCESSIBLE, RC_NOT_SUPPORTED, RC_OK, RC_PEEK_NOT_SUPPORTED, RC_Q_DELETED, RC_Q_FULL, RC_RESOURCE_PROBLEM, RC_ROUTING_FAILURE, RC_SIGNAL_ACCEPTED, RC_SIGNAL_INVALID, RC_SIGNAL_OUTSTANDING, RC_STORAGE_FAILURE, RC_SYSCONFIG_FAILURE, RC_TRANSFORM_DISALLOWED, RC_TRANSPORT_FAILURE, RC_TRANSPORT_UNAVAILABLE, RC_UNKNOWN_BRIDGE, RC_UNKNOWN_CLIENT, RC_UNKNOWN_ERRPROFILE, RC_UNKNOWN_GETPROFILE, RC_UNKNOWN_INITPROFILE, RC_UNKNOWN_MSGFORMAT, RC_UNKNOWN_NODE, RC_UNKNOWN_OBJECT, RC_UNKNOWN_PUTPROFILE, RC_UNKNOWN_SERVER, RC_UNKNOWN_SERVICE, RC_UPDATE_FAILED, RC_VALIDATION_FAILED, RC_WAIT_CANCELLED, REQUEST, RESPONSE, ROUTEFLAG_NOTRANSFORM, ROUTEFLAG_RESTRICTED, ROUTEFLAG_XML_ILS, SECONDARY_INFO, SELECTOR, SEV_ERROR, SEV_INFO, SEV_SEVERE, SEV_WARNING, STATUS_AUTHENTICATED, STATUS_NATIVE, STATUS_NONE, STATUS_OK_TO_NOTIFY, STATUS_OK_TO_RESPOND, STYLE_MQSERIES, STYLE_ROMA, STYLE_TIBRENDEZVOUS, SUB_NEWPUBS, SUB_ONREQ, SUBCLASS_PRIMARY, SUBCLASS_SECONDARY, SUBTREE, SYNC_GLOBAL, SYNC_LOCAL, SYNC_NONE, SYNC_PROFILE, THEME_CLOSE, THEME_CONTROL, THEME_DEFAULT_CONTROL, THEME_RETAIN, THEME_USAGE, THEMEINFO_ALL, THEMEINFO_CONFIRMFLAGS, THEMEINFO_ETEINFO, THEMEINFO_RETRYCOUNT, THEMEINFO_THEMEID, THEMEINFO_TRAILERS, THEMEINFO_WORKFLOW, USE_CORRELID, USE_MSGID, USE_MSGID_AND_CORRELID, USE_NO_BASE, USE_NONE, USE_ROMA_BASE, XPORT_MQSERIES, XPORT_MSMQ, XPORT_TIB
 
Constructor Summary
RomaError()
          Constructs a new RomaError with no additional information.
 
Method Summary
 java.lang.String additionalInfo(int errorSubclass)
           
 boolean anyError()
           
 int compCode(int errorSubclass)
           
 java.lang.String errorText(int errorSubclass, int errorFormat)
           
 int errorType(int errorSubclass)
           
 int operationType(int errorSubclass)
           
 int position(int errorSubclass)
           
 int reason(int errorSubclass)
           
 int returnCode(int errorSubclass)
           
 int status()
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RomaError

public RomaError()
Constructs a new RomaError with no additional information.
Method Detail

anyError

public boolean anyError()
Returns:
true if error information is set.

compCode

public int compCode(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
One of the Roma.CC_* constants.

returnCode

public int returnCode(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
One of the Roma.RC_* constants.

reason

public int reason(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
Either a reason code of the error or 0 if no error information is available.

errorType

public int errorType(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
One of the Roma.ETYPE_* constants or 0 if no error information is available.

operationType

public int operationType(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
One of the Roma.OP_* constants.

position

public int position(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
A position where the error has occured.

additionalInfo

public java.lang.String additionalInfo(int errorSubclass)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
Returns:
Additional error information.

errorText

public java.lang.String errorText(int errorSubclass,
                                  int errorFormat)
Parameters:
errorSubclass - either Roma.SUBCLASS_PRIMARY to access primary error information or Roma.SUBCLASS_SECONDARY to access secondary error information.
errorFormat - either Roma.ERROR_FULL to get a detailed error description or Roma.ERROR_COMPACT to get a brief error description.
Returns:
An error description.

status

public int status()
Returns:
One of the Roma.ERROR_STATUS_* constants.