org.asteriskjava.manager.action

Class QueuePauseAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.QueuePauseAction

All Implemented Interfaces:

Serializable, ManagerAction

public class QueuePauseAction
extends AbstractManagerAction

The QueuePauseAction makes a queue member temporarily unavailabe (or available again).

It is implemented in apps/app_queue.c

Available since Asterisk 1.2.

Since:

0.2

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueuePauseAction() Creates a new empty QueuePauseAction.
QueuePauseAction(String iface) Creates a new QueuePauseAction that makes the member on the given interface unavailable on all queues.
QueuePauseAction(String iface, Boolean paused) Creates a new QueuePauseAction that makes the member on the given interface available or unavailable on all queues.
QueuePauseAction(String iface, String queue) Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.
QueuePauseAction(String iface, String queue, Boolean paused) Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getInterface() Returns the interface of the member to make available or unavailable.
Boolean	getPaused() Returns if the member is made available or unavailable.
String	getQueue() Returns the name of the queue the member is made available or unavailable on.
String	getReason() Sets the name of the local reason.
void	setInterface(String iface) Sets the interface of the member to make available or unavailable.
void	setPaused(Boolean paused) Sets if the member is made available or unavailable.
void	setQueue(String queue) Sets the name of the queue the member is made available or unavailable on.
void	setReason(String reason) Returns the name of the reason.

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

Constructor Detail

QueuePauseAction

public QueuePauseAction()

Creates a new empty QueuePauseAction.

QueuePauseAction

public QueuePauseAction(String iface)

Creates a new QueuePauseAction that makes the member on the given interface unavailable on all queues.

Parameters:

iface - the interface of the member to make unavailable

QueuePauseAction

public QueuePauseAction(String iface,
                        String queue)

Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.

Parameters:

iface - the interface of the member to make unavailable

queue - the queue the member is made unvailable on

QueuePauseAction

public QueuePauseAction(String iface,
                        Boolean paused)

Creates a new QueuePauseAction that makes the member on the given interface available or unavailable on all queues.

Parameters:

iface - the interface of the member to make unavailable

paused - Boolean.TRUE to make the member unavailbale, Boolean.FALSE to make the member available

QueuePauseAction

public QueuePauseAction(String iface,
                        String queue,
                        Boolean paused)

Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.

Parameters:

iface - the interface of the member to make unavailable

queue - the queue the member is made unvailable on

paused - Boolean.TRUE to make the member unavailbale, Boolean.FALSE to make the member available

Method Detail

getAction

public String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

Returns:

the name of this action.

getInterface

public String getInterface()

Returns the interface of the member to make available or unavailable.

Returns:

the interface of the member to make available or unavailable.

setInterface

public void setInterface(String iface)

Sets the interface of the member to make available or unavailable.

This property is mandatory.

Parameters:

iface - the interface of the member to make available or unavailable.

getQueue

public String getQueue()

Returns the name of the queue the member is made available or unavailable on.

Returns:

the name of the queue the member is made available or unavailable on or null for all queues.

setQueue

public void setQueue(String queue)

Sets the name of the queue the member is made available or unavailable on.

Parameters:

queue - the name of the queue the member is made available or unavailable on or null for all queues.

getPaused

public Boolean getPaused()

Returns if the member is made available or unavailable.

Returns:

Boolean.TRUE to make the member unavailbale, Boolean.FALSE to make the member available

setPaused

public void setPaused(Boolean paused)

Sets if the member is made available or unavailable.

This property is mandatory.

Parameters:

paused - Boolean.TRUE to make the member unavailbale, Boolean.FALSE to make the member available

getReason

public String getReason()

Sets the name of the local reason.

Available since Asterisk 1.6.

Returns:

Name of the local reason for clears the flag.

setReason

public void setReason(String reason)

Returns the name of the reason.

Available since Asterisk 1.6.

Parameters:

reason - Name of the local reason for clears the flag.