org.xmlBlaster.client.qos
Class EraseReturnQos

java.lang.Object
  org.xmlBlaster.client.qos.EraseReturnQos

public final class EraseReturnQos

extends java.lang.Object

Handling the returned QoS (quality of service) of a erase() call.

If you are a Java client and use the interface I_XmlBlasterAccess you get this object as the erase() return value.

Example:

   <qos>
     <state id='OK' info='QUEUED[bilbo]'/>
     <key oid='HelloWorld/>
  </qos>
 

See Also:

StatusQosFactoryTest, the interface.erase requirement

Field Summary

private StatusQosData

statusQosData

Constructor Summary

EraseReturnQos(Global glob, StatusQosData statusQosData)
Constructor which reuses a StatusQosData object.

EraseReturnQos(Global glob, java.lang.String xmlQos)
Constructor which parses XML string.

Method Summary

StatusQosData	getData() Access the raw data object, usually you shouldn't do it.
java.lang.String	getKeyOid() Get the oid of the message erased.
java.lang.String	getState() Access the state of message.
java.lang.String	getStateInfo() Additional structured information about a state.
java.lang.String	toString()
java.lang.String	toXml()
java.lang.String	toXml(java.lang.String extraOffset) Dump state of this object into a XML ASCII string.

Methods inherited from class java.lang.Object

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

Field Detail

statusQosData

private final StatusQosData statusQosData

Constructor Detail

EraseReturnQos

public EraseReturnQos(Global glob,
                      java.lang.String xmlQos)
               throws XmlBlasterException

Constructor which parses XML string.

EraseReturnQos

public EraseReturnQos(Global glob,
                      StatusQosData statusQosData)

Constructor which reuses a StatusQosData object.

Method Detail

getData

public StatusQosData getData()

Access the raw data object, usually you shouldn't do it.

Returns:

The raw data object

getState

public java.lang.String getState()

Access the state of message.

Returns:

OK (Other values are not yet supported)

getStateInfo

public java.lang.String getStateInfo()

Additional structured information about a state.

Returns:

"QUEUED" or "QUEUED[bilbo]"

See Also:

Constants

getKeyOid

public java.lang.String getKeyOid()

Get the oid of the message erased.

toXml

public java.lang.String toXml()

See Also:

toXml(String)

toXml

public java.lang.String toXml(java.lang.String extraOffset)

Dump state of this object into a XML ASCII string.

Parameters:

extraOffset - indenting of tags for nice output

Returns:

The XML representation

toString

public java.lang.String toString()