org.asteriskjava.live
Interface AsteriskQueueMember

All Superinterfaces:

LiveObject

public interface AsteriskQueueMember
extends LiveObject

A queue member. Queue Member can be an agent or a direkt sip account, eg. a Phone.

PropertyChangeEvents are fired for the following properties:

• state
• penalty (since Asterisk 1.6)

Since:

0.3.1

Version:

$Id: AsteriskQueueMember.java 965 2008-02-03 06:47:03Z srt $

Author:

Patrick Breucking

Field Summary

static java.lang.String	PROPERTY_PENALTY
static java.lang.String	PROPERTY_STATE

Method Summary

java.lang.String	getLocation() Returns the location of this member.
java.lang.Integer	getPenalty() Returns the penalty of this member.
AsteriskQueue	getQueue() Returns the queue this member is registerd to.
QueueMemberState	getState() Returns the state of this member.
void	setPenalty(int penalty) Assignes a new penalty to this queue member.

Methods inherited from interface org.asteriskjava.live.LiveObject

addPropertyChangeListener, addPropertyChangeListener, getServer, removePropertyChangeListener, removePropertyChangeListener

Field Detail

PROPERTY_STATE

static final java.lang.String PROPERTY_STATE

See Also:

Constant Field Values

PROPERTY_PENALTY

static final java.lang.String PROPERTY_PENALTY

See Also:

Constant Field Values

Method Detail

getLocation

java.lang.String getLocation()

Returns the location of this member.

Returns:

the location of this member.

getQueue

AsteriskQueue getQueue()

Returns the queue this member is registerd to.

Returns:

the queue this member is registerd to.

getState

QueueMemberState getState()

Returns the state of this member.

Returns:

the state of this member.

getPenalty

java.lang.Integer getPenalty()

Returns the penalty of this member.

Returns:

the penalty of this member.

Since:

1.0.0

setPenalty

void setPenalty(int penalty)
                throws java.lang.IllegalArgumentException,
                       ManagerCommunicationException,
                       InvalidPenaltyException

Assignes a new penalty to this queue member.

Available since Asterisk 1.6.

Parameters:

penalty - the new penalty value, must not be negative.

Throws:

java.lang.IllegalArgumentException - if the penalty is negative.

ManagerCommunicationException - if the QueuePenaltyAction could not be send to Asterisk.

InvalidPenaltyException - if Asterisk refused to set the new penalty.

Since:

1.0.0