org.jivesoftware.smackx.workgroup.packet

Class QueueDetails

java.lang.Object

org.jivesoftware.smackx.workgroup.packet.QueueDetails

All Implemented Interfaces:

PacketExtension

public class QueueDetails
extends java.lang.Object
implements PacketExtension

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT_NAME Element name of the packet extension.
static java.lang.String	NAMESPACE Namespace of the packet extension.

Method Summary

Methods

Modifier and Type	Method and 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() Returns the XML representation of the PacketExtension.

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 java.lang.String ELEMENT_NAME

Element name of the packet extension.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Namespace of the packet extension.

See Also:

Constant Field Values

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: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public java.lang.String toXML()

Description copied from interface: PacketExtension

Returns the XML representation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.