org.mobicents.csapi.jr.slee.mm.ul
Interface IpTriggeredUserLocationConnection

All Superinterfaces:

IpServiceConnection, IpUserLocationConnection

public interface IpTriggeredUserLocationConnection
extends IpUserLocationConnection

This interface can be used as an extended version of the User Location: Service Interface. The triggered user location interface represents the interface to the triggered user location functions. The application programmer can use this interface to request user location reports that are triggered by location change. This interface, or IpUserLocation, shall be implemented by a User Location SCF as a minimum requirement. The triggeredLocationReportingStartReq() and triggeredLocationReportingStop() methods shall be implemented as a minimum requirement. An implementation of IpTriggeredUserLocation is not required to implement the minimum mandatory methods of IpUserLocation.

Method Summary

int	triggeredLocationReportingStartReq(TpAddress[] users, TpLocationRequest request, TpLocationTrigger[] triggers) Request for user location reports when the location is changed (reports are triggered by location change).
void	triggeredLocationReportingStop(TpMobilityStopAssignmentData stopRequest) Stop triggered user location reporting.

Methods inherited from interface org.mobicents.csapi.jr.slee.mm.ul.IpUserLocationConnection

extendedLocationReportReq, locationReportReq, periodicLocationReportingStartReq, periodicLocationReportingStop

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

closeConnection

Method Detail

triggeredLocationReportingStartReq

int triggeredLocationReportingStartReq(TpAddress[] users,
                                       TpLocationRequest request,
                                       TpLocationTrigger[] triggers)
                                       throws TpCommonExceptions,
                                              P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED,
                                              P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED,
                                              P_TRIGGER_CONDITIONS_NOT_SUBSCRIBED,
                                              P_UNKNOWN_SUBSCRIBER,
                                              P_APPLICATION_NOT_ACTIVATED,
                                              P_INFORMATION_NOT_AVAILABLE,
                                              javax.slee.resource.ResourceException

Request for user location reports when the location is changed (reports are triggered by location change).

Parameters:

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

request - Specifies among others the requested location type, accuracy, response time and priority.

triggers - Specifies the trigger conditions.

Returns:

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

Throws:

TpCommonExceptions

P_REQUESTED_ACCURACY_CANNOT_BE_DELIVERED

P_REQUESTED_RESPONSE_TIME_CANNOT_BE_DELIVERED

P_TRIGGER_CONDITIONS_NOT_SUBSCRIBED

P_UNKNOWN_SUBSCRIBER

P_APPLICATION_NOT_ACTIVATED

P_INFORMATION_NOT_AVAILABLE

javax.slee.resource.ResourceException

triggeredLocationReportingStop

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

Stop triggered user location reporting.

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