Asterisk-Java

org.asteriskjava.manager.action
Class QueuePauseAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.QueuePauseAction
All Implemented Interfaces:
java.io.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: QueuePauseAction.java 938 2007-12-31 03:23:38Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
QueuePauseAction()
          Creates a new empty QueuePauseAction.
QueuePauseAction(java.lang.String iface)
          Creates a new QueuePauseAction that makes the member on the given interface unavailable on all queues.
QueuePauseAction(java.lang.String iface, java.lang.Boolean paused)
          Creates a new QueuePauseAction that makes the member on the given interface available or unavailable on all queues.
QueuePauseAction(java.lang.String iface, java.lang.String queue)
          Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.
QueuePauseAction(java.lang.String iface, java.lang.String queue, java.lang.Boolean paused)
          Creates a new QueuePauseAction that makes the member on the given interface unavailable on the given queue.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getInterface()
          Returns the interface of the member to make available or unavailable.
 java.lang.Boolean getPaused()
          Returns if the member is made available or unavailable.
 java.lang.String getQueue()
          Returns the name of the queue the member is made available or unavailable on.
 void setInterface(java.lang.String iface)
          Sets the interface of the member to make available or unavailable.
 void setPaused(java.lang.Boolean paused)
          Sets if the member is made available or unavailable.
 void setQueue(java.lang.String queue)
          Sets the name of the queue the member is made available or unavailable on.
 
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(java.lang.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(java.lang.String iface,
                        java.lang.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(java.lang.String iface,
                        java.lang.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(java.lang.String iface,
                        java.lang.String queue,
                        java.lang.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 java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.