org.mobicents.csapi.jr.slee.mm.us
Interface IpUserStatusConnection

All Superinterfaces:

IpServiceConnection

public interface IpUserStatusConnection
extends IpServiceConnection

The application programmer can use this interface to obtain the status of fixed, mobile and IP-based telephony users. This interface shall be implemented by a User Status SCF. The statusReportReq() method, or both the triggeredStatusReportingStartReq() and trigggeredStatusReportingStop() methods shall be implemented as a minimum requirement.

Method Summary

int	statusReportReq(TpAddress[] users) Request for a report on the status of one or several users.
int	triggeredStatusReportingStartReq(TpAddress[] users) Request for triggered status reports when one or several user's status is changed.
void	triggeredStatusReportingStop(TpMobilityStopAssignmentData stopRequest) This method stops the sending of status reports for one or several users.

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

closeConnection

Method Detail

statusReportReq

int statusReportReq(TpAddress[] users)
                    throws TpCommonExceptions,
                           P_UNKNOWN_SUBSCRIBER,
                           P_INFORMATION_NOT_AVAILABLE,
                           P_APPLICATION_NOT_ACTIVATED,
                           javax.slee.resource.ResourceException

Request for a report on the status of one or several users.

Parameters:

users - Specifies the user(s) for which the status shall be reported.

Returns:

assignmentId Specifies the assignment ID of the status-report request.

Throws:

TpCommonExceptions

P_UNKNOWN_SUBSCRIBER

P_INFORMATION_NOT_AVAILABLE

P_APPLICATION_NOT_ACTIVATED

javax.slee.resource.ResourceException

triggeredStatusReportingStartReq

int triggeredStatusReportingStartReq(TpAddress[] users)
                                     throws TpCommonExceptions,
                                            P_UNKNOWN_SUBSCRIBER,
                                            P_INFORMATION_NOT_AVAILABLE,
                                            P_APPLICATION_NOT_ACTIVATED,
                                            javax.slee.resource.ResourceException

Request for triggered status reports when one or several user's status is changed. The user status service will send a report when the status changes.

Parameters:

users - Specifies the user(s) for which the status changes shall be reported.

Returns:

assignmentId Specifies the assignment ID of the triggered status-reporting request.

Throws:

TpCommonExceptions

P_UNKNOWN_SUBSCRIBER

P_INFORMATION_NOT_AVAILABLE

P_APPLICATION_NOT_ACTIVATED

javax.slee.resource.ResourceException

triggeredStatusReportingStop

void triggeredStatusReportingStop(TpMobilityStopAssignmentData stopRequest)
                                  throws TpCommonExceptions,
                                         P_INVALID_ASSIGNMENT_ID,
                                         javax.slee.resource.ResourceException

This method stops the sending of status reports for one or several users.

Parameters:

stopRequest - Specifies how the assignment shall be stopped, i.e. if whole or just parts of the assignment should be stopped.

Throws:

TpCommonExceptions

P_INVALID_ASSIGNMENT_ID

javax.slee.resource.ResourceException