org.asteriskjava.manager.action

Class AgentsAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.AgentsAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class AgentsAction
extends AbstractManagerAction
implements EventGeneratingAction

The AgentsAction requests the state of all agents.

For each agent an AgentsEvent is generated. After the state of all agents has been reported an AgentsCompleteEvent is generated.

Available since Asterisk 1.2

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

AgentsEvent, AgentsCompleteEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AgentsAction() Creates a new AgentsAction.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.

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

AgentsAction

public AgentsAction()

Creates a new AgentsAction.

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "Agents".

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