Package org.jivesoftware.smackx.workgroup.packet

Class QueueUpdate

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueUpdate

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement

public class QueueUpdate
extends java.lang.Object
implements ExtensionElement

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueUpdate.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ELEMENT_NAME	Element name of the stanza extension.
static java.lang.String	NAMESPACE	Namespace of the stanza extension.
static javax.xml.namespace.QName	QNAME

Constructor Summary

Constructors

Constructor	Description
QueueUpdate(int position, int remainingTime)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getElementName()	Returns the root element name.
java.lang.String	getNamespace()	Returns the root element XML namespace.
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.
java.lang.String	toXML(XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getLanguage, getQName

Field Detail

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

Element name of the stanza extension.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Namespace of the stanza extension.

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

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.

toXML

public java.lang.String toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

getElementName

public java.lang.String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: FullyQualifiedElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface FullyQualifiedElement

Returns:

the namespace.