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

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

All Implemented Interfaces:

ConferenceContainer<ParticipantCodeGroup>, ConferencingObject<ParticipantCodeGroup>, ConferencingObjectContainer<ParticipantCodeGroup>

public abstract class ParticipantCodeGroup
extends AbstractConferencingObject<ParticipantCodeGroup>
implements ConferenceContainer<ParticipantCodeGroup>

Conferences identified by Conference.PARTICIPANT_CODES any one instant, the Conference.PARTICIPANT_CODES for a Conference must be unique within the ParticipantCodeGroup to which the Conference belongs.

Since:

5.1.0.0.40

Field Summary

static java.lang.String	DESCRIPTION The property name for getDescription().
static java.lang.String	EXTERNAL_ID The property name for getExternalId().
static java.lang.String	NAME The property name for getName().

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

VERBOSE_TO_STRING

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

STATE

Constructor Summary

ParticipantCodeGroup()

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.
java.lang.String	getDescription() Returns the description of this ParticipantCodeGroup.
java.lang.String	getExternalId() Returns the external ID (typically a database id) for this ParticipantCodeGroup.
java.lang.String	getName() Returns the name of this ParticipantCodeGroup.
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.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

Field Detail

NAME

public static final java.lang.String NAME

The property name for getName().

Since:

5.1.0.0.40

DESCRIPTION

public static final java.lang.String DESCRIPTION

The property name for getDescription().

Since:

5.1.0.0.40

EXTERNAL_ID

public static final java.lang.String EXTERNAL_ID

The property name for getExternalId().

Since:

5.1.0.0.42

Constructor Detail

ParticipantCodeGroup

public ParticipantCodeGroup()

Method Detail

getName

public final java.lang.String getName()

Returns the name of this ParticipantCodeGroup.

Returns:

the name of this ParticipantCodeGroup.

Since:

5.1.0.0.40

getDescription

public final java.lang.String getDescription()

Returns the description of this ParticipantCodeGroup.

Returns:

the name description of this ParticipantCodeGroup.

Since:

5.1.0.0.40

getExternalId

public final java.lang.String getExternalId()

Returns the external ID (typically a database id) for this ParticipantCodeGroup.

Returns:

the external ID (typically a database id) for this ParticipantCodeGroup.

Since:

5.1.0.0.42

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

Parameters:

ref - The Conference reference.

Returns:

The Conference instance.

Throws:

UnknownChildObjectException - if the Conference does not exist.

getConferences

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

Description copied from interface: ConferenceContainer

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<ParticipantCodeGroup>

Returns:

The (possibly empty) immutable collection of Conferences.

getConferences

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

Description copied from interface: ConferenceContainer

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<ParticipantCodeGroup>

Parameters:

filters - The filters to use.

Returns:

The (possibly empty) immutable collection of Conferences.

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

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<ParticipantCodeGroup>

Parameters:

property - The property to listen for changes on.

listener - The PropertyChangeListener.