com.avaya.conferencing.api.acp.control
Interface ConferencingObjectContainer<T extends ConferencingObjectContainer<T>>

Type Parameters:

T - The type of ConferencingObject that the ConferencingObjectContainer implements.

All Superinterfaces:

ConferencingObject<T>

All Known Subinterfaces:

ConferenceContainer<IMPL_CLASS>, ConferencingObjectQueue<Q,E>, EndPointContainer<IMPL_CLASS>

All Known Implementing Classes:

Conference, ConferenceQueue, Connection, EndPointQueue, ParticipantCodeGroup

public interface ConferencingObjectContainer<T extends ConferencingObjectContainer<T>>
extends ConferencingObject<T>

A ConferencingObject that contains other ConferencingObject instances.

Since:

5.1.0.0.29

Field Summary

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

STATE

Method Summary

void	addChildListener(ChildListener<? super T,? extends ConferencingObject<?>> listener) Registers a ChildListener against all child classes of this ConferencingObject instance.
<S extends ConferencingObject<S>> void	addChildListener(java.lang.Class<S> clazz, ChildListener<? super T,? super S> listener) Registers a ChildListener against the specified child class for this ConferencingObject instance.
<S extends ConferencingObject<S>> void	addChildPropertyChangeListener(java.lang.Class<S> clazz, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of the child ConferencingObject instances of the specified class for this ConferencingObject instance.
<S extends ConferencingObject<S>> void	addChildPropertyChangeListener(java.lang.Class<S> clazz, java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against a specific properties of the child ConferencingObject instances of the specified class for this ConferencingObject instance.
java.util.Iterator<java.lang.Class<? extends ConferencingObject>>	childClassIterator() Returns an iterator over the child ConferencingObject classes that this ConferencingObject is parent to.
<S extends ConferencingObject<S>> java.util.Iterator<S>	childIterator(java.lang.Class<S> clazz) Returns an iterator of the specified class of child objects.
<S extends ConferencingObject<S>> java.util.Iterator<S>	childIterator(java.lang.Class<S> clazz, Filter<? super S>... filters) Returns an iterator of the specified class of child objects.
<S extends ConferencingObject<S>> S	findChild(java.lang.Class<S> clazz, Reference<S> ref) Find and retrieve the specified child object.
<S extends ConferencingObjectContainer<S>,T extends ConferencingObject<T>> java.util.Collection<S>	findParents(java.lang.Class<S> clazz, Reference<T> grandChildRef) Find and retrieve the child objects that are the parents of a specific grandchild of this object.
<S extends ConferencingObject<S>> java.util.Collection<S>	getAllChildren(java.lang.Class<S> clazz) Recursively returns any children of the specified class of child objects including descendants.
<S extends ConferencingObject<S>> java.util.Collection<S>	getAllChildren(java.lang.Class<S> clazz, Filter<? super S>... filters) Recursively returns any children of the specified class of child objects including descendants.
java.util.Set<java.lang.Class<? extends ConferencingObject>>	getChildClasses() Returns the child ConferencingObject classes that this ConferencingObject is parent to.
<S extends ConferencingObject<S>> java.util.Collection<S>	getChildren(java.lang.Class<S> clazz) Returns the children of the specified class of child objects.
<S extends ConferencingObject<S>> java.util.Collection<S>	getChildren(java.lang.Class<S> clazz, Filter<? super S>... filters) Returns the children of the specified class of child objects.
<S extends ConferencingObject<S>> S	lookupChild(java.lang.Class<S> clazz, Reference<S> ref) Find and retrieve the specified child object.
<S extends ConferencingObjectContainer<S>,T extends ConferencingObject<T>> java.util.Collection<S>	lookupParents(java.lang.Class<S> clazz, Reference<T> grandChildRef) Find and retrieve the child objects that are the parents of a specific grandchild of this object.
void	removeChildListener(ChildListener<? super T,? extends ConferencingObject<?>> listener) Unregisters a ChildListener previously registered against all child classes of this ConferencingObject instance.
<S extends ConferencingObject<S>> void	removeChildListener(java.lang.Class<S> clazz, ChildListener<? super T,? super S> listener) Unregisters a ChildListener previously registered against the specified child class for this ConferencingObject instance.
<S extends ConferencingObject<S>> void	removeChildPropertyChangeListener(java.lang.Class<S> clazz, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of the child ConferencingObject instances of the specified class.
<S extends ConferencingObject<S>> void	removeChildPropertyChangeListener(java.lang.Class<S> clazz, java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against a specific property of the child ConferencingObject instances of the specified class for this ConferencingObject instance.

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

addChildListener

void addChildListener(ChildListener<? super T,? extends ConferencingObject<?>> listener)

Registers a ChildListener against all child classes of this ConferencingObject instance.

Parameters:

listener - The ChildListener.

Since:

5.1.0.0.29

addChildListener

<S extends ConferencingObject<S>> void addChildListener(java.lang.Class<S> clazz,
                                                        ChildListener<? super T,? super S> listener)

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

Type Parameters:

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

Parameters:

clazz - The child class.

listener - The ChildListener.

Since:

5.1.0.0.29

addChildPropertyChangeListener

<S extends ConferencingObject<S>> void addChildPropertyChangeListener(java.lang.Class<S> clazz,
                                                                      java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against all properties of the child ConferencingObject instances of the specified class for this ConferencingObject instance.

Type Parameters:

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

Parameters:

clazz - The child class.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addChildPropertyChangeListener

<S extends ConferencingObject<S>> void addChildPropertyChangeListener(java.lang.Class<S> clazz,
                                                                      java.lang.String property,
                                                                      java.beans.PropertyChangeListener listener)

Registers a PropertyChangeListener against a specific properties of the child ConferencingObject instances of the specified class for this ConferencingObject instance.

Type Parameters:

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

Parameters:

clazz - The child class.

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

childClassIterator

java.util.Iterator<java.lang.Class<? extends ConferencingObject>> childClassIterator()

Returns an iterator over the child ConferencingObject classes that this ConferencingObject is parent to.

Returns:

An iterator over the immutable set of ConferencingObject classes that this ConferencingObject is parent to.

Since:

5.1.0.0.29

childIterator

<S extends ConferencingObject<S>> java.util.Iterator<S> childIterator(java.lang.Class<S> clazz)

Returns an iterator of the specified class of child objects.

Type Parameters:

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

Parameters:

clazz - The class of children to get.

Returns:

The iterator.

Since:

5.1.0.0.29

childIterator

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

Returns an iterator of the specified class of child objects.

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 iterator.

Since:

5.1.0.0.29

findChild

<S extends ConferencingObject<S>> S findChild(java.lang.Class<S> clazz,
                                              Reference<S> ref)
                                          throws UnknownChildObjectException

Find and retrieve the specified child object.

Type Parameters:

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

Parameters:

clazz - The child class.

ref - The child reference.

Returns:

The child instance.

Throws:

UnknownChildObjectException - if the child object does not exist.

Since:

5.1.0.0.29

findParents

<S extends ConferencingObjectContainer<S>,T extends ConferencingObject<T>> java.util.Collection<S> findParents(java.lang.Class<S> clazz,
                                                                                                               Reference<T> grandChildRef)
                                                                           throws UnknownChildObjectException

Find and retrieve the child objects that are the parents of a specific grandchild of this object. For example, conference.lookupParents(Conference.class, endpoint) will return the subconference(s) which the EndPoint belongs to. Similarly, connection.lookupParents(EndPointQueue.class, endpoint) will return all the queues of the connection that an EndPoint is in.

Type Parameters:

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

T - The grandchild class. For example EndPoint or Conference.

Parameters:

clazz - The child class.

grandChildRef - The grandchild reference.

Returns:

The immutable collection of children.

Throws:

UnknownChildObjectException - if no matching children exist.

Since:

5.1.0.0.29

getAllChildren

<S extends ConferencingObject<S>> java.util.Collection<S> getAllChildren(java.lang.Class<S> clazz)

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

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

getAllChildren

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

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

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

getChildClasses

java.util.Set<java.lang.Class<? extends ConferencingObject>> getChildClasses()

Returns the child ConferencingObject classes that this ConferencingObject is parent to.

Returns:

The (possibly empty) immutable set of ConferencingObject classes that this ConferencingObject is parent to.

Since:

5.1.0.0.29

getChildren

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

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

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

lookupChild

<S extends ConferencingObject<S>> S lookupChild(java.lang.Class<S> clazz,
                                                Reference<S> ref)

Find and retrieve the specified child object.

Type Parameters:

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

Parameters:

clazz - The child class.

ref - The child reference.

Returns:

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

Since:

5.1.0.0.29

lookupParents

<S extends ConferencingObjectContainer<S>,T extends ConferencingObject<T>> java.util.Collection<S> lookupParents(java.lang.Class<S> clazz,
                                                                                                                 Reference<T> grandChildRef)

Find and retrieve the child objects that are the parents of a specific grandchild of this object. For example, conference.lookupParents(Conference.class, endpoint) will return the subconference(s) which the EndPoint belongs to. Similarly, connection.lookupParents(EndPointQueue.class, EndPoint) will return all the queues of the connection that an EndPoint is in.

Type Parameters:

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

T - The grandchild class. For example EndPoint or Conference.

Parameters:

clazz - The child class.

grandChildRef - The grandchild reference.

Returns:

The (possibly empty) immutable collection of children.

Since:

5.1.0.0.29

removeChildListener

void removeChildListener(ChildListener<? super T,? extends ConferencingObject<?>> listener)

Unregisters a ChildListener previously registered against all child classes of this ConferencingObject instance.

Parameters:

listener - The ChildListener.

Since:

5.1.0.0.29

removeChildListener

<S extends ConferencingObject<S>> void removeChildListener(java.lang.Class<S> clazz,
                                                           ChildListener<? super T,? super S> listener)

Unregisters a ChildListener previously registered against the specified child class for this ConferencingObject instance.

Type Parameters:

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

Parameters:

clazz - The child class.

listener - The ChildListener.

Since:

5.1.0.0.29

removeChildPropertyChangeListener

<S extends ConferencingObject<S>> void removeChildPropertyChangeListener(java.lang.Class<S> clazz,
                                                                         java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against all properties of the child ConferencingObject instances of the specified class.

Type Parameters:

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

Parameters:

clazz - The child class.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removeChildPropertyChangeListener

<S extends ConferencingObject<S>> void removeChildPropertyChangeListener(java.lang.Class<S> clazz,
                                                                         java.lang.String property,
                                                                         java.beans.PropertyChangeListener listener)

Unregisters a PropertyChangeListener previously registered against a specific property of the child ConferencingObject instances of the specified class for this ConferencingObject instance.

Type Parameters:

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

Parameters:

clazz - The child class.

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29