org.asteriskjava.live
Interface AsteriskQueueEntry

All Superinterfaces:

LiveObject

public interface AsteriskQueueEntry
extends LiveObject

Represents a member of a queue.

PropertyChangeEvents are fired for the following properties:

• state
• position
• reportedPosition

Author:

gmi

Field Summary

static int	POSITION_UNDETERMINED
static java.lang.String	PROPERTY_POSITION
static java.lang.String	PROPERTY_REPORTED_POSITION
static java.lang.String	PROPERTY_STATE

Method Summary

AsteriskChannel	getChannel() Returns the channel associated with this entry.
java.lang.String	getChannelName() Returns the name of the channel associated with this entry.
java.util.Date	getDateJoined() Returns the date this member joined the Queue.
java.util.Date	getDateLeft() Returns the date this member left the queue room.
int	getPosition() Returns the position of this queue entry in the queue.
AsteriskQueue	getQueue() Returns the Queue this member joined.
QueueEntryState	getState() Returns the lifecycle status of this AsteriskQueueEntry.

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_POSITION

static final java.lang.String PROPERTY_POSITION

See Also:

Constant Field Values

PROPERTY_REPORTED_POSITION

static final java.lang.String PROPERTY_REPORTED_POSITION

See Also:

Constant Field Values

POSITION_UNDETERMINED

static final int POSITION_UNDETERMINED

See Also:

Constant Field Values

Method Detail

getDateJoined

java.util.Date getDateJoined()

Returns the date this member joined the Queue.

This property is immutable.

Returns:

the date this member joined the Queue

getDateLeft

java.util.Date getDateLeft()

Returns the date this member left the queue room.

This property is null as long as the user is in state QueueEntryState.JOINED and set to date the member left when entering QueueEntryState.LEFT.

Returns:

the date this member left the Queue or null if the user did not yet leave.

getState

QueueEntryState getState()

Returns the lifecycle status of this AsteriskQueueEntry.

Initially the user is in state QueueEntryState.JOINED.

Returns:

the lifecycle status of this AsteriskQueueEntry.

getQueue

AsteriskQueue getQueue()

Returns the Queue this member joined.

This property is immutable.

Returns:

the Queue this entry joined.

getChannel

AsteriskChannel getChannel()

Returns the channel associated with this entry.

This property is immutable.

Returns:

the channel associated with this entry.

getChannelName

java.lang.String getChannelName()

Returns the name of the channel associated with this entry.

Comodity bridge, don't duplicate channel name as it can be renamed.

Returns:

the name of the channel associated with this entry.

getPosition

int getPosition()

Returns the position of this queue entry in the queue.

Returns:

the name of the channel associated with this entry.