com.avaya.conferencing.api.acp.control
Interface EndPointContainer<IMPL_CLASS extends EndPointContainer<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:

Conference, Connection, EndPointQueue

public interface EndPointContainer<IMPL_CLASS extends EndPointContainer<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	addDTMFListener(DTMFListener listener) Registers a DTMFListener against all EndPoints in this container.
void	addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against all properties of the EndPoints in this container.
void	addEndPointPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Registers a PropertyChangeListener against a specific property of the EndPoints in this container.
java.util.Iterator<EndPoint>	endPointIterator() Returns an iterator of the conference EndPoints.
java.util.Iterator<EndPoint>	endPointIterator(Filter<? super EndPoint>... filters) Returns an iterator of the conference EndPoints.
EndPoint	findEndPoint(Reference<EndPoint> ref) Find and retrieve the specified EndPoint.
java.util.Collection<EndPoint>	getEndPoints() Returns the EndPoints of this EndPointContainer.
java.util.Collection<EndPoint>	getEndPoints(Filter<? super EndPoint>... filters) Returns the EndPoints of this EndPointContainer which match a specific Filters.
EndPoint	lookupEndPoint(Reference<EndPoint> ref) Find and retrieve the specified EndPoints.
void	removeDTMFListener(DTMFListener listener) Unregisters a DTMFListener against all EndPoints in this container.
void	removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against all properties of the EndPoints in this container.
void	removeEndPointPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener) Unregisters a PropertyChangeListener previously registered against a specific property of the EndPoints 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

addDTMFListener

void addDTMFListener(DTMFListener listener)

Registers a DTMFListener against all EndPoints in this container.

Parameters:

listener - The listener.

Since:

5.1.0.0.29

addEndPointPropertyChangeListener

void addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)

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

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

addEndPointPropertyChangeListener

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

Registers a PropertyChangeListener against a specific property of the EndPoints in this container.

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

endPointIterator

java.util.Iterator<EndPoint> endPointIterator()

Returns an iterator of the conference EndPoints.

Returns:

The iterator.

Since:

5.1.0.0.29

endPointIterator

java.util.Iterator<EndPoint> endPointIterator(Filter<? super EndPoint>... filters)

Returns an iterator of the conference EndPoints.

Parameters:

filters - The filters to use.

Returns:

The iterator.

Since:

5.1.0.0.29

findEndPoint

EndPoint findEndPoint(Reference<EndPoint> ref)
                      throws UnknownChildObjectException

Find and retrieve the specified EndPoint.

Parameters:

ref - The EndPoint reference.

Returns:

The EndPoint instance.

Throws:

UnknownChildObjectException - if the EndPoint does not exist.

Since:

5.1.0.0.29

getEndPoints

java.util.Collection<EndPoint> getEndPoints()

Returns the EndPoints of this EndPointContainer. 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 EndPoints.

Since:

5.1.0.0.29

getEndPoints

java.util.Collection<EndPoint> getEndPoints(Filter<? super EndPoint>... filters)

Returns the EndPoints of this EndPointContainer which match a specific Filters. 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 which must be matched.

Returns:

The (possibly empty) immutable collection of EndPoints.

Since:

5.1.0.0.29

lookupEndPoint

EndPoint lookupEndPoint(Reference<EndPoint> ref)

Find and retrieve the specified EndPoints.

Parameters:

ref - The EndPoint reference.

Returns:

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

Since:

5.1.0.0.29

removeDTMFListener

void removeDTMFListener(DTMFListener listener)

Unregisters a DTMFListener against all EndPoints in this container.

Parameters:

listener - The listener.

Since:

5.1.0.0.29

removeEndPointPropertyChangeListener

void removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)

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

Parameters:

listener - The PropertyChangeListener.

Since:

5.1.0.0.29

removeEndPointPropertyChangeListener

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

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

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.

Since:

5.1.0.0.29