com.avaya.conferencing.api.acp.control
Interface ConferenceContainer<IMPL_CLASS extends ConferenceContainer<IMPL_CLASS>>

Type Parameters:

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

All Superinterfaces:

ConferencingObject<IMPL_CLASS>, ConferencingObjectContainer<IMPL_CLASS>

All Known Implementing Classes:

ConferenceQueue, ParticipantCodeGroup

public interface ConferenceContainer<IMPL_CLASS extends ConferenceContainer<IMPL_CLASS>>
extends ConferencingObjectContainer<IMPL_CLASS>

A conferencing object that has EndPoint instances associated with it.

Since:

5.1.0.0.29

Field Summary

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

STATE

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.Collection<Conference>	getConferences() Returns the Conferences of this ConferenceContainer.
java.util.Collection<Conference>	getConferences(Filter<? super Conference>... filters) Returns the Conferences of this ConferenceContainer.
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 interface com.avaya.conferencing.api.acp.control.ConferencingObjectContainer

addChildListener, addChildListener, addChildPropertyChangeListener, addChildPropertyChangeListener, childClassIterator, childIterator, childIterator, findChild, findParents, getAllChildren, getAllChildren, getChildClasses, getChildren, getChildren, 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

Method Detail

addConferencePropertyChangeListener

void addConferencePropertyChangeListener(java.beans.PropertyChangeListener listener)

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

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addConferencePropertyChangeListener

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

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

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

conferenceIterator

java.util.Iterator<Conference> conferenceIterator()

Returns an iterator of the conferences.

Returns:

The iterator.

Since:

5.1.0.0.29

conferenceIterator

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

Returns an iterator of the conferences.

Parameters:

filters - The filters to use.

Returns:

The iterator.

Since:

5.1.1.0.1

findConference

Conference findConference(Reference<Conference> ref)
                          throws UnknownChildObjectException

Find and retrieve the specified Conference.

Parameters:

ref - The Conference reference.

Returns:

The Conference instance.

Throws:

UnknownChildObjectException - if the Conference does not exist.

Since:

5.1.0.0.29

getConferences

java.util.Collection<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.

Returns:

The (possibly empty) immutable collection of Conferences.

Since:

5.1.0.0.29

getConferences

java.util.Collection<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.

Parameters:

filters - The filters to use.

Returns:

The (possibly empty) immutable collection of Conferences.

Since:

5.1.1.0.1

lookupConference

Conference lookupConference(Reference<Conference> ref)

Find and retrieve the specified Conference.

Parameters:

ref - The Conference reference.

Returns:

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

Since:

5.1.0.0.29

removeConferencePropertyChangeListener

void removeConferencePropertyChangeListener(java.beans.PropertyChangeListener listener)

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

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removeConferencePropertyChangeListener

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.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29