org.asteriskjava.manager.action

Class QueuePenaltyAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.QueuePenaltyAction

All Implemented Interfaces:

Serializable, ManagerAction

public class QueuePenaltyAction
extends AbstractManagerAction

The QueuePenaltyAction sets the penalty for a queue member.

It is implemented in apps/app_queue.c

Available since Asterisk 1.6.

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueuePenaltyAction() Creates a new empty QueuePenaltyAction.
QueuePenaltyAction(String iface, int penalty) Creates a new QueuePenaltyAction that sets the penalty for the given interface on all queues.
QueuePenaltyAction(String iface, int penalty, String queue) Creates a new QueuePenaltyAction that sets the penalty for the given interface 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 set the penalty for.
Integer	getPenalty() Returns the new penalty.
String	getQueue() Returns the name of the queue.
void	setInterface(String iface) Sets the interface of the member to set the penalty for.
void	setPenalty(Integer penalty) Sets the new penalty.
void	setQueue(String queue) Sets the name of the queue.

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

QueuePenaltyAction

public QueuePenaltyAction()

Creates a new empty QueuePenaltyAction.

QueuePenaltyAction

public QueuePenaltyAction(String iface,
                          int penalty)

Creates a new QueuePenaltyAction that sets the penalty for the given interface on all queues.

Parameters:

iface - the interface of the member to set the penalty for

penalty - new penalty value.

QueuePenaltyAction

public QueuePenaltyAction(String iface,
                          int penalty,
                          String queue)

Creates a new QueuePenaltyAction that sets the penalty for the given interface on the given queue.

Parameters:

iface - the interface of the member to set the penalty for

penalty - new penalty value.

queue - the queue the member is assigned the penalty for

Method Detail

getAction

public String getAction()

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

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 set the penalty for.

Returns:

the interface of the member to to set the penalty for.

setInterface

public void setInterface(String iface)

Sets the interface of the member to set the penalty for.

This property is mandatory.

Parameters:

iface - the interface of the member to to set the penalty for.

getPenalty

public Integer getPenalty()

Returns the new penalty.

Returns:

the new penalty.

setPenalty

public void setPenalty(Integer penalty)

Sets the new penalty.

This property is mandatory.

Parameters:

penalty - the new penalty.

getQueue

public String getQueue()

Returns the name of the queue.

Returns:

the name of the queue.

setQueue

public void setQueue(String queue)

Sets the name of the queue.

Parameters:

queue - the name of the queue or null for all queues.