org.csapi.jr.se.cc.mpccs
Interface MultiPartyCall

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface MultiPartyCall
extends Service

This interface represents a MultiPartyCall.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addMultiPartyCallListener(org.csapi.jr.se.cc.mpccs.MultiPartyCallListener multiPartyCallListener)
          Adds a MultiPartyCallListener which is interested in events generated by the MultiPartyCall.
 org.csapi.jr.se.cc.mpccs.CallLeg createAndRouteCallLegReq(org.csapi.jr.se.cc.CallEventRequest[] eventsRequested, org.csapi.jr.se.Address targetAddress, org.csapi.jr.se.Address originatingAddress, org.csapi.jr.se.cc.CallAppInfo[] appInfo)
          Invokes the createAndRouteCallLegReq() method on the Parlay Gateway and returns a reference to a transient interface.
 org.csapi.jr.se.cc.mpccs.CallLeg createCallLeg()
          Invokes the createCallLeg() method on the Parlay Gateway and returns a reference to a transient interface.
 void deassignCall()
          Invokes the deassignCall() method on the Parlay Gateway.
 org.csapi.jr.se.cc.mpccs.CallLeg[] getCallLegs()
          Invokes the getCallLegs() method on the Parlay Gateway.
 void getInfoReq(int callInfoRequested)
          Invokes the getInfoReq() method on the Parlay Gateway.
 org.csapi.jr.se.cc.mpccs.MultiPartyCallControlManager getMultiPartyCallControlManager()
          Returns a reference to the MultiPartyCallControlManager responsible for creation of the MultiPartyCall.
 void release(org.csapi.jr.se.cc.ReleaseCause cause)
          Invokes the release() method on the Parlay Gateway.
 void removeMultiPartyCallListener(org.csapi.jr.se.cc.mpccs.MultiPartyCallListener multiPartyCallListener)
          Removes a MultiPartyCallListener which is no longer interested in events generated by the MultiPartyCall.
 void setAdviceOfCharge(org.csapi.jr.se.AoCInfo aOCInfo, int tariffSwitch)
          Invokes the setAdviceOfCharge() method on the Parlay Gateway.
 void setChargePlan(org.csapi.jr.se.cc.CallChargePlan callChargePlan)
          Invokes the setChargePlan() method on the Parlay Gateway.
 void superviseReq(int time, int treatment)
          Invokes the superviseReq() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addMultiPartyCallListener

public void addMultiPartyCallListener(org.csapi.jr.se.cc.mpccs.MultiPartyCallListener multiPartyCallListener)
Adds a MultiPartyCallListener which is interested in events generated by the MultiPartyCall.

Parameters:
multiPartyCallListener - A reference to the MultiPartyCallListener which is to be added as a listener.

removeMultiPartyCallListener

public void removeMultiPartyCallListener(org.csapi.jr.se.cc.mpccs.MultiPartyCallListener multiPartyCallListener)
Removes a MultiPartyCallListener which is no longer interested in events generated by the MultiPartyCall.

Parameters:
multiPartyCallListener - A reference to the MultiPartyCallListener which is to be removed as a listener.

getMultiPartyCallControlManager

public org.csapi.jr.se.cc.mpccs.MultiPartyCallControlManager getMultiPartyCallControlManager()
Returns a reference to the MultiPartyCallControlManager responsible for creation of the MultiPartyCall.

Returns:
A reference to the MultiPartyCallControlManager responsible for creation of the MultiPartyCall.

getCallLegs

public org.csapi.jr.se.cc.mpccs.CallLeg[] getCallLegs()
                                               throws PlatformException,
                                                      CommonException
Invokes the getCallLegs() method on the Parlay Gateway.

PlatformException
CommonException

release

public void release(org.csapi.jr.se.cc.ReleaseCause cause)
             throws PlatformException,
                    CommonException,
                    InvalidNetworkStateException
Invokes the release() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException

deassignCall

public void deassignCall()
                  throws PlatformException,
                         CommonException
Invokes the deassignCall() method on the Parlay Gateway.

PlatformException
CommonException

getInfoReq

public void getInfoReq(int callInfoRequested)
                throws PlatformException,
                       CommonException
Invokes the getInfoReq() method on the Parlay Gateway.

PlatformException
CommonException

setChargePlan

public void setChargePlan(org.csapi.jr.se.cc.CallChargePlan callChargePlan)
                   throws PlatformException,
                          CommonException
Invokes the setChargePlan() method on the Parlay Gateway.

PlatformException
CommonException

setAdviceOfCharge

public void setAdviceOfCharge(org.csapi.jr.se.AoCInfo aOCInfo,
                              int tariffSwitch)
                       throws PlatformException,
                              CommonException,
                              InvalidCurrencyException,
                              InvalidAmountException
Invokes the setAdviceOfCharge() method on the Parlay Gateway.

PlatformException
CommonException
InvalidCurrencyException
InvalidAmountException

superviseReq

public void superviseReq(int time,
                         int treatment)
                  throws PlatformException,
                         CommonException
Invokes the superviseReq() method on the Parlay Gateway.

PlatformException
CommonException

createCallLeg

public org.csapi.jr.se.cc.mpccs.CallLeg createCallLeg()
                                               throws PlatformException,
                                                      CommonException,
                                                      InvalidInterfaceTypeException
Invokes the createCallLeg() method on the Parlay Gateway and returns a reference to a transient interface.

PlatformException
CommonException
InvalidInterfaceTypeException

createAndRouteCallLegReq

public org.csapi.jr.se.cc.mpccs.CallLeg createAndRouteCallLegReq(org.csapi.jr.se.cc.CallEventRequest[] eventsRequested,
                                                                 org.csapi.jr.se.Address targetAddress,
                                                                 org.csapi.jr.se.Address originatingAddress,
                                                                 org.csapi.jr.se.cc.CallAppInfo[] appInfo)
                                                          throws PlatformException,
                                                                 CommonException,
                                                                 InvalidInterfaceTypeException,
                                                                 InvalidAddressException,
                                                                 UnsupportedAddressPlanException,
                                                                 InvalidNetworkStateException,
                                                                 InvalidEventTypeException,
                                                                 InvalidCriteriaException
Invokes the createAndRouteCallLegReq() method on the Parlay Gateway and returns a reference to a transient interface.

PlatformException
CommonException
InvalidInterfaceTypeException
InvalidAddressException
UnsupportedAddressPlanException
InvalidNetworkStateException
InvalidEventTypeException
InvalidCriteriaException