com.ibm.soa.parlayx21.call_handling
Interface CallHandling

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
CallHandling_RI
All Known Implementing Classes:
CallHandlingBindingStub, CallHandlingProxy

public interface CallHandling
extends java.rmi.Remote

The CallHandling class provides a rules based processing capability that is accessible to Applications through a set of operations that allow definition of discrete rules.


Method Summary
 void clearRules(java.net.URI[] addresses)
          Clear the call handling rules associated with the addresses specified.
 CallHandlingRules getRules(java.net.URI address)
          Get the call handling rules for an address (the destination for the call).
 void setRules(java.net.URI address, CallHandlingRules rules)
          Set the call handling rules for an address (the destination for the call).
 SetRulesResult[] setRulesForGroup(java.net.URI[] addresses, CallHandlingRules rules)
          Set the call handling rules for multiple addresses (the destination for calls).
 

Method Detail

setRules

void setRules(java.net.URI address,
              CallHandlingRules rules)
              throws java.rmi.RemoteException,
                     PolicyException,
                     ServiceException

Set the call handling rules for an address (the destination for the call). If a set of rules is already in place for the address, then this operation will replace the old rules with the set provided in this operation.

The address may not specify a group. If a group is specified, a PolicyException will be returned.

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.
  * POL0006: Groups not allowed.

Parameters:
address - xsd:anyURI Address to handle calls for
rules - CallHandlingRules Rules to apply for this address
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

setRulesForGroup

SetRulesResult[] setRulesForGroup(java.net.URI[] addresses,
                                  CallHandlingRules rules)
                                  throws java.rmi.RemoteException,
                                         PolicyException,
                                         ServiceException

Set the call handling rules for multiple addresses (the destination for calls). If a set of rules is already in place for any of the addresses, then this operation will replace the old rules with the set provided in this operation.

The addresses may include groups, with members using the 'tel:' and 'sip:' URIs in the manner defined in ES 202 3911 [2]. Wildcards may not be used to specify addresses.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001: Service error.
  * SVC0002: Invalid input value.
  * SVC0004: No valid addresses.
  * SVC0006: Invalid group.

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0006: Groups not allowed.
  * POL0007: Nested groups not allowed.

Parameters:
addresses - xsd:anyURI [1..unbounded] Addresses to handle calls for
rules - CallHandlingRules Rules to apply for these addresses
Returns:
result SetRulesResult [1..unbounded] Result of setup for each of addresses provided
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getRules

CallHandlingRules getRules(java.net.URI address)
                           throws java.rmi.RemoteException,
                                  PolicyException,
                                  ServiceException

Get the call handling rules for an address (the destination for the call).

The address may not specify a group. If a group is specified, a PolicyException will be returned.

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.
  * POL0006: Groups not allowed.

Parameters:
address - xsd:anyURI Address to handle calls for
Returns:
result CallHandlingRules Rules being applied for this address
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

clearRules

void clearRules(java.net.URI[] addresses)
                throws java.rmi.RemoteException,
                       PolicyException,
                       ServiceException

Clear the call handling rules associated with the addresses specified. If no rules have been set for an address, this operation silently ignores the request, and does not return an error or fault message. The addresses may include groups, with members using the 'tel:' and 'sip:' URIs in the manner defined in

ES 202 391-1 [2]. Wildcards may not be used to specify addresses.

Referenced faults

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

PolicyException from ES 202 391-1 [2]:
  * POL0001: Policy error.
  * POL0006: Groups not allowed.
  * POL0007: Nested groups not allowed.

Parameters:
addresses - xsd:anyURI [1..unbounded] Addresses to clear call handling for
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.