org.asteriskjava.manager.action

Class QueueAddAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.QueueAddAction

All Implemented Interfaces:

Serializable, ManagerAction

public class QueueAddAction
extends AbstractManagerAction

The QueueAddAction adds a new member to a queue.

It is implemented in apps/app_queue.c

The memberName property was added in Asterisk 1.4, the stateInterface property in Asterisk 1.6.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueueAddAction() Creates a new empty QueueAddAction.
QueueAddAction(String queue, String iface) Creates a new QueueAddAction that adds a new member on the given interface to the given queue.
QueueAddAction(String queue, String iface, 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

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getInterface() Returns the name of the channel to dial to reach this member.
String	getMemberName() Returns the name of the queue memeber (agent name).
Boolean	getPaused() Returns if the queue member should be paused when added.
Integer	getPenalty() Returns the penalty for this member.
String	getQueue() Returns the name of the queue the new member will be added to.
String	getStateInterface() Returns the name of the channel from which to read devicestate changes.
void	setInterface(String iface) Sets the name of the channel (Technology/Location) to dial to reach this member.
void	setMemberName(String memberName) Sets the name of the queue memeber (agent name).
void	setPaused(Boolean paused) Sets if the queue member should be paused when added.
void	setPenalty(Integer penalty) Sets the penalty for this member.
void	setQueue(String queue) Sets the name of the queue the new member will be added to.
void	setStateInterface(String stateInterface) Sets the name of the channel (Technology/Location) from which to read devicestate changes.

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

QueueAddAction

public QueueAddAction()

Creates a new empty QueueAddAction.

QueueAddAction

public QueueAddAction(String queue,
                      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(String queue,
                      String iface,
                      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 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 String getQueue()

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

Returns:

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

setQueue

public void setQueue(String queue)

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

This property is mandatory.

Parameters:

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

getInterface

public String getInterface()

Returns the name of the channel to dial to reach this member.

Returns:

the name of the channel to dial to reach this member.

setInterface

public void setInterface(String iface)

Sets the name of the channel (Technology/Location) to dial to reach this member.

This property is mandatory.

Parameters:

iface - the name of the channel to dial to reach this member, e.g. "SIP/1234".

getPenalty

public Integer getPenalty()

Returns the penalty for this member.

Returns:

the penalty for this member.

setPenalty

public void setPenalty(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.

Parameters:

penalty - the penalty for this member.

getPaused

public 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(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

getMemberName

public String getMemberName()

Returns the name of the queue memeber (agent name).

Available since Asterisk 1.4

Returns:

the name of the queue memeber (agent name).

Since:

1.0.0

setMemberName

public void setMemberName(String memberName)

Sets the name of the queue memeber (agent name).

Available since Asterisk 1.4

Parameters:

memberName - the name of the queue memeber (agent name).

Since:

1.0.0

getStateInterface

public String getStateInterface()

Returns the name of the channel from which to read devicestate changes.

Available since Asterisk 1.6

Returns:

the name of the channel from which to read devicestate changes.

Since:

1.0.0

setStateInterface

public void setStateInterface(String stateInterface)

Sets the name of the channel (Technology/Location) from which to read devicestate changes.

Available since Asterisk 1.6

Parameters:

stateInterface - the name of the channel from which to read devicestate changes.

Since:

1.0.0