com.spectel.bcapi
Interface GenericConference

All Known Subinterfaces:

Conference, EnterQueue

public interface GenericConference

This interface parents all conference interface types - treating all conferences as generic collections of lines and other resources. All actual conference interfaces should extend this interface. No direct implementations of this interface should be made available.

See Also:

Conference, EnterQueue

Field Summary

static java.lang.String	CONF_NAME The name of the conference.
static java.lang.String	CONFERENCE_ID The identifier for the conference.
static java.lang.String	PART_COUNT The number of participants in the conference.
static java.lang.String	RESERVATION_GROUP The identifier for the reservation group associated with this conference.

Method Summary

void	deRegister(BridgeListener listener) Remove a listener from the Conference.
java.lang.Object	getParameter(java.lang.String key) Get the parameter defined by the given key string.
java.util.Hashtable	getParameters() Gets a Hashtable containing the current state of the Conference object.
Participant	getParticipant(java.lang.String key) Get a participant currently in this conference, the associated subconference, or any associated intercept conferences.
java.util.Vector	getParticipantIds() Get the IDs of participants, including moderators, currently in this conference, and any associated subconferences and intercept conferences.
void	logoff() Logoff to stop receiving events for this conference.
void	register(BridgeListener listener) Register a listener for all events received by this Conference.
void	setAsynchronous() Do not wait for command completion.
void	setSynchronous(long timeout) Sets how long we should wait for command completion.

Field Detail

CONF_NAME

static final java.lang.String CONF_NAME

The name of the conference.

The type of this parameter is String.

This parameter is only available on the Avaya 700/780 Bridge.

See Also:

Constant Field Values

PART_COUNT

static final java.lang.String PART_COUNT

The number of participants in the conference. The "PART_COUNT" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is Integer.

See Also:

Constant Field Values

CONFERENCE_ID

static final java.lang.String CONFERENCE_ID

The identifier for the conference. This value is unique for each active conference on a particular bridge.

The "CONFERENCE_ID" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is String.

See Also:

Constant Field Values

RESERVATION_GROUP

static final java.lang.String RESERVATION_GROUP

The identifier for the reservation group associated with this conference. This value is a one to many relationship with DNIS, one Reservation group for many DNIS values

The "RESERVATION_GROUP" parameter is read-only and can be accessed via the getParameter() method.

The type of this parameter is String.

See Also:

Constant Field Values

Method Detail

getParameters

java.util.Hashtable getParameters()

Gets a Hashtable containing the current state of the Conference object. This returned Hashtable is new each time, and not shared with other callers; modifying it does not change future calls.

Returns:

The Hashtable

getParameter

java.lang.Object getParameter(java.lang.String key)

Get the parameter defined by the given key string.

Parameters:

key - The String value identifying the desired parameter.

Returns:

The parameter associated with the given key, null means not found.

getParticipantIds

java.util.Vector getParticipantIds()

Get the IDs of participants, including moderators, currently in this conference, and any associated subconferences and intercept conferences. This returned Vector is new each time, not shared with other callers, modifying it does not change future calls.

Returns:

list of the participant IDs or an empty Vector if the list is empty or uninitialized.

getParticipant

Participant getParticipant(java.lang.String key)

Get a participant currently in this conference, the associated subconference, or any associated intercept conferences.

Parameters:

key - The participant id.

Returns:

The participants whose ID was passed or null if no such participant.

setAsynchronous

void setAsynchronous()

Do not wait for command completion.

setSynchronous

void setSynchronous(long timeout)

Sets how long we should wait for command completion.

This functionality is only implemented on the Avaya 7000 Bridge

Parameters:

timeout - Milliseconds to wait for command to complete

logoff

void logoff()
            throws BridgeException

Logoff to stop receiving events for this conference.

Throws:

BridgeException - Thrown if there is an internal error while sending the request for change to the bridge.

register

void register(BridgeListener listener)

Register a listener for all events received by this Conference.

Parameters:

listener - The Listener to add.

deRegister

void deRegister(BridgeListener listener)

Remove a listener from the Conference.

Parameters:

listener - The Listener to remove.