org.jivesoftware.smackx.workgroup.agent
Class WorkgroupQueue

java.lang.Object
  org.jivesoftware.smackx.workgroup.agent.WorkgroupQueue

public class WorkgroupQueue
extends Object

A queue in a workgroup, which is a pool of agents that are routed a specific type of chat request.

Nested Class Summary

static class

WorkgroupQueue.Status A class to represent the status of the workgroup.

Method Summary

int	getAverageWaitTime() Returns the average amount of time users wait in the queue before being routed to an agent.
int	getCurrentChats() Returns the current number of active chat sessions in the queue.
int	getMaxChats() Returns the maximum number of simultaneous chats the queue can handle.
String	getName() Returns the name of the queue.
Date	getOldestEntry() Returns the date of the oldest request waiting in the queue.
WorkgroupQueue.Status	getStatus() Returns the status of the queue.
int	getUserCount() Returns the number of users waiting in the queue waiting to be routed to an agent.
Iterator	getUsers() Returns an Iterator for the users in the queue waiting to be routed to an agent (QueueUser instances).

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the name of the queue.

Returns:

the name of the queue.

getStatus

public WorkgroupQueue.Status getStatus()

Returns the status of the queue.

Returns:

the status of the queue.

getUserCount

public int getUserCount()

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

Returns:

the number of users waiting in the queue.

getUsers

public Iterator getUsers()

Returns an Iterator for the users in the queue waiting to be routed to an agent (QueueUser instances).

Returns:

an Iterator for the users waiting in the queue.

getAverageWaitTime

public int getAverageWaitTime()

Returns the average amount of time users wait in the queue before being routed to an agent. If average wait time info isn't available, -1 will be returned.

Returns:

the average wait time

getOldestEntry

public Date getOldestEntry()

Returns the date of the oldest request waiting in the queue. If there are no requests waiting to be routed, this method will return null.

Returns:

the date of the oldest request in the queue.

getMaxChats

public int getMaxChats()

Returns the maximum number of simultaneous chats the queue can handle.

Returns:

the max number of chats the queue can handle.

getCurrentChats

public int getCurrentChats()

Returns the current number of active chat sessions in the queue.

Returns:

the current number of active chat sessions in the queue.