org.xmlBlaster.client.qos
Class UpdateReturnQos

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

public final class UpdateReturnQos
extends java.lang.Object

Handling the returned QoS (quality of service) of an update() call.

If you are a Java client you can use this class to generate the QoS which you need to return in an update()

Example:

   <qos>
     <state id='OK'/>
  </qos>
 

See Also:

StatusQosFactoryTest, the interface.update requirement

Field Summary

private StatusQosData

statusQosData

Constructor Summary

UpdateReturnQos(Global glob)
Create an instance with Constants.STATE_OK

UpdateReturnQos(Global glob, StatusQosData statusQosData)
Constructor which allows you to set the return state.

UpdateReturnQos(Global glob, java.lang.String state)
Constructor which allows you to set the return state.

Method Summary

void	setState(java.lang.String state)
void	setStateInfo(java.lang.String stateInfo)
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

UpdateReturnQos

public UpdateReturnQos(Global glob)

Create an instance with Constants.STATE_OK

UpdateReturnQos

public UpdateReturnQos(Global glob,
                       java.lang.String state)

Constructor which allows you to set the return state.

Parameters:

state - The state to return to the server. See Constants.java

UpdateReturnQos

public UpdateReturnQos(Global glob,
                       StatusQosData statusQosData)

Constructor which allows you to set the return state.

Parameters:

statusQosData - The pre filled raw data object

Method Detail

setState

public void setState(java.lang.String state)

Parameters:

state - The state to return to the server. e.g. Contants.STATE_OK, see Constants.java

setStateInfo

public void setStateInfo(java.lang.String stateInfo)

Parameters:

stateInfo - The state info attribute to return to the server.

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

Overrides:

toString in class java.lang.Object