org.jivesoftware.smackx.workgroup.packet
Class QueueUpdate

java.lang.Object
  org.jivesoftware.smack.packet.Packet
      org.jivesoftware.smack.packet.IQ
          org.jivesoftware.smackx.workgroup.packet.QueueUpdate

public class QueueUpdate
extends IQ

An IQ packet that encapsulates both types of workgroup queue status notifications -- position updates, and estimated time left in the queue updates.

Nested Class Summary

static class

QueueUpdate.Provider

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

static String	ELEMENT_NAME Element name of the packet extension.
static String	NAMESPACE Namespace of the packet extension.

Fields inherited from class org.jivesoftware.smack.packet.Packet

ID_NOT_AVAILABLE

Constructor Summary

QueueUpdate(int position, int remainingTime)

Method Summary

String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
int	getPosition() Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.
int	getRemaingTime() Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.

Methods inherited from class org.jivesoftware.smack.packet.IQ

getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addExtension, deleteProperty, getError, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTo

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name of the packet extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the packet extension.

See Also:

Constant Field Values

Constructor Detail

QueueUpdate

public QueueUpdate(int position,
                   int remainingTime)

Method Detail

getPosition

public int getPosition()

Returns the user's position in the workgroup queue, or -1 if the value isn't set on this packet.

Returns:

the position in the workgroup queue.

getRemaingTime

public int getRemaingTime()

Returns the user's estimated time left in the workgroup queue, or -1 if the value isn't set on this packet.

Returns:

the estimated time left in the workgroup queue.

getChildElementXML

public String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.