|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.lang.Throwable | +--java.lang.Exception | +--com.candle.roma.kxc.RomaError
This class introduces Roma errors. It completely reflects the structure of error information Roma API. The get methods are public, for use by application. The set functions have package visibility for use by RomaExceptionMessage
RomaExceptionMessage
,
RomaErrorInformation
, Serialized FormConstructor Summary | |
RomaError()
Constructs a new RomaError with no additional information. |
Method Summary | |
java.lang.String |
additionalInfo(int errorSubclass)
Returns the additional information if an error has occurred. |
boolean |
anyError()
Returns true if an error is set |
int |
compCode(int errorSubclass)
Returns either the completion code of the error or else the code Roma.CC_OK if no error information is available. |
java.lang.String |
errorText(int errorSubclass,
int errorFormat)
Returns the error string if an error has occurred. |
int |
errorType(int errorSubclass)
Returns either the error type code of the error or else 0 if no error information is available. |
int |
operationType(int errorSubclass)
If an error occurred, returns the operation type of the API call. |
int |
position(int errorSubclass)
Returns the position if an error has occurred. |
int |
reason(int errorSubclass)
Returns either the reason code of the error or else 0 if no error information is available. |
int |
returnCode(int errorSubclass)
Returns the return code |
int |
status()
Returns the error 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 |
public RomaError()
Method Detail |
public boolean anyError()
public int compCode(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public int returnCode(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public int reason(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public int errorType(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public int operationType(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public int position(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public java.lang.String additionalInfo(int errorSubclass)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.public java.lang.String errorText(int errorSubclass, int errorFormat)
errorSubclass
- Roma.PRIMARY_INFO - return primary info.
Roma.SECONDARY_INFO - return secondary info.errorFormat
- Roma.ERROR_TEXT_FULL
Roma.ERROR_TEXT_COMPACTpublic int status()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |