Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Avaya Conferencing Provider API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.AbstractConferencingObject<Conference>
      extended by com.avaya.conferencing.api.acp.control.Conference
All Implemented Interfaces:
ConferencingObject<Conference>, ConferencingObjectContainer<Conference>, EndPointContainer<Conference>
public abstract class Conference
extends AbstractConferencingObject<Conference>
implements EndPointContainer<Conference>

Conference represents a conference call (video and audio).

Since:
5.1.0.0.29

Nested Class Summary
static class Conference.ParticipantAnnouncer
          The Conference.ParticipantAnnouncer is responsible for announcing to the Conference the entry or exit of participants.
 
Field Summary
static java.lang.String ACCOUNT_NUMBER
          The property name for getAccountNumber().
static java.lang.String ACTIVE
          The property name for isActive().
static java.lang.String BILLING_CODE
          The property name for getBillingCode().
static java.lang.String BILLING_CONFERENCE_ID
          The property name for getBillingConferenceId().
static java.lang.String CALL_FLOW
          The property name for getCallFlow().
static java.lang.String CONFEREE_CODES
          The property name for getConfereeCodes().
static java.lang.String CONFIRMATION_CODE
          The property name for getConfirmationCode().
static java.lang.String CROSS_REFERENCE
          The property name for getCrossReference().
static java.lang.String CUSTOM_FIELDS
          The property name for getCustomFields().
static java.lang.String HELP_QUEUE_JOIN_TIME
          The property name for getHelpQueueJoinTime().
static java.lang.String INITIAL_CALL_LIST_URI
          The property name for getInitialCallListURI()
static java.lang.String INTER_CONFERENCING_PROVIDER_ID
          The property name for getInterConferencingProviderId().
static java.lang.String MAX_NUMBER_OF_PARTICIPANTS
          The property name for getMaxNumberOfParticipants()
static java.lang.String MEDIA_SOURCE
          The property name for getMediaSource().
static java.lang.String MESSAGE_SET
          The property name for getMessageSet().
static java.lang.String MODERATOR_CODES
          The property name for getModeratorCodes().
static java.lang.String NAME
          The property name for getName().
static java.lang.String NAME_RECORD_PLAY_MODE
          The property name for getNameRecordPlayMode()
static java.lang.String NOTES
          The property name for getNotes().
static java.lang.String PARENT_CONFERENCE
          The property name for getParentConference().
static java.lang.String PARTICIPANT_CODE_GROUP
          The property name for getParticipantCodeGroup().
static java.lang.String PARTICIPANT_CODES
          The property name for getParticipantCodes().
static java.lang.String PARTICIPANT_ENTRY_ANNOUNCER
          The property name for getParticipantEntryAnnouncer().
static java.lang.String PARTICIPANT_EXIT_ANNOUNCER
          The property name for getParticipantExitAnnouncer().
static java.lang.String RECORD_PLAYBACK_SERVER
          The property name for getRecordPlaybackServer().
static java.lang.String ROOM
          The property name for getRoom().
static java.lang.String SCHEDULED_END_DATETIME
          The property name for getScheduledEndDateTime()
static java.lang.String SCHEDULED_START_DATETIME
          The property name for getScheduledStartDateTime()
static java.lang.String START_TIME
          The property name for getStartTime().
 
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
Conference()
           
 
Method Summary
 void addEndPointListener(ConferenceEndPointListener listener)
          Registers a ConferenceEndPointListener against this Conference instance.
 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.
 EndPointQueue findQueue(Reference<EndPointQueue> ref)
          Find and retrieve the specified Queue.
 Conference findSubconference(Reference<Conference> ref)
          Find and retrieve the specified Subconference.
 java.lang.String getAccountNumber()
          Returns the account number associated with this Conference object.
 java.lang.String getBillingCode()
          Returns the billing code associated with this Conference object.
 java.lang.String getBillingConferenceId()
          Returns the billing conference id (typically a database id for the conference booking) associated with this Conference object.
 ConferenceCallFlow getCallFlow()
          Returns the ConferenceCallFlow for this Conference.
 java.util.Set<java.lang.String> getConfereeCodes()
          Returns the Conferee Codes for this Conference object.
 java.lang.String getConfirmationCode()
          Returns the confirmation code of this Conference object.
 java.lang.String getCrossReference()
          Returns the cross reference code associated with this Conference object.
 java.util.List<java.lang.String> getCustomFields()
          Gets the custom fields associated with the Conference.
 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.
 java.util.Date getHelpQueueJoinTime()
          Gets the time when this Conference joined a help queue or null if the Conference is not in a help queue.
 java.lang.String getInitialCallListURI()
          Returns the URI for the initial call list of the conference, or an empty string if none has been scheduled
 java.lang.String getInterConferencingProviderId()
          Returns either null if this conference is hosted on a single ConferencingProvider or the inter-ConferencingProvider conference id (typically a database id for the conference booking) associated with this Conference object.
 int getMaxNumberOfParticipants()
          Returns the maximum number of participants for this Conference
 MediaSource getMediaSource()
          Returns the musicSource of this Conference object.
 MessageSet getMessageSet()
          Gets the MessageSet associated with this Conference.
 java.util.Set<java.lang.String> getModeratorCodes()
          Returns the (possibly empty) set of Moderator Codes for this Conference object.
 java.lang.String getName()
          Returns the name of this Conference object.
 RecordParticipantNameMode getNameRecordPlayMode()
          Returns the Name record/play mode for the Conference
 java.lang.String getNotes()
          Returns the conference notes associated with this Conference object.
 Conference getParentConference()
          Returns null for a main Conference, or the parent Conference for subconferences.
 ParticipantCodeGroup getParticipantCodeGroup()
          Returns the ParticipantCodeGroup that this Conference belongs to, or null if this conference does not belong to any ParticipantCodeGroup.
 java.util.Set<java.lang.String> getParticipantCodes()
          Returns the Participant Codes of this Conference object, that is the set of codes which end-points must provide in order to participate in the conference.
 Conference.ParticipantAnnouncer getParticipantEntryAnnouncer()
          Gets the Conference.ParticipantAnnouncer used to announce the entry of participants to this Conference.
 Conference.ParticipantAnnouncer getParticipantExitAnnouncer()
          Gets the Conference.ParticipantAnnouncer used to announce the exit of participants from this Conference.
 java.util.Collection<EndPointQueue> getQueues()
          Returns the Queues of this Conference.
 java.util.Collection<EndPointQueue> getQueues(Filter<? super EndPointQueue>... filters)
          Returns the Queues of this Conference matching the specified filters.
 RecordPlaybackServer getRecordPlaybackServer()
          Returns null for a conference that is not recording, or one of the standard.
 Room getRoom()
          In subconferences, this returns the Room to which this subconference belongs for the parent Conference object, for all other Conference objects this will return null.
 java.util.Date getScheduledEndDateTime()
          Returns the scheduled finish time for the Conference
 java.util.Date getScheduledStartDateTime()
          Returns the scheduled start time for the Conference
 java.util.Date getStartTime()
          Return the start time of this Conference.
 java.util.Collection<Conference> getSubconferences()
          Returns the Subconferences of this Conference.
 java.util.Collection<Conference> getSubconferences(Filter<? super Conference>... filters)
          Returns the Subconferences of this Conference matching the specified filters.
 boolean isActive()
          Returns true if the Conference is connected.
 EndPoint lookupEndPoint(Reference<EndPoint> ref)
          Find and retrieve the specified EndPoints.
 EndPointQueue lookupQueue(Reference<EndPointQueue> ref)
          Find and retrieve the specified Queue.
 Conference lookupSubconference(Reference<Conference> ref)
          Find and retrieve the specified Subconference.
 java.util.Iterator<EndPointQueue> queueIterator()
          Returns an iterator of the conference Queues.
 java.util.Iterator<EndPointQueue> queueIterator(Filter<? super EndPointQueue>... filters)
          Returns an iterator of the conference Queues matching the specified filters.
 void removeEndPointListener(ConferenceEndPointListener listener)
          Unregisters a ConferenceEndPointListener previously registered against this Conference instance.
 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.
 java.util.Iterator<Conference> subconferenceIterator()
          Returns an iterator of the conference Subconferences.
 java.util.Iterator<Conference> subconferenceIterator(Filter<? super Conference>... filters)
          Returns an iterator of the conference Subconferences matching the specified filters.
 
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.EndPointContainer
addDTMFListener, removeDTMFListener
 
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.29

CONFEREE_CODES

public static final java.lang.String CONFEREE_CODES
The property name for getConfereeCodes().

Since:
5.1.0.0.32

BILLING_CODE

public static final java.lang.String BILLING_CODE
The property name for getBillingCode().

Since:
5.1.0.0.29

BILLING_CONFERENCE_ID

public static final java.lang.String BILLING_CONFERENCE_ID
The property name for getBillingConferenceId().

Since:
5.1.0.0.40

INTER_CONFERENCING_PROVIDER_ID

public static final java.lang.String INTER_CONFERENCING_PROVIDER_ID
The property name for getInterConferencingProviderId().

Since:
5.1.0.0.42

CONFIRMATION_CODE

public static final java.lang.String CONFIRMATION_CODE
The property name for getConfirmationCode().

Since:
5.1.0.0.29

MODERATOR_CODES

public static final java.lang.String MODERATOR_CODES
The property name for getModeratorCodes().

Since:
5.1.0.0.32

MEDIA_SOURCE

public static final java.lang.String MEDIA_SOURCE
The property name for getMediaSource().

Since:
5.1.0.0.29

ACTIVE

public static final java.lang.String ACTIVE
The property name for isActive().

Since:
5.1.0.0.29

PARENT_CONFERENCE

public static final java.lang.String PARENT_CONFERENCE
The property name for getParentConference().

Since:
5.1.0.0.29

HELP_QUEUE_JOIN_TIME

public static final java.lang.String HELP_QUEUE_JOIN_TIME
The property name for getHelpQueueJoinTime().

Since:
5.1.0.0.38

PARTICIPANT_CODES

public static final java.lang.String PARTICIPANT_CODES
The property name for getParticipantCodes().

Since:
5.1.0.0.32

PARTICIPANT_CODE_GROUP

public static final java.lang.String PARTICIPANT_CODE_GROUP
The property name for getParticipantCodeGroup().

Since:
5.1.0.0.40

CALL_FLOW

public static final java.lang.String CALL_FLOW
The property name for getCallFlow().

Since:
5.1.0.0.29

MESSAGE_SET

public static final java.lang.String MESSAGE_SET
The property name for getMessageSet().

Since:
5.1.0.0.34

PARTICIPANT_ENTRY_ANNOUNCER

public static final java.lang.String PARTICIPANT_ENTRY_ANNOUNCER
The property name for getParticipantEntryAnnouncer().

Since:
5.1.0.0.40

PARTICIPANT_EXIT_ANNOUNCER

public static final java.lang.String PARTICIPANT_EXIT_ANNOUNCER
The property name for getParticipantExitAnnouncer().

Since:
5.1.0.0.40

RECORD_PLAYBACK_SERVER

public static final java.lang.String RECORD_PLAYBACK_SERVER
The property name for getRecordPlaybackServer().

Since:
5.1.0.0.42

CUSTOM_FIELDS

public static final java.lang.String CUSTOM_FIELDS
The property name for getCustomFields().

Since:
5.1.0.0.34

ACCOUNT_NUMBER

public static final java.lang.String ACCOUNT_NUMBER
The property name for getAccountNumber().

Since:
5.1.0.0.38

CROSS_REFERENCE

public static final java.lang.String CROSS_REFERENCE
The property name for getCrossReference().

Since:
5.1.0.0.38

NOTES

public static final java.lang.String NOTES
The property name for getNotes().

Since:
5.1.0.0.38

START_TIME

public static final java.lang.String START_TIME
The property name for getStartTime().

Since:
5.1.0.0.38

ROOM

public static final java.lang.String ROOM
The property name for getRoom().

Since:
5.1.0.0.38

INITIAL_CALL_LIST_URI

public static final java.lang.String INITIAL_CALL_LIST_URI
The property name for getInitialCallListURI()

Since:
5.1.0.0.41

SCHEDULED_START_DATETIME

public static final java.lang.String SCHEDULED_START_DATETIME
The property name for getScheduledStartDateTime()

Since:
5.1.0.0.41

SCHEDULED_END_DATETIME

public static final java.lang.String SCHEDULED_END_DATETIME
The property name for getScheduledEndDateTime()

Since:
5.1.0.0.41

MAX_NUMBER_OF_PARTICIPANTS

public static final java.lang.String MAX_NUMBER_OF_PARTICIPANTS
The property name for getMaxNumberOfParticipants()

Since:
5.1.0.0.42

NAME_RECORD_PLAY_MODE

public static final java.lang.String NAME_RECORD_PLAY_MODE
The property name for getNameRecordPlayMode()

Since:
5.1.0.0.42
Constructor Detail

Conference

public Conference()
Method Detail

addEndPointListener

public final void addEndPointListener(ConferenceEndPointListener listener)
Registers a ConferenceEndPointListener against this Conference instance.

Parameters:
listener - The ConferenceEndPointListener.
Since:
5.1.0.0.29

findQueue

public final EndPointQueue findQueue(Reference<EndPointQueue> ref)
                              throws UnknownChildObjectException
Find and retrieve the specified Queue.

Parameters:
ref - The Queue reference.
Returns:
The Queue instance.
Throws:
UnknownChildObjectException - if the Queue does not exist.
Since:
5.1.0.0.29

findSubconference

public final Conference findSubconference(Reference<Conference> ref)
                                   throws UnknownChildObjectException
Find and retrieve the specified Subconference.

Parameters:
ref - The Subconference reference.
Returns:
The Subconference instance.
Throws:
UnknownChildObjectException - if the Subconference does not exist.
Since:
5.1.0.0.29

getAccountNumber

public final java.lang.String getAccountNumber()
Returns the account number associated with this Conference object.

Returns:
The account number associated with this Conference object.
Since:
5.1.0.0.38

getBillingCode

public final java.lang.String getBillingCode()
Returns the billing code associated with this Conference object.

Returns:
The billing code associated with this Conference object.
Since:
5.1.0.0.29

getBillingConferenceId

public final java.lang.String getBillingConferenceId()
Returns the billing conference id (typically a database id for the conference booking) associated with this Conference object.

Returns:
The billing conference id associated with this Conference object.
Since:
5.1.0.0.40

getInterConferencingProviderId

public final java.lang.String getInterConferencingProviderId()
Returns either null if this conference is hosted on a single ConferencingProvider or the inter-ConferencingProvider conference id (typically a database id for the conference booking) associated with this Conference object. When a Conference is distributed across multiple ConferencingProviders using States.CONFERENCING_PROVIDER_LINKs to share the conference media, the INTER_CONFERENCING_PROVIDER_ID can be used to determine which of the Conference instances on each Connection correspond to the same conference media.

Returns:
The billing conference id associated with this Conference object.
Since:
5.1.0.0.42

getCallFlow

public final ConferenceCallFlow getCallFlow()
Returns the ConferenceCallFlow for this Conference.

Returns:
The ConferenceCallFlow for this Conference, will never return null.
Since:
5.1.0.0.29

getConfereeCodes

public final java.util.Set<java.lang.String> getConfereeCodes()
Returns the Conferee Codes for this Conference object.

Returns:
The Conferee Codes for this Conference object.
Since:
5.1.0.0.29

getConfirmationCode

public final java.lang.String getConfirmationCode()
Returns the confirmation code of this Conference object.

Returns:
The confirmation code of this Conference object.
Since:
5.1.0.0.29

getCrossReference

public final java.lang.String getCrossReference()
Returns the cross reference code associated with this Conference object.

Returns:
The cross reference code associated with this Conference object.
Since:
5.1.0.0.38

getCustomFields

public final java.util.List<java.lang.String> getCustomFields()
Gets the custom fields associated with the Conference.

Returns:
the custom fields associated with the Conference.
Since:
5.1.0.0.34

getHelpQueueJoinTime

public final java.util.Date getHelpQueueJoinTime()
Gets the time when this Conference joined a help queue or null if the Conference is not in a help queue.

Returns:
The time when this Conference joined a help queue or null if the Conference is not in a help queue.
Since:
5.1.0.0.38

getMediaSource

public final MediaSource getMediaSource()
Returns the musicSource of this Conference object.

Returns:
The musicSource of this Conference object.
Since:
5.1.0.0.29

getMessageSet

public final MessageSet getMessageSet()
Gets the MessageSet associated with this Conference.

Returns:
The MessageSet associated with this Conference.
Since:
5.1.0.0.34

getParticipantEntryAnnouncer

public final Conference.ParticipantAnnouncer getParticipantEntryAnnouncer()
Gets the Conference.ParticipantAnnouncer used to announce the entry of participants to this Conference.

Returns:
The Conference.ParticipantAnnouncer used to announce the entry of participants to this Conference.
Since:
5.1.0.0.40

getParticipantExitAnnouncer

public final Conference.ParticipantAnnouncer getParticipantExitAnnouncer()
Gets the Conference.ParticipantAnnouncer used to announce the exit of participants from this Conference.

Returns:
The Conference.ParticipantAnnouncer used to announce the exit of participants from this Conference.
Since:
5.1.0.0.40

getModeratorCodes

public final java.util.Set<java.lang.String> getModeratorCodes()
Returns the (possibly empty) set of Moderator Codes for this Conference object.

Returns:
The (possibly empty) set of Moderator Codes for this Conference object.
Since:
5.1.0.0.32

getName

public final java.lang.String getName()
Returns the name of this Conference object.

Returns:
The name of this Conference object.
Since:
5.1.0.0.29

getNotes

public final java.lang.String getNotes()
Returns the conference notes associated with this Conference object.

Returns:
The conference notes associated with this Conference object.
Since:
5.1.0.0.38

getInitialCallListURI

public final java.lang.String getInitialCallListURI()
Returns the URI for the initial call list of the conference, or an empty string if none has been scheduled

Returns:
a String representation of the URI of the call list that has been scheduled to be called on Conference startup
Since:
5.1.0.0.41

getScheduledStartDateTime

public final java.util.Date getScheduledStartDateTime()
Returns the scheduled start time for the Conference

Returns:
a Date representing the time the Conference was scheduled to start, or null if the Conference is not a scheduled Conference.
Since:
5.1.0.0.41

getScheduledEndDateTime

public final java.util.Date getScheduledEndDateTime()
Returns the scheduled finish time for the Conference

Returns:
a Date representing the time the Conference was scheduled to finish, or null if the Conference is not a scheduled one.
Since:
5.1.0.0.41

getParentConference

public final Conference getParentConference()
Returns null for a main Conference, or the parent Conference for subconferences.

Returns:
null for a main Conference, or the parent Conference for subconferences.
Since:
5.1.0.0.29

getParticipantCodes

public final java.util.Set<java.lang.String> getParticipantCodes()
Returns the Participant Codes of this Conference object, that is the set of codes which end-points must provide in order to participate in the conference. Usually the Participant Codes will be the union of the Moderator and Conferee Codes, i.e. 
 assert conference.getParticipantCodes().containsAll(conference.getConfereeCodes());
 assert conference.getParticipantCodes().containsAll(conference.getModeratorCodes());
 Set<String> codes = new HashSet<String>();
 codes.addAll(conference.getConfereeCodes());
 codes.addAll(conference.getModeratorCodes());
 assert conference.getParticipantCodes().equals(codes);
However, if the conference call flow does not allow entry to the conference using the moderator code (and instead allows participants to be promoted to moderator after entering the conference by providing a moderator code), then the Participant Codes will be equal to the Conferee Codes, i.e.
 assert conference.getParticipantCodes().equals(conference.getConfereeCodes());

Returns:
The Participant Codes of this Conference object.
Since:
5.1.0.0.32
See Also:
getParticipantCodeGroup()

getParticipantCodeGroup

public final ParticipantCodeGroup getParticipantCodeGroup()
Returns the ParticipantCodeGroup that this Conference belongs to, or null if this conference does not belong to any ParticipantCodeGroup. Within any ParticipantCodeGroup, if isActive() then the PARTICIPANT_CODES for this Conference instance will be unique for all the active Conference instances in the ParticipantCodeGroup. If getParticipantCodeSpace() == null then getParticipantCodes().isEmpty() however, getParticipantCodes().isEmpty() does not imply getParticipantCodeSpace() == null.

Returns:
The ParticipantCodeGroup that this Conference belongs to, or null if this conference does not belong to any ParticipantCodeGroup.
Since:
5.1.0.0.40

getQueues

public final java.util.Collection<EndPointQueue> getQueues()
Returns the Queues of this Conference. Any implementations may use dynamic function loading to populate this collection of Subconference instances, so collection.isEmpty() is preferred to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Returns:
The (possibly empty) immutable collection of EndPointQueues.
Since:
5.1.0.0.29

getQueues

public final java.util.Collection<EndPointQueue> getQueues(Filter<? super EndPointQueue>... filters)
Returns the Queues of this Conference matching the specified filters. Any implementations may use dynamic function loading to populate this collection of Subconference instances, so collection.isEmpty() is preferred to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Parameters:
filters - The filters.
Returns:
The (possibly empty) immutable collection of EndPointQueues.
Since:
5.1.0.0.29

getRecordPlaybackServer

public final RecordPlaybackServer getRecordPlaybackServer()
Returns null for a conference that is not recording, or one of the standard.

Returns:
The RecordPlaybackServer that is in use for the ongoing recording/playback, null if no ongoing record/playback operation.
Since:
5.1.0.0.42

getRoom

public final Room getRoom()
In subconferences, this returns the Room to which this subconference belongs for the parent Conference object, for all other Conference objects this will return null.

Returns:
In subconferences, this returns the Room to which this subconference belongs for the parent Conference object, for all other Conference objects this will return null.
Since:
5.1.0.0.38

getStartTime

public final java.util.Date getStartTime()
Return the start time of this Conference.

Returns:
the start time of this Conference.
Since:
5.1.0.0.38

getMaxNumberOfParticipants

public final int getMaxNumberOfParticipants()
Returns the maximum number of participants for this Conference

Returns:
the maximum number of participants for this Conference
Since:
5.1.0.0.42

getNameRecordPlayMode

public final RecordParticipantNameMode getNameRecordPlayMode()
Returns the Name record/play mode for the Conference

Returns:
the Name record/play mode for the Conference
Since:
5.1.0.0.42

getSubconferences

public final java.util.Collection<Conference> getSubconferences()
Returns the Subconferences of this Conference. Any implementations may use dynamic function loading to populate this collection of Subconference instances, so collection.isEmpty() is preferable to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Returns:
The (possibly empty) immutable collection of Conferences.
Since:
5.1.0.0.29

getSubconferences

public final java.util.Collection<Conference> getSubconferences(Filter<? super Conference>... filters)
Returns the Subconferences of this Conference matching the specified filters. Any implementations may use dynamic function loading to populate this collection of Subconference instances, so collection.isEmpty() is preferable to 0 == collection.size(). The latter may block the calling thread until the entire collection is loaded.

Parameters:
filters - The filters.
Returns:
The (possibly empty) immutable collection of Conferences.
Since:
5.1.0.0.29

isActive

public final boolean isActive()
Returns true if the Conference is connected.

Returns:
true if the Conference is connected.
Since:
5.1.0.0.29

lookupQueue

public final EndPointQueue lookupQueue(Reference<EndPointQueue> ref)
Find and retrieve the specified Queue.

Parameters:
ref - The Queue reference.
Returns:
The Queue instance or null if the Queue does not exist.
Since:
5.1.0.0.29

lookupSubconference

public final Conference lookupSubconference(Reference<Conference> ref)
Find and retrieve the specified Subconference.

Parameters:
ref - The Subconference reference.
Returns:
The Subconference instance or null if the Subconference does not exist.
Since:
5.1.0.0.29

queueIterator

public final java.util.Iterator<EndPointQueue> queueIterator()
Returns an iterator of the conference Queues.

Returns:
The iterator.
Since:
5.1.0.0.29

queueIterator

public final java.util.Iterator<EndPointQueue> queueIterator(Filter<? super EndPointQueue>... filters)
Returns an iterator of the conference Queues matching the specified filters.

Parameters:
filters - The filters.
Returns:
The iterator.
Since:
5.1.0.0.46

removeEndPointListener

public final void removeEndPointListener(ConferenceEndPointListener listener)
Unregisters a ConferenceEndPointListener previously registered against this Conference instance.

Parameters:
listener - The ConferenceEndPointListener.
Since:
5.1.0.0.29

subconferenceIterator

public final java.util.Iterator<Conference> subconferenceIterator()
Returns an iterator of the conference Subconferences.

Returns:
The iterator.
Since:
5.1.0.0.29

subconferenceIterator

public final java.util.Iterator<Conference> subconferenceIterator(Filter<? super Conference>... filters)
Returns an iterator of the conference Subconferences matching the specified filters.

Parameters:
filters - The filters.
Returns:
The iterator.
Since:
5.1.0.0.29

endPointIterator

public java.util.Iterator<EndPoint> endPointIterator()
Returns an iterator of the conference EndPoints.

Specified by:
endPointIterator in interface EndPointContainer<Conference>
Returns:
The iterator.

endPointIterator

public java.util.Iterator<EndPoint> endPointIterator(Filter<? super EndPoint>... filters)
Returns an iterator of the conference EndPoints.

Specified by:
endPointIterator in interface EndPointContainer<Conference>
Parameters:
filters - The filters to use.
Returns:
The iterator.

findEndPoint

public EndPoint findEndPoint(Reference<EndPoint> ref)
                      throws UnknownChildObjectException
Find and retrieve the specified EndPoint.

Specified by:
findEndPoint in interface EndPointContainer<Conference>
Parameters:
ref - The EndPoint reference.
Returns:
The EndPoint instance.
Throws:
UnknownChildObjectException - if the EndPoint does not exist.

getEndPoints

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

Specified by:
getEndPoints in interface EndPointContainer<Conference>
Returns:
The (possibly empty) immutable collection of EndPoints.

getEndPoints

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

Specified by:
getEndPoints in interface EndPointContainer<Conference>
Parameters:
filters - The filters which must be matched.
Returns:
The (possibly empty) immutable collection of EndPoints.

lookupEndPoint

public EndPoint lookupEndPoint(Reference<EndPoint> ref)
Find and retrieve the specified EndPoints.

Specified by:
lookupEndPoint in interface EndPointContainer<Conference>
Parameters:
ref - The EndPoint reference.
Returns:
The EndPoint instance or null if the EndPoint does not exist.

addEndPointPropertyChangeListener

public void addEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
Registers a PropertyChangeListener against all properties of the EndPoints in this container.

Specified by:
addEndPointPropertyChangeListener in interface EndPointContainer<Conference>
Parameters:
listener - The PropertyChangeListener.

addEndPointPropertyChangeListener

public void addEndPointPropertyChangeListener(java.lang.String property,
                                              java.beans.PropertyChangeListener listener)
Registers a PropertyChangeListener against a specific property of the EndPoints in this container.

Specified by:
addEndPointPropertyChangeListener in interface EndPointContainer<Conference>
Parameters:
property - The property to listen for changes on.
listener - The PropertyChangeListener.

removeEndPointPropertyChangeListener

public void removeEndPointPropertyChangeListener(java.beans.PropertyChangeListener listener)
Unregisters a PropertyChangeListener previously registered against all properties of the EndPoints in this container.

Specified by:
removeEndPointPropertyChangeListener in interface EndPointContainer<Conference>
Parameters:
listener - The PropertyChangeListener.

removeEndPointPropertyChangeListener

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

Specified by:
removeEndPointPropertyChangeListener in interface EndPointContainer<Conference>
Parameters:
property - The property to listen for changes on.
listener - The PropertyChangeListener.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Avaya Conferencing Provider API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2008-2009 Avaya. All Rights Reserved.