org.jivesoftware.smackx.workgroup.packet
Class QueueDetails

java.lang.Object
  org.jivesoftware.smackx.workgroup.packet.QueueDetails

All Implemented Interfaces:

PacketExtension

public class QueueDetails
extends Object
implements PacketExtension

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

Nested Class Summary

static class

QueueDetails.Provider Provider class for QueueDetails packet extensions.

Field Summary

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

Method Summary

String	getElementName() Returns the root element name.
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.
Set	getUsers() Returns the set of users in the queue that are waiting to be routed to an agent (as QueueUser objects).
String	toXML() Returns the XML reppresentation 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 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

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 Set 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 String getElementName()

Description copied from interface: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public String toXML()

Description copied from interface: PacketExtension

Returns the XML reppresentation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.