com.avaya.conferencing.api.acp.control
Interface ConferencingObjectQueue<Q extends ConferencingObjectQueue<Q,E>,E extends ConferencingObject<E>>

Type Parameters:

Q - Implementing classes use this type parameter to provide type safety.

E - The type of ConferencingObject that this queue holds.

All Superinterfaces:

ConferencingObject<Q>, ConferencingObjectContainer<Q>, java.lang.Iterable<E>

All Known Implementing Classes:

ConferenceQueue, EndPointQueue

public interface ConferencingObjectQueue<Q extends ConferencingObjectQueue<Q,E>,E extends ConferencingObject<E>>
extends ConferencingObjectContainer<Q>, java.lang.Iterable<E>

Represents an ordered queue of ConferencingObjects.

Since:

5.1.0.0.29

Nested Class Summary

static interface	ConferencingObjectQueue.Purpose Purposes for ConferencingObjectQueues.
static class	ConferencingObjectQueue.Purposes Well known purposes.

Field Summary

static java.lang.String	ACTIVE The property name for isActive().
static java.lang.String	NAME The property name for getName().
static java.lang.String	PURPOSES The property name for getPurposes().

Fields inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject

STATE

Method Summary

void	addEntryListener(ChildListener<? super Q,? super E> childListener) Registers a ChildListener against the specified child class for this ConferencingObject instance.
void	addEntryListener(ConferencingObjectQueueListener<? super Q,? super E> queueListener) Registers a ConferencingObjectQueueListener against the specified child class for this ConferencingObjectQueue instance.
void	addEntryPropertyChangeListener(java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of the entries of the queue.
void	addEntryPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against specific properties of the entries in the queue.
E	findEntry(Reference<E> ref) Find and retrieve the specified entry.
<S extends ConferencingObject<S>> java.util.List<S>	getChildren(java.lang.Class<S> clazz) Returns the children of the specified class of child objects.
<S extends ConferencingObject<S>> java.util.List<S>	getChildren(java.lang.Class<S> clazz, Filter<? super S>... filters) Returns the children of the specified class of child objects.
java.util.List<E>	getEntries() Returns the queue entries as an ordered list.
java.util.List<E>	getEntries(Filter<? super E>... filters) Returns the queue entries as an ordered list.
java.lang.Class<E>	getEntryClass() Method getEntryClass returns the entryClass of this ConferencingObjectQueue object.
java.lang.String	getName() Returns the name of this EndPointQueue object.
java.util.Set<ConferencingObjectQueue.Purpose>	getPurposes() Returns the purposes of this queue.
boolean	isActive() Returns true if this EndPointQueue is connected.
boolean	isEmpty() Short hand form of getEntries().isEmpty
java.util.Iterator<E>	iterator(Filter<? super E>... filters) Returns an iterator over a set of elements of type T.
E	lookupEntry(Reference<E> ref) Find and retrieve the specified entry.
void	removeEntryListener(ChildListener<? super Q,? super E> childListener) Registers a ChildListener against the specified child class for this ConferencingObjectQueue instance.
void	removeEntryListener(ConferencingObjectQueueListener<? super Q,? super E> queueListener) Unregisters a ConferencingObjectQueueListener against the specified child class for this ConferencingObjectQueue instance.
void	removeEntryPropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of the entries in the queue.
void	removeEntryPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against the entries in the queue.

Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectContainer

addChildListener, addChildListener, addChildPropertyChangeListener, addChildPropertyChangeListener, childClassIterator, childIterator, childIterator, findChild, findParents, getAllChildren, getAllChildren, getChildClasses, lookupChild, lookupParents, removeChildListener, removeChildListener, removeChildPropertyChangeListener, removeChildPropertyChangeListener

Methods inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObject

addAvailableVerbsChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, execute, executeAs, getAllVerbs, getAllVerbsAs, getAllVerbsAs, getConnection, getId, getProperties, getProperties, getPropertyClass, getPropertyClasses, getPropertyType, getPropertyValue, getPropertyValues, getState, getVerbs, getVerbsAs, removeAvailableVerbsChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

NAME

static final java.lang.String NAME

The property name for getName().

Since:

5.1.0.0.29

ACTIVE

static final java.lang.String ACTIVE

The property name for isActive().

Since:

5.1.0.0.29

PURPOSES

static final java.lang.String PURPOSES

The property name for getPurposes().

Since:

5.1.0.0.34

Method Detail

getChildren

<S extends ConferencingObject<S>> java.util.List<S> getChildren(java.lang.Class<S> clazz)

Returns the children of the specified class of child objects. Implementations may use dynamic function loading to populate this collection, so collection.isEmpty() is preferred to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Specified by:

getChildren in interface ConferencingObjectContainer<Q extends ConferencingObjectQueue<Q,E>>

Type Parameters:

S - The child class. For example EndPoint or Conference.

Parameters:

clazz - The class of children to get.

Returns:

The (possibly empty) immutable collection of children.

Since:

5.1.0.0.29

getChildren

<S extends ConferencingObject<S>> java.util.List<S> getChildren(java.lang.Class<S> clazz,
                                                                Filter<? super S>... filters)

Returns the children of the specified class of child objects. Implementations may use dynamic function loading to populate this collection, so collection.isEmpty() is preferred to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Specified by:

getChildren in interface ConferencingObjectContainer<Q extends ConferencingObjectQueue<Q,E>>

Type Parameters:

S - The child class. For example EndPoint or Conference.

Parameters:

clazz - The class of children to get.

filters - The filters to use.

Returns:

The (possibly empty) immutable collection of children.

Since:

5.1.0.0.29

addEntryListener

void addEntryListener(ConferencingObjectQueueListener<? super Q,? super E> queueListener)

Registers a ConferencingObjectQueueListener against the specified child class for this ConferencingObjectQueue instance.

Parameters:

queueListener - the ConferencingObjectQueueListener.

Since:

5.1.0.0.29

addEntryListener

void addEntryListener(ChildListener<? super Q,? super E> childListener)

Registers a ChildListener against the specified child class for this ConferencingObject instance.

Parameters:

childListener - The ChildListener.

Since:

5.1.0.0.29

addEntryPropertyChangeListener

void addEntryPropertyChangeListener(java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against all properties of the entries of the queue.

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addEntryPropertyChangeListener

void addEntryPropertyChangeListener(java.lang.String property,
                                    java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against specific properties of the entries in the queue.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

findEntry

E findEntry(Reference<E> ref)
                                          throws UnknownChildObjectException

Find and retrieve the specified entry.

Parameters:

ref - The entry reference.

Returns:

The entry instance.

Throws:

UnknownChildObjectException - if the entry object does not exist.

Since:

5.1.0.0.29

getEntries

java.util.List<E> getEntries()

Returns the queue entries as an ordered list. Implementations may use lazy-loading strategies to populate this list, so list.isEmpty() is preferred to 0 == list.size(). The latter may block until the entire collection is loaded.

Returns:

The (possibly empty) immutable collection of entries.

Since:

5.1.0.0.29

getEntries

java.util.List<E> getEntries(Filter<? super E>... filters)

Returns the queue entries as an ordered list. Implementations may use lazy-loading strategies to populate this list, so list.isEmpty() is preferred to 0 == list.size(). The latter may block until the entire collection is loaded.

Parameters:

filters - The filters to use.

Returns:

The (possibly empty) immutable collection of entries.

Since:

5.1.0.0.29

iterator

java.util.Iterator<E> iterator(Filter<? super E>... filters)

Returns an iterator over a set of elements of type T.

Parameters:

filters - The filters to use.

Returns:

an Iterator.

Since:

5.1.1.0.1

getEntryClass

java.lang.Class<E> getEntryClass()

Method getEntryClass returns the entryClass of this ConferencingObjectQueue object.

Returns:

the entry class (type Class) of this ConferencingObjectQueue object.

Since:

5.1.0.0.29

getName

java.lang.String getName()

Returns the name of this EndPointQueue object.

Returns:

The name of this EndPointQueue object.

Since:

5.1.0.0.29

isActive

boolean isActive()

Returns true if this EndPointQueue is connected.

Returns:

true if this EndPointQueue is connected.

Since:

5.1.0.0.29

lookupEntry

E lookupEntry(Reference<E> ref)

Find and retrieve the specified entry.

Parameters:

ref - The entry reference.

Returns:

The entry instance or null if the entry object does not exist.

Since:

5.1.0.0.29

removeEntryListener

void removeEntryListener(ConferencingObjectQueueListener<? super Q,? super E> queueListener)

Unregisters a ConferencingObjectQueueListener against the specified child class for this ConferencingObjectQueue instance.

Parameters:

queueListener - the ConferencingObjectQueueListener.

Since:

5.1.0.0.29

removeEntryListener

void removeEntryListener(ChildListener<? super Q,? super E> childListener)

Registers a ChildListener against the specified child class for this ConferencingObjectQueue instance.

Parameters:

childListener - The ChildListener.

Since:

5.1.0.0.29

removeEntryPropertyChangeListener

void removeEntryPropertyChangeListener(java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against all properties of the entries in the queue.

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removeEntryPropertyChangeListener

void removeEntryPropertyChangeListener(java.lang.String property,
                                       java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against the entries in the queue.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

getPurposes

java.util.Set<ConferencingObjectQueue.Purpose> getPurposes()

Returns the purposes of this queue.

Returns:

the purposes of this queue.

Since:

5.1.0.0.34

See Also:

ConferencingObjectQueue.Purpose

isEmpty

boolean isEmpty()

Short hand form of getEntries().isEmpty

Returns:

true if and only if the queue is empty.

Since:

5.1.1.0.1