org.mobicents.csapi.jr.slee.cc.cccs
Interface IpConfCallConnection

All Superinterfaces:

IpMultiMediaCallConnection, IpMultiPartyCallConnection, IpServiceConnection

public interface IpConfCallConnection
extends IpMultiMediaCallConnection

The conference call manages the subconferences. It also provides some convenience methods to hide the fact of multiple subconferences from the applications that do not need it. Note that the conference call always contains one subconference. The following inherited call methods apply to the conference as a whole, with the specified semantics: - setCallback; changes the callback interface reference. - release; releases the entire conference, including all the subconferences and detached legs. - deassignCall; de-assigns the complete conference. No callbacks will be received by the application, either on the conference, or on any of the contained subconferences or call legs. - getInfoReq; request information over the complete conference. The conference duration is defined as the time when the first party joined the conference until when the last party leaves the conference or the conference is released. - setChargePlan; set the chargeplan for the conference. This chargeplan will apply to all the subconferences, unless another chargeplan is explicitly overridden on the subconference. - superviseReq; supervise the duration of the complete conference. - getCallLegs; return all the call legs used within the conference. - superviseVolumeReq; supervises and sets a granted data volume for the conference. Other methods apply to the default subconference. When using multiple subconferences, it is recommended that the application calls these methods directly on the subconference since this makes it more explicit what the effect of the method is: - createAndRouteCallLegReq - createCallLeg This interface shall be implemented by a Conference Call Control SCF. As a minimum requirement, the getSubConferences(), getConferenceAddress() and createSubConference() methods shall be implemented. The minimum required methods from IpMultiPartyCall are also required.

Method Summary

TpSubConfCallIdentifier	createSubConference(TpConfPolicy conferencePolicy) This method is used to create a new subconference.
TpAddress	getConferenceAddress() This method returns the conference address that specifies the address with which the conference can be addressed in case parties are allowed to join the conference.
IpSubConfCallConnection	getIpSubConfCallConnection(TpSubConfCallIdentifier subConfCallIdentifier) Obtains Access To a IpSubConfCallConnection interface
TpSubConfCallIdentifier[]	getSubConferences() This method returns all the subconferences of the conference.
void	leaveMonitorReq() This method is used to request a notification when a party leaves the conference.

Methods inherited from interface org.mobicents.csapi.jr.slee.cc.mmccs.IpMultiMediaCallConnection

superviseVolumeReq

Methods inherited from interface org.mobicents.csapi.jr.slee.cc.mpccs.IpMultiPartyCallConnection

createAndRouteCallLegReq, createCallLeg, deassignCall, getCallLegs, getInfoReq, getIpCallLegConnection, release, setAdviceOfCharge, setChargePlan, superviseReq

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

getSubConferences

TpSubConfCallIdentifier[] getSubConferences()
                                            throws TpCommonExceptions,
                                                   javax.slee.resource.ResourceException

This method returns all the subconferences of the conference.

Returns:

subConferenceList : Specifies the list of all the subconferences of the conference.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException

getIpSubConfCallConnection

IpSubConfCallConnection getIpSubConfCallConnection(TpSubConfCallIdentifier subConfCallIdentifier)
                                                   throws javax.slee.resource.ResourceException

Obtains Access To a IpSubConfCallConnection interface

Returns:

A IpSubConfCallConnection interface

Throws:

ResourceException - If it is not possible to create the connection

createSubConference

TpSubConfCallIdentifier createSubConference(TpConfPolicy conferencePolicy)
                                            throws TpCommonExceptions,
                                                   javax.slee.resource.ResourceException

This method is used to create a new subconference. Note that one subconference is already created together with the conference.

Parameters:

conferencePolicy - Conference Policy to be used in the subconference. Optional; if undefined, the policy of the conference is used. Note that not all policy elements have to be applicable for subconferences.

Returns:

subConference : Specifies the created subconference (interface and sessionID).

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException

leaveMonitorReq

void leaveMonitorReq()
                     throws TpCommonExceptions,
                            javax.slee.resource.ResourceException

This method is used to request a notification when a party leaves the conference.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException

getConferenceAddress

TpAddress getConferenceAddress()
                               throws TpCommonExceptions,
                                      javax.slee.resource.ResourceException

This method returns the conference address that specifies the address with which the conference can be addressed in case parties are allowed to join the conference.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException