public abstract class CMIPRespMessage extends CMIPMessage
actionType, efilterId, efilterScope, flatAttrids, flatAttrs, flatEfilter, flatIfilter, ifilterId, ifilterScope, MAX_ERRS, msgAttrids, msgAttrs, msgEfilter, msgErrs, msgErrType, msgHdrAttrs, msgIfilter, msgInstance, msgLinkid, msgMaxMsgs, msgMode, msgObjClass, msgPacking, msgScope, msgSynch, msgTime, msgTree, msgType
Constructor and Description |
---|
CMIPRespMessage() |
CMIPRespMessage(Attribute instance) |
CMIPRespMessage(java.lang.String instanceId) |
Modifier and Type | Method and Description |
---|---|
boolean |
domainError(int n)
Does the nth error (where n is 1, 2 or 3) correspond to an entry in the MIB error table?
|
int |
getError(int n)
Get the nth error, where n is 1, 2 or 3.
|
java.lang.String |
getErrorDescription(int n)
Get the error description from the error table.
|
java.lang.String |
getErrorName(int n)
Get the error name from the error table.
|
int |
getReturnCode()
Get the return code.
|
java.lang.String |
getReturnCodeDescription()
Get the return code's description.
|
java.lang.String |
getReturnCodeName()
Get the return code's name.
|
void |
setError(int n,
int err)
Set an error code.
|
void |
setError(int n,
java.lang.String code)
Set an error code.
|
void |
setReturnCode(int code)
Set the return code.
|
void |
setReturnCode(java.lang.String code)
Set the return code.
|
java.lang.String |
toString() |
addHdrAttr, addHdrAttrOct, clear, flattenAttrs, getInstance, getInstanceId, getLinkid, getMessageType, getObjClass, getObjClassString, getTime, getVersion, isLast, last, reset, restore, save, setInstance, setInstanceId, setLinkid, setObjClass, setObjClassString, setTime, unflattenAttrs
public CMIPRespMessage()
public CMIPRespMessage(Attribute instance)
public CMIPRespMessage(java.lang.String instanceId)
public boolean domainError(int n)
n
- The ordinal number of the error.public int getError(int n)
n
- The ordinal number of the error.public java.lang.String getErrorDescription(int n) throws java.lang.IllegalArgumentException
n
- Get the nth error, where n is 1, 2 or 3.java.lang.IllegalArgumentException
- The index is out of bounds.public java.lang.String getErrorName(int n) throws java.lang.IllegalArgumentException
n
- Get the nth error, where n is 1, 2 or 3.java.lang.IllegalArgumentException
- The index is out of bounds.public int getReturnCode()
public java.lang.String getReturnCodeDescription()
public java.lang.String getReturnCodeName()
public void setError(int n, int err) throws java.lang.IllegalArgumentException
n
- The ordinal number of the error (1, 2 or 3).err
- The error code.java.lang.IllegalArgumentException
- The index is out of bounds.public void setError(int n, java.lang.String code) throws java.lang.IllegalArgumentException
n
- The index of the error (0, 1, 2 or 3).code
- The error code (eg,"tt.CustomerNotFound").java.lang.IllegalArgumentException
- The error was not found in the MIB error table, or the error index is out of bounds.public void setReturnCode(int code)
code
- The return code. This is not recommended usage.setReturnCode(String)
public void setReturnCode(java.lang.String code) throws java.lang.IllegalArgumentException
code
- The return code (eg,"DSAP.MSUCCESS").java.lang.IllegalArgumentException
- The error was not found in the MIB error table.public java.lang.String toString()
toString
in class CMIPMessage