org.asteriskjava.manager.action

Class QueueSummaryAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.QueueSummaryAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class QueueSummaryAction
extends AbstractManagerAction
implements EventGeneratingAction

The QueueSummaryAction retrieves the summary for one or all queues.

Available in Asterisk post-1.4.

This action has been added by http://bugs.digium.com/view.php?id=8035.

Since:

0.3

Version:

$Id$

Author:

srt

See Also:

QueueSummaryEvent, QueueSummaryCompleteEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueueSummaryAction() Creates a new QueueSummaryAction that retrieves the summary for all queues.
QueueSummaryAction(String queue) Creates a new QueueSummaryAction that retrieves the summary for the given queue.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action for example "Hangup".
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
String	getQueue() Returns the name of the queue to retrieve the summary for.
void	setQueue(String queue) Sets the name of the queue to retrieve the summary for.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asteriskjava.manager.action.ManagerAction

getActionId, setActionId

Constructor Detail

QueueSummaryAction

public QueueSummaryAction()

Creates a new QueueSummaryAction that retrieves the summary for all queues.

QueueSummaryAction

public QueueSummaryAction(String queue)

Creates a new QueueSummaryAction that retrieves the summary for the given queue.

Parameters:

queue - name of the queue to retrieve the summary for.

Method Detail

getAction

public String getAction()

Description copied from interface: ManagerAction

Returns the name of the action for example "Hangup".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getActionCompleteEventClass

public Class<? extends ResponseEvent> getActionCompleteEventClass()

Description copied from interface: EventGeneratingAction

Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:

getActionCompleteEventClass in interface EventGeneratingAction

Returns:

a Class that is an instance of ResponseEvent.

See Also:

ResponseEvent

getQueue

public String getQueue()

Returns the name of the queue to retrieve the summary for.

Returns:

the name of the queue to retrieve the summary for or null to retrieve the summary for all queues.

setQueue

public void setQueue(String queue)

Sets the name of the queue to retrieve the summary for.

Parameters:

queue - the name of the queue to retrieve the summary for or null to retrieve the summary for all queues.