Package org.jivesoftware.smackx.workgroup.packet

Class QueueDetails

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueDetails

All Implemented Interfaces:

Element, ExtensionElement, FullyQualifiedElement, NamedElement, XmlLangElement

public final class QueueDetails
extends java.lang.Object
implements ExtensionElement

Queue details stanza extension, which contains details about the users currently in a queue.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueueDetails.Provider	Provider class for QueueDetails stanza extensions.

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.

Constructor Summary

Constructors

Constructor	Description
QueueDetails()

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	getUserCount()	Returns the number of users currently in the queue that are waiting to be routed to an agent.
java.util.Set<QueueUser>	getUsers()	Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).
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

Constructor Detail

QueueDetails

public QueueDetails()

Method Detail

getUserCount

public int getUserCount()

Returns the number of users currently in the queue that are waiting to be routed to an agent.

Returns:

the number of users in the queue.

getUsers

public java.util.Set<QueueUser> getUsers()

Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).

Returns:

a Set for the users waiting in a queue.

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.

toXML

public java.lang.String toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element