org.mobicents.csapi.jr.slee.ui
Interface IpUIManagerConnection

All Superinterfaces:

IpServiceConnection

public interface IpUIManagerConnection
extends IpServiceConnection

This interface is the 'service manager' interface for the Generic User Interaction Service and provides the management functions to the Generic User Interaction Service. This interface shall be implemented by a Generic User Interaction SCF. The createUI() method, or the createUICall() method, or both the createNotification() and destroyNotification methods, or both the enableNotifications() and disableNotifications() methods shall be implemented as a minimum requirement.

Method Summary

void	changeNotification(int assignmentID, TpUIEventCriteria eventCriteria) This method is used by the application to change the event criteria introduced with createNotification method.
int	createNotification(TpUIEventCriteria eventCriteria) This method is used by the application to install specified notification criteria, for which the reporting is implicitly activated.
TpUIIdentifier	createUI(TpAddress userAddress) This method is used to create a new user interaction object for non-call related purposes Results: userInteraction Specifies the interface and sessionID of the user interaction created.
TpUICallIdentifier	createUICall(TpUITargetObject uiTargetObject) This method is used to create a new user interaction object for call related purposes.
void	destroyNotification(int assignmentID) This method is used by the application to destroy previously installed notification criteria via the createNotification method.
void	disableNotifications() This method is used to indicate that the application is not able to receive notifications for which the provisioning has been done from within the network.
int	enableNotifications() This method is used to indicate that the application is able to receive notifications which are provisioned from within the network (i.e. these notifications are NOT set using createNotification() but via, for instance, a network management system).
IpUICallConnection	getIpUICallConnection(TpUICallIdentifier uICallIdentifier) Obtains Access To a IpUICallConnection interface
IpUIConnection	getIpUIConnection(TpUIIdentifier uIIdentifier) Obtains Access To a IpUIConnection interface
TpUIEventCriteriaResult[]	getNotification() This method is used by the application to query the event criteria set with createNotification or changeNotification.

Methods inherited from interface org.mobicents.csapi.jr.slee.IpServiceConnection

closeConnection

Method Detail

getIpUIConnection

IpUIConnection getIpUIConnection(TpUIIdentifier uIIdentifier)
                                 throws javax.slee.resource.ResourceException

Obtains Access To a IpUIConnection interface

Returns:

A IpUIConnection interface

Throws:

ResourceException - If it is not possible to create the connection

createUI

TpUIIdentifier createUI(TpAddress userAddress)
                        throws TpCommonExceptions,
                               P_INVALID_NETWORK_STATE,
                               javax.slee.resource.ResourceException

This method is used to create a new user interaction object for non-call related purposes Results: userInteraction Specifies the interface and sessionID of the user interaction created.

Parameters:

userAddress - Indicates the end-user with whom to interact.

Throws:

TpCommonExceptions

P_INVALID_NETWORK_STATE

javax.slee.resource.ResourceException

getIpUICallConnection

IpUICallConnection getIpUICallConnection(TpUICallIdentifier uICallIdentifier)
                                         throws javax.slee.resource.ResourceException

Obtains Access To a IpUICallConnection interface

Returns:

A IpUICallConnection interface

Throws:

ResourceException - If it is not possible to create the connection

createUICall

TpUICallIdentifier createUICall(TpUITargetObject uiTargetObject)
                                throws TpCommonExceptions,
                                       P_INVALID_NETWORK_STATE,
                                       javax.slee.resource.ResourceException

This method is used to create a new user interaction object for call related purposes. The user interaction can take place to the specified party or to all parties in a call. Note that for certain implementation user interaction can only be performed towards the controlling call party, which shall be the only party in the call.

Parameters:

uiTargetObject - Specifies the object on which to perform the user interaction. This can either be a Call, Multi-party Call or call leg object.

Returns:

userInteraction Specifies the interface and sessionID of the user interaction created.

Throws:

TpCommonExceptions

P_INVALID_NETWORK_STATE

javax.slee.resource.ResourceException

createNotification

int createNotification(TpUIEventCriteria eventCriteria)
                       throws TpCommonExceptions,
                              P_INVALID_CRITERIA,
                              javax.slee.resource.ResourceException

This method is used by the application to install specified notification criteria, for which the reporting is implicitly activated. If some application already requested notifications with criteria that overlap the specified criteria, or the specified criteria overlap with criteria already present in the network (when provisioned from within the network), the request is refused with P_INVALID_CRITERIA. The criteria are said to overlap if both originating and terminating ranges overlap and the same number plan is used and the same servicecode is used. If the same application requests two notifications with exactly the same criteria but different callback references, the second callback will be treated as an additional callback. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used.

Parameters:

eventCriteria - Specifies the event specific criteria used by the application to define the event required, like user address and service code.

Returns:

assignmentID Specifies the ID assigned by the generic user interaction manager interface for this newly installed notification criteria.

Throws:

TpCommonExceptions

P_INVALID_CRITERIA

javax.slee.resource.ResourceException

destroyNotification

void destroyNotification(int assignmentID)
                         throws TpCommonExceptions,
                                P_INVALID_ASSIGNMENT_ID,
                                javax.slee.resource.ResourceException

This method is used by the application to destroy previously installed notification criteria via the createNotification method.

Parameters:

assignmentID - Specifies the assignment ID given by the generic user interaction manager interface when the previous createNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the framework will return the error code P_INVALID_ASSIGNMENT_ID.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException

changeNotification

void changeNotification(int assignmentID,
                        TpUIEventCriteria eventCriteria)
                        throws TpCommonExceptions,
                               P_INVALID_ASSIGNMENT_ID,
                               P_INVALID_CRITERIA,
                               javax.slee.resource.ResourceException

This method is used by the application to change the event criteria introduced with createNotification method. Any stored notification request associated with the specified assignmentID will be replaced with the specified events requested.

Parameters:

assignmentID - Specifies the ID assigned by the manager interface for the event notification.

eventCriteria - Specifies the new set of event criteria used by the application to define the event required. Only events that meet these criteria are reported.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

P_INVALID_CRITERIA

javax.slee.resource.ResourceException

getNotification

TpUIEventCriteriaResult[] getNotification()
                                          throws TpCommonExceptions,
                                                 javax.slee.resource.ResourceException

This method is used by the application to query the event criteria set with createNotification or changeNotification.

Returns:

eventCriteria Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException

enableNotifications

int enableNotifications()
                        throws TpCommonExceptions,
                               javax.slee.resource.ResourceException

This method is used to indicate that the application is able to receive notifications which are provisioned from within the network (i.e. these notifications are NOT set using createNotification() but via, for instance, a network management system). If notifications provisioned for this application are created or changed, the application is unaware of this until the notification is reported. If the same application requests to enable notifications for a second time with a different IpAppUIManager reference (i.e. without first disabling them), the second callback will be treated as an additional callback. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used. When this method is used, it is still possible to use createNotification() for service provider provisioned notifications on the same interface as long as the criteria in the network and provided by createNotification() do not overlap. However, it is NOT recommended to use both mechanisms on the same service manager. The methods changeNotification(), getNotification(), and destroyNotification() do not apply to notifications provisioned in the network and enabled using enableNotifications(). These only apply to notifications created using createNotification().

Returns:

assignmentID: Specifies the ID assigned by the manager interface for this operation. This ID is contained in any reportNotification() that relates to notifications provisioned from within the network.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException

disableNotifications

void disableNotifications()
                          throws TpCommonExceptions,
                                 javax.slee.resource.ResourceException

This method is used to indicate that the application is not able to receive notifications for which the provisioning has been done from within the network. (i.e. these notifications that are NOT set using createNotification() but via, for instance, a network management system). After this method is called, no such notifications are reported anymore.

Throws:

TpCommonExceptions

javax.slee.resource.ResourceException