com.ibm.soa.parlayx21.call_notification
Interface CallNotificationManager

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
CallNotificationManager_RI
All Known Implementing Classes:
CallNotificationManagerBindingStub, CallNotificationManagerProxy

public interface CallNotificationManager
extends java.rmi.Remote

The call notification manager enables applications to set up and tear down notifications for calls online.


Method Summary
 void startCallNotification(SimpleReference reference, java.lang.String[] addresses, CallEvents[] criteria)
          This operation initiates notifications to the application for a given the specified addresses.
 void stopCallNotification(java.lang.String correlator)
          The application may end a call notification using this operation.
 

Method Detail

startCallNotification

void startCallNotification(SimpleReference reference,
                           java.lang.String[] addresses,
                           CallEvents[] criteria)
                           throws java.rmi.RemoteException,
                                  PolicyException,
                                  ServiceException

This operation initiates notifications to the application for a given the specified addresses. The address is an, which are Address Data items as defined in ES 202 391-1 [2].

The correlator provided in the reference must be unique for the application Web Service at the time the notification is initiated, otherwise a fault (SVC0005) will be returned to the application.

The criteria specifies the event-specific criteria used by application to define the call event(s) required. Only events that meet this criteria are notified. If the criteria parameter is not present, all call events will be notified.

Referenced Faults

ServiceException from ES 202 391-1 [2]
  * SVC0001 Service error
  * SVC0002 Invalid input value
  * SVC0005 Duplicate correlator

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

Parameters:
reference - common:SimpleReference Notification endpoint definition
addresses - xsd:anyURI [1..unbounded] Addresses for which to receive notifications
criteria - CallEvents [0..unbounded]

Call events for which a notification is required. If not specified, all call events are notified.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

stopCallNotification

void stopCallNotification(java.lang.String correlator)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
The application may end a call notification using this operation.

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:
correlator - xsd:string Correlator of request to end
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.