com.idimiddleware.objectq

Class CMIPRespMessage

java.lang.Object

com.idimiddleware.objectq.Message

com.idimiddleware.objectq.CMIPMessage

com.idimiddleware.objectq.CMIPRespMessage

Direct Known Subclasses:

ActRespMessage, CrtRespMessage, DelRespMessage, EvrRespMessage, GetRespMessage, SetRespMessage

public abstract class CMIPRespMessage
extends CMIPMessage

CMIP Response message.

See Also:

RFC 1095

Field Summary

Fields inherited from class com.idimiddleware.objectq.Message

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 Summary

Constructors

Constructor and Description
CMIPRespMessage()
CMIPRespMessage(Attribute instance)
CMIPRespMessage(java.lang.String instanceId)

Method Summary

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()

Methods inherited from class com.idimiddleware.objectq.Message

addHdrAttr, addHdrAttrOct, clear, flattenAttrs, getInstance, getInstanceId, getLinkid, getMessageType, getObjClass, getObjClassString, getTime, getVersion, isLast, last, reset, restore, save, setInstance, setInstanceId, setLinkid, setObjClass, setObjClassString, setTime, unflattenAttrs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CMIPRespMessage

public CMIPRespMessage()

CMIPRespMessage

public CMIPRespMessage(Attribute instance)

CMIPRespMessage

public CMIPRespMessage(java.lang.String instanceId)

Method Detail

domainError

public boolean domainError(int n)

Does the nth error (where n is 1, 2 or 3) correspond to an entry in the MIB error table?

Parameters:

n - The ordinal number of the error.

Returns:

True if it does, false otherwise.

getError

public int getError(int n)

Get the nth error, where n is 1, 2 or 3.

Parameters:

n - The ordinal number of the error.

Returns:

The error, or 0 if n is out of bounds.

getErrorDescription

public java.lang.String getErrorDescription(int n)
                                     throws java.lang.IllegalArgumentException

Get the error description from the error table.

Parameters:

n - Get the nth error, where n is 1, 2 or 3.

Returns:

The description, if found, or null.

Throws:

java.lang.IllegalArgumentException - The index is out of bounds.

getErrorName

public java.lang.String getErrorName(int n)
                              throws java.lang.IllegalArgumentException

Get the error name from the error table.

Parameters:

n - Get the nth error, where n is 1, 2 or 3.

Returns:

The name, if found, or null.

Throws:

java.lang.IllegalArgumentException - The index is out of bounds.

getReturnCode

public int getReturnCode()

Get the return code. Recommended usage is that this be simply DSAP.MSUCCESS or DSAP.MFAIL.

Returns:

The return code.

getReturnCodeDescription

public java.lang.String getReturnCodeDescription()

Get the return code's description.

Returns:

The return code, or null if not found.

getReturnCodeName

public java.lang.String getReturnCodeName()

Get the return code's name.

Returns:

The return code (eg, "DSAP.MSUCCESS"), or null if not found.

setError

public void setError(int n,
                     int err)
              throws java.lang.IllegalArgumentException

Set an error code.

Parameters:

n - The ordinal number of the error (1, 2 or 3).

err - The error code.

Throws:

java.lang.IllegalArgumentException - The index is out of bounds.

setError

public void setError(int n,
                     java.lang.String code)
              throws java.lang.IllegalArgumentException

Set an error code. This is expected to correspond to an entry in the error table.

Parameters:

n - The index of the error (0, 1, 2 or 3).

code - The error code (eg,"tt.CustomerNotFound").

Throws:

java.lang.IllegalArgumentException - The error was not found in the MIB error table, or the error index is out of bounds.

setReturnCode

public void setReturnCode(int code)

Set the return code.

Parameters:

code - The return code. This is not recommended usage.

See Also:

setReturnCode(String)

setReturnCode

public void setReturnCode(java.lang.String code)
                   throws java.lang.IllegalArgumentException

Set the return code. Recommended usage is that this be simply DSAP.MSUCCESS or DSAP.MFAIL.

Parameters:

code - The return code (eg,"DSAP.MSUCCESS").

Throws:

java.lang.IllegalArgumentException - The error was not found in the MIB error table.

toString

public java.lang.String toString()

Overrides:

toString in class CMIPMessage