net.sf.asterisk.manager.action
Class QueueAddAction

java.lang.Object
  net.sf.asterisk.manager.action.AbstractManagerAction
      net.sf.asterisk.manager.action.QueueAddAction

All Implemented Interfaces:

java.io.Serializable, ManagerAction

public class QueueAddAction
extends AbstractManagerAction

The QueueAddAction adds a new member to a queue.
It is implemented in apps/app_queue.c

Version:

$Id: QueueAddAction.java,v 1.6 2005/08/28 09:28:59 srt Exp $

Author:

srt

See Also:

Serialized Form

Constructor Summary

QueueAddAction()
Creates a new empty QueueAddAction.

QueueAddAction(java.lang.String queue, java.lang.String iface)
Creates a new QueueAddAction that adds a new member on the given interface to the given queue.

QueueAddAction(java.lang.String queue, java.lang.String iface, java.lang.Integer penalty)
Creates a new QueueAddAction that adds a new member on the given interface to the given queue with the given penalty.

Method Summary

java.lang.String	getAction() Returns the name of this action, i.e.
java.lang.String	getInterface() Returns the interface to add.
java.lang.Boolean	getPaused() Returns if the queue member should be paused when added.
java.lang.Integer	getPenalty() Returns the penalty for this member.
java.lang.String	getQueue() Returns the name of the queue the new member will be added to.
void	setInterface(java.lang.String iface) Sets the interface to add. To add a specific channel just use the channel name, e.g.
void	setPaused(java.lang.Boolean paused) Sets if the queue member should be paused when added.
void	setPenalty(java.lang.Integer penalty) Sets the penalty for this member. The penalty must be a positive integer or 0 for no penalty.
void	setQueue(java.lang.String queue) Sets the name of the queue the new member will be added to. This property is mandatory.

Methods inherited from class net.sf.asterisk.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

QueueAddAction

public QueueAddAction()

Creates a new empty QueueAddAction.

QueueAddAction

public QueueAddAction(java.lang.String queue,
                      java.lang.String iface)

Creates a new QueueAddAction that adds a new member on the given interface to the given queue.

Parameters:

queue - the name of the queue the new member will be added to

iface - Sets the interface to add. To add a specific channel just use the channel name, e.g. "SIP/1234".

Since:

0.2

QueueAddAction

public QueueAddAction(java.lang.String queue,
                      java.lang.String iface,
                      java.lang.Integer penalty)

Creates a new QueueAddAction that adds a new member on the given interface to the given queue with the given penalty.

Parameters:

queue - the name of the queue the new member will be added to

iface - Sets the interface to add. To add a specific channel just use the channel name, e.g. "SIP/1234".

penalty - the penalty for this member. The penalty must be a positive integer or 0 for no penalty. When calls are distributed members with higher penalties are considered last.

Since:

0.2

Method Detail

getAction

public java.lang.String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getQueue

public java.lang.String getQueue()

Returns the name of the queue the new member will be added to.

setQueue

public void setQueue(java.lang.String queue)

Sets the name of the queue the new member will be added to.
This property is mandatory.

getInterface

public java.lang.String getInterface()

Returns the interface to add.

setInterface

public void setInterface(java.lang.String iface)

Sets the interface to add.
To add a specific channel just use the channel name, e.g. "SIP/1234".
This property is mandatory.

getPenalty

public java.lang.Integer getPenalty()

Returns the penalty for this member.

setPenalty

public void setPenalty(java.lang.Integer penalty)

Sets the penalty for this member.
The penalty must be a positive integer or 0 for no penalty. If it is not set 0 is assumed.
When calls are distributed members with higher penalties are considered last.

getPaused

public java.lang.Boolean getPaused()

Returns if the queue member should be paused when added.

Returns:

Boolean.TRUE if the queue member should be paused when added.

Since:

0.2

setPaused

public void setPaused(java.lang.Boolean paused)

Sets if the queue member should be paused when added.

Parameters:

paused - Boolean.TRUE if the queue member should be paused when added.

Since:

0.2