org.csapi.jr.se.mm.ul
Interface TriggeredLocationReporting

All Superinterfaces:
Activity, CsapiInterface, java.io.Serializable

public interface TriggeredLocationReporting
extends Activity

This interface represents a TriggeredLocationReporting activity object.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Activity
ACTIVE_STATE, IDLE_STATE, INVALID_STATE
 
Method Summary
 void addTriggeredLocationReportingListener(org.csapi.jr.se.mm.ul.TriggeredLocationReportingListener triggeredLocationReportingListener)
          Adds a TriggeredLocationReportingListener which is interested in events generated by the TriggeredLocationReporting.
 org.csapi.jr.se.mm.ul.TriggeredUserLocation getTriggeredUserLocation()
          Returns a reference to the TriggeredUserLocation responsible for creation of the TriggeredLocationReporting.
 void removeTriggeredLocationReportingListener(org.csapi.jr.se.mm.ul.TriggeredLocationReportingListener triggeredLocationReportingListener)
          Removes a TriggeredLocationReportingListener which is no longer interested events generated by the TriggeredLocationReporting.
 void triggeredLocationReportingStartReq(org.csapi.jr.se.Address[] users, org.csapi.jr.se.mm.LocationRequest request, org.csapi.jr.se.mm.LocationTrigger[] triggers)
          Invokes the triggeredLocationReportingStartReq() method on the Parlay Gateway.
 void triggeredLocationReportingStop(org.csapi.jr.se.mm.MobilityStopAssignmentData stopRequest)
          Invokes the triggeredLocationReportingStop() method on the Parlay Gateway.
 
Methods inherited from interface org.csapi.jr.se.Activity
addActivityStateChangeListener, getState, removeActivityStateChangeListener
 

Method Detail

getTriggeredUserLocation

public org.csapi.jr.se.mm.ul.TriggeredUserLocation getTriggeredUserLocation()
Returns a reference to the TriggeredUserLocation responsible for creation of the TriggeredLocationReporting.

Returns:
A reference to the TriggeredUserLocation responsible for creation of the TriggeredLocationReporting.

addTriggeredLocationReportingListener

public void addTriggeredLocationReportingListener(org.csapi.jr.se.mm.ul.TriggeredLocationReportingListener triggeredLocationReportingListener)
Adds a TriggeredLocationReportingListener which is interested in events generated by the TriggeredLocationReporting.

Parameters:
triggeredLocationReportingListener - A reference to the TriggeredLocationReportingListener which is to be added as a listener.

removeTriggeredLocationReportingListener

public void removeTriggeredLocationReportingListener(org.csapi.jr.se.mm.ul.TriggeredLocationReportingListener triggeredLocationReportingListener)
Removes a TriggeredLocationReportingListener which is no longer interested events generated by the TriggeredLocationReporting.

Parameters:
triggeredLocationReportingListener - A reference to the TriggeredLocationReportingListener which is to be removed as a listener.

triggeredLocationReportingStartReq

public void triggeredLocationReportingStartReq(org.csapi.jr.se.Address[] users,
                                               org.csapi.jr.se.mm.LocationRequest request,
                                               org.csapi.jr.se.mm.LocationTrigger[] triggers)
                                        throws PlatformException,
                                               java.lang.IllegalStateException,
                                               CommonException,
                                               RequestedAccuracyCannotBeDeliveredException,
                                               RequestedResponseTimeCannotBeDeliveredException,
                                               TriggerConditionsNotSubscribedException,
                                               UnknownSubscriberException,
                                               ApplicationNotActivatedException,
                                               InformationNotAvailableException,
                                               InvalidInterfaceTypeException
Invokes the triggeredLocationReportingStartReq() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException
RequestedAccuracyCannotBeDeliveredException
RequestedResponseTimeCannotBeDeliveredException
TriggerConditionsNotSubscribedException
UnknownSubscriberException
ApplicationNotActivatedException
InformationNotAvailableException
InvalidInterfaceTypeException

triggeredLocationReportingStop

public void triggeredLocationReportingStop(org.csapi.jr.se.mm.MobilityStopAssignmentData stopRequest)
                                    throws PlatformException,
                                           java.lang.IllegalStateException,
                                           CommonException
Invokes the triggeredLocationReportingStop() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException