org.asteriskjava.manager.event

Class QueueEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.QueueEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JoinEvent, LeaveEvent, QueueCallerAbandonEvent, QueueCallerJoinEvent, QueueCallerLeaveEvent

public abstract class QueueEvent
extends ManagerEvent

Abstract base class providing common properties for JoinEvent and LeaveEvent.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
QueueEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getChannel() Returns the name of the channel that joines or leaves the queue.
Integer	getCount() Returns the number of elements in the queue, i.e.
String	getQueue() Returns the name of the queue.
String	getUniqueId() Returns the unique id of the channel that joines or leaves the queue.
void	setChannel(String channel) Sets the name of the channel that joines or leaves the queue.
void	setCount(Integer count) Sets the number of elements in the queue.
void	setQueue(String queue) Sets the name of the queue.
void	setUniqueId(String uniqueId) Sets the unique id of the channel that joines or leaves the queue.

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, setTimestamp, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueueEvent

public QueueEvent(Object source)

Parameters:

source -

Method Detail

getUniqueId

public String getUniqueId()

Returns the unique id of the channel that joines or leaves the queue.

This property is only available since Asterisk 1.4. Up to Asterisk 1.2 this method always returns null.

See Asterisk issues 6458 and 7002.

Returns:

the unique id of the channel that joines or leaves the queue or null if not supported by your Asterisk server.

Since:

0.3

setUniqueId

public void setUniqueId(String uniqueId)

Sets the unique id of the channel that joines or leaves the queue.

Parameters:

uniqueId - the unique id of the channel that joines or leaves the queue.

Since:

0.3

getChannel

public String getChannel()

Returns the name of the channel that joines or leaves the queue.

setChannel

public void setChannel(String channel)

Sets the name of the channel that joines or leaves the queue.

getCount

public Integer getCount()

Returns the number of elements in the queue, i.e. the number of calls waiting to be answered by an agent.

setCount

public void setCount(Integer count)

Sets the number of elements in the queue.

getQueue

public String getQueue()

Returns the name of the queue.

setQueue

public void setQueue(String queue)

Sets the name of the queue.