com.avaya.conferencing.api.acp.control
Class ConferenceQueue

java.lang.Object
  com.avaya.conferencing.api.acp.control.AbstractConferencingObject<ConferenceQueue>
      com.avaya.conferencing.api.acp.control.ConferenceQueue

All Implemented Interfaces:

ConferenceContainer<ConferenceQueue>, ConferencingObject<ConferenceQueue>, ConferencingObjectContainer<ConferenceQueue>, ConferencingObjectQueue<ConferenceQueue,Conference>, java.lang.Iterable<Conference>

public abstract class ConferenceQueue
extends AbstractConferencingObject<ConferenceQueue>
implements ConferencingObjectQueue<ConferenceQueue,Conference>, ConferenceContainer<ConferenceQueue>

ConferenceQueue represents an ordered queue of Conference objects.

Since:

5.1.0.0.29

Nested Class Summary

Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.ConferencingObjectQueue

ConferencingObjectQueue.Purpose, ConferencingObjectQueue.Purposes

Field Summary

Fields inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject

VERBOSE_TO_STRING

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

ACTIVE, NAME, PURPOSES

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

STATE

Constructor Summary

ConferenceQueue()

Method Summary

void	addConferencePropertyChangeListener(java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of the Conferences in this container.
void	addConferencePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against a specific properties of the Conferences in this container.
java.util.Iterator<Conference>	conferenceIterator() Returns an iterator of the conferences.
java.util.Iterator<Conference>	conferenceIterator(Filter<? super Conference>... filters) Returns an iterator of the conferences.
Conference	findConference(Reference<Conference> ref) Find and retrieve the specified Conference.
java.util.List<Conference>	getConferences() Returns the Conferences of this ConferenceContainer.
java.util.List<Conference>	getConferences(Filter<? super Conference>... filters) Returns the Conferences of this ConferenceContainer.
java.lang.Class<Conference>	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.
Conference	lookupConference(Reference<Conference> ref) Find and retrieve the specified Conference.
void	removeConferencePropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of the Conferences in this container.
void	removeConferencePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against a specific property of the Conferences in this container.

Methods inherited from class com.avaya.conferencing.api.acp.control.AbstractConferencingObject

equals, execute, getVerbs, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

addEntryListener, addEntryListener, addEntryPropertyChangeListener, addEntryPropertyChangeListener, findEntry, getChildren, getChildren, getEntries, getEntries, isEmpty, iterator, lookupEntry, removeEntryListener, removeEntryListener, removeEntryPropertyChangeListener, removeEntryPropertyChangeListener

Methods inherited from interface java.lang.Iterable

iterator

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

Constructor Detail

ConferenceQueue

public ConferenceQueue()

Method Detail

getConferences

public final java.util.List<Conference> getConferences()

Returns the Conferences of this ConferenceContainer. Implementations may use lazy-loading strategies to populate this collection, so collection.isEmpty() is preferable to 0 == collection.size() as the latter may block until the entire collection is loaded.

Specified by:

getConferences in interface ConferenceContainer<ConferenceQueue>

Returns:

The (possibly empty) immutable collection of Conferences.

Since:

5.1.0.0.29

getConferences

public final java.util.List<Conference> getConferences(Filter<? super Conference>... filters)

Returns the Conferences of this ConferenceContainer. Implementations may use lazy-loading strategies to populate this collection, so collection.isEmpty() is preferable to 0 == collection.size() as the latter may block until the entire collection is loaded.

Specified by:

getConferences in interface ConferenceContainer<ConferenceQueue>

Parameters:

filters - The filters to use.

Returns:

The (possibly empty) immutable collection of Conferences.

Since:

5.1.1.0.1

getName

public final java.lang.String getName()

Returns the name of this EndPointQueue object.

Specified by:

getName in interface ConferencingObjectQueue<ConferenceQueue,Conference>

Returns:

The name of this EndPointQueue object.

getPurposes

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

Returns the purposes of this queue.

Specified by:

getPurposes in interface ConferencingObjectQueue<ConferenceQueue,Conference>

Returns:

the purposes of this queue.

See Also:

ConferencingObjectQueue.Purpose

isActive

public final boolean isActive()

Returns true if this EndPointQueue is connected.

Specified by:

isActive in interface ConferencingObjectQueue<ConferenceQueue,Conference>

Returns:

true if this EndPointQueue is connected.

getEntryClass

public final java.lang.Class<Conference> getEntryClass()

Description copied from interface: ConferencingObjectQueue

Method getEntryClass returns the entryClass of this ConferencingObjectQueue object.

Specified by:

getEntryClass in interface ConferencingObjectQueue<ConferenceQueue,Conference>

Returns:

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

addConferencePropertyChangeListener

public final void addConferencePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: ConferenceContainer

Registers a PropertyChangeListener against all properties of the Conferences in this container.

Specified by:

addConferencePropertyChangeListener in interface ConferenceContainer<ConferenceQueue>

Parameters:

listener - The PropertyChangeListener.

addConferencePropertyChangeListener

public final void addConferencePropertyChangeListener(java.lang.String property,
                                                      java.beans.PropertyChangeListener listener)

Description copied from interface: ConferenceContainer

Registers a PropertyChangeListener against a specific properties of the Conferences in this container.

Specified by:

addConferencePropertyChangeListener in interface ConferenceContainer<ConferenceQueue>

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

conferenceIterator

public final java.util.Iterator<Conference> conferenceIterator()

Description copied from interface: ConferenceContainer

Returns an iterator of the conferences.

Specified by:

conferenceIterator in interface ConferenceContainer<ConferenceQueue>

Returns:

The iterator.

conferenceIterator

public final java.util.Iterator<Conference> conferenceIterator(Filter<? super Conference>... filters)

Description copied from interface: ConferenceContainer

Returns an iterator of the conferences.

Specified by:

conferenceIterator in interface ConferenceContainer<ConferenceQueue>

Parameters:

filters - The filters to use.

Returns:

The iterator.

findConference

public final Conference findConference(Reference<Conference> ref)
                                throws UnknownChildObjectException

Description copied from interface: ConferenceContainer

Find and retrieve the specified Conference.

Specified by:

findConference in interface ConferenceContainer<ConferenceQueue>

Parameters:

ref - The Conference reference.

Returns:

The Conference instance.

Throws:

UnknownChildObjectException - if the Conference does not exist.

lookupConference

public final Conference lookupConference(Reference<Conference> ref)

Description copied from interface: ConferenceContainer

Find and retrieve the specified Conference.

Specified by:

lookupConference in interface ConferenceContainer<ConferenceQueue>

Parameters:

ref - The Conference reference.

Returns:

The Conference instance or null if the Conference does not exist.

removeConferencePropertyChangeListener

public final void removeConferencePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: ConferenceContainer

Unregisters a PropertyChangeListener previously registered against all properties of the Conferences in this container.

Specified by:

removeConferencePropertyChangeListener in interface ConferenceContainer<ConferenceQueue>

Parameters:

listener - The PropertyChangeListener.

removeConferencePropertyChangeListener

public final void removeConferencePropertyChangeListener(java.lang.String property,
                                                         java.beans.PropertyChangeListener listener)

Description copied from interface: ConferenceContainer

Unregisters a PropertyChangeListener previously registered against a specific property of the Conferences in this container.

Specified by:

removeConferencePropertyChangeListener in interface ConferenceContainer<ConferenceQueue>

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.