com.ibm.soa.parlayx21.third_party_call
Interface ThirdPartyCall

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
ThirdPartyCall_RI
All Known Implementing Classes:
ThirdPartyCallBindingStub, ThirdPartyCallProxy

public interface ThirdPartyCall
extends java.rmi.Remote

This interface provides the ability to setup, end and determine the status of a call.


Method Summary
 void cancelCallRequest(java.lang.String callIdentifier)
          The invocation of cancelCall cancels the previously requested call identified by callIdentifier.
 void endCall(java.lang.String callIdentifier)
          The invocation of endCall terminates the call identified by callIdentifier.
 CallInformation getCallInformation(java.lang.String callIdentifier)
          The invocation of getCallInformation retrieves the current status, callInformation, of the call identified by CallIdentifier.
 java.lang.String makeCall(java.net.URI callingParty, java.net.URI calledParty, ChargingInformation charging)
          The invocation of makeCall requests to set-up a voice call between two addresses, callingParty and calledParty, provided that the invoking application is allowed to connect them.
 

Method Detail

makeCall

java.lang.String makeCall(java.net.URI callingParty,
                          java.net.URI calledParty,
                          ChargingInformation charging)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException

The invocation of makeCall requests to set-up a voice call between two addresses, callingParty and calledParty, provided that the invoking application is allowed to connect them. Optionally the application can also indicate the charging information (charging).

By invoking this operation the application may monitor the status of the requested call. The returned parameter, callIdentifier, can be used to identify the call. In order to receive the information on call status the application has to explicitly invoke getCallInformation.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.
  * POL0008 - Charging not supported.

Parameters:
callingParty - xsd:anyURI It contains the address of the first user involved in the call
calledParty - xsd:anyURI It contains the address of the second user involved in the call
charging - common:ChargingInformation Charge to apply to the call
Returns:
result xsd:string It identifies a specific call request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getCallInformation

CallInformation getCallInformation(java.lang.String callIdentifier)
                                   throws java.rmi.RemoteException,
                                          PolicyException,
                                          ServiceException

The invocation of getCallInformation retrieves the current status, callInformation, of the call identified by CallIdentifier. This method can be invoked multiple times by the application even if the call has already ended. However, after the call has ended, status information will be available only for a limited period of time that is specified in the service policy 'StatusRetentionTime'.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
callIdentifier - xsd:string It identifies a specific call request
Returns:
result CallInformation It identifies the status of the call
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

endCall

void endCall(java.lang.String callIdentifier)
             throws java.rmi.RemoteException,
                    PolicyException,
                    ServiceException

The invocation of endCall terminates the call identified by callIdentifier. If the call is still in the initial state this method has the same effect as the cancelCall operation.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0261 - Call already terminated.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
callIdentifier - xsd:string It identifies a specific call request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

cancelCallRequest

void cancelCallRequest(java.lang.String callIdentifier)
                       throws java.rmi.RemoteException,
                              PolicyException,
                              ServiceException

The invocation of cancelCall cancels the previously requested call identified by callIdentifier. Note that this method differs from the endCall operation since it only attempts to prevent the call from starting but it does not have any effect if the call has already started.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0260 - Call already connected.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Parameters:
callIdentifier - xsd:string It identifies a specific call request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.