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

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

public interface CallLeg
extends Service

This interface represents a CallLeg.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addCallLegListener(org.csapi.jr.se.cc.mpccs.CallLegListener callLegListener)
          Adds a CallLegListener which is interested in events generated by the CallLeg.
 void attachMediaReq()
          Invokes the attachMediaReq() method on the Parlay Gateway.
 void continueProcessing()
          Invokes the continueProcessing() method on the Parlay Gateway.
 void deassign()
          Invokes the deassign() method on the Parlay Gateway.
 void detachMediaReq()
          Invokes the detachMediaReq() method on the Parlay Gateway.
 void eventReportReq(org.csapi.jr.se.cc.CallEventRequest[] eventsRequested)
          Invokes the eventReportReq() method on the Parlay Gateway.
 org.csapi.jr.se.cc.mpccs.MultiPartyCall getCall()
          Invokes the getCall() method on the Parlay Gateway and returns a reference to a transient interface.
 org.csapi.jr.se.Address getCurrentDestinationAddress()
          Invokes the getCurrentDestinationAddress() method on the Parlay Gateway.
 void getInfoReq(int callLegInfoRequested)
          Invokes the getInfoReq() method on the Parlay Gateway.
 org.csapi.jr.se.cc.mpccs.MultiPartyCall getMultiPartyCall()
          Returns a reference to the MultiPartyCall responsible for creation of the CallLeg.
 org.csapi.jr.se.cc.CallLegProperty[] getProperties(java.lang.String[] propertyNames)
          Invokes the getProperties() method on the Parlay Gateway.
 void release(org.csapi.jr.se.cc.ReleaseCause cause)
          Invokes the release() method on the Parlay Gateway.
 void removeCallLegListener(org.csapi.jr.se.cc.mpccs.CallLegListener callLegListener)
          Removes a CallLegListener which is no longer interested in events generated by the CallLeg.
 void routeReq(org.csapi.jr.se.Address targetAddress, org.csapi.jr.se.Address originatingAddress, org.csapi.jr.se.cc.CallAppInfo[] appInfo, org.csapi.jr.se.cc.CallLegConnectionProperties connectionProperties)
          Invokes the routeReq() method on the Parlay Gateway.
 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 setProperties(org.csapi.jr.se.cc.CallLegProperty[] properties)
          Invokes the setProperties() 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

addCallLegListener

public void addCallLegListener(org.csapi.jr.se.cc.mpccs.CallLegListener callLegListener)
Adds a CallLegListener which is interested in events generated by the CallLeg.

Parameters:
callLegListener - A reference to the CallLegListener which is to be added as a listener.

removeCallLegListener

public void removeCallLegListener(org.csapi.jr.se.cc.mpccs.CallLegListener callLegListener)
Removes a CallLegListener which is no longer interested in events generated by the CallLeg.

Parameters:
callLegListener - A reference to the CallLegListener which is to be removed as a listener.

getMultiPartyCall

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

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

routeReq

public void routeReq(org.csapi.jr.se.Address targetAddress,
                     org.csapi.jr.se.Address originatingAddress,
                     org.csapi.jr.se.cc.CallAppInfo[] appInfo,
                     org.csapi.jr.se.cc.CallLegConnectionProperties connectionProperties)
              throws PlatformException,
                     CommonException,
                     InvalidNetworkStateException,
                     InvalidAddressException,
                     UnsupportedAddressPlanException
Invokes the routeReq() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException
InvalidAddressException
UnsupportedAddressPlanException

eventReportReq

public void eventReportReq(org.csapi.jr.se.cc.CallEventRequest[] eventsRequested)
                    throws PlatformException,
                           CommonException,
                           InvalidEventTypeException,
                           InvalidCriteriaException
Invokes the eventReportReq() method on the Parlay Gateway.

PlatformException
CommonException
InvalidEventTypeException
InvalidCriteriaException

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

getInfoReq

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

PlatformException
CommonException

attachMediaReq

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

PlatformException
CommonException
InvalidNetworkStateException

detachMediaReq

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

PlatformException
CommonException
InvalidNetworkStateException

getCurrentDestinationAddress

public org.csapi.jr.se.Address getCurrentDestinationAddress()
                                                     throws PlatformException,
                                                            CommonException
Invokes the getCurrentDestinationAddress() method on the Parlay Gateway.

PlatformException
CommonException

continueProcessing

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

PlatformException
CommonException
InvalidNetworkStateException

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

deassign

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

PlatformException
CommonException

getProperties

public org.csapi.jr.se.cc.CallLegProperty[] getProperties(java.lang.String[] propertyNames)
                                                   throws PlatformException,
                                                          CommonException,
                                                          InvalidNetworkStateException,
                                                          InformationNotAvailableException,
                                                          UnauthorisedParameterValueException
Invokes the getProperties() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException
InformationNotAvailableException
UnauthorisedParameterValueException

setProperties

public void setProperties(org.csapi.jr.se.cc.CallLegProperty[] properties)
                   throws PlatformException,
                          CommonException,
                          InvalidNetworkStateException,
                          InformationNotAvailableException,
                          UnauthorisedParameterValueException
Invokes the setProperties() method on the Parlay Gateway.

PlatformException
CommonException
InvalidNetworkStateException
InformationNotAvailableException
UnauthorisedParameterValueException

getCall

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

PlatformException
CommonException