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

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

public interface PeriodicLocationReporting
extends Activity

This interface represents a PeriodicLocationReporting activity object.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Activity
ACTIVE_STATE, IDLE_STATE, INVALID_STATE
 
Method Summary
 void addPeriodicLocationReportingListener(org.csapi.jr.se.mm.ul.PeriodicLocationReportingListener periodicLocationReportingListener)
          Adds a PeriodicLocationReportingListener which is interested in events generated by the PeriodicLocationReporting.
 org.csapi.jr.se.mm.ul.UserLocation getUserLocation()
          Returns a reference to the UserLocation responsible for creation of the PeriodicLocationReporting.
 void periodicLocationReportingStartReq(org.csapi.jr.se.Address[] users, org.csapi.jr.se.mm.LocationRequest request, int reportingInterval)
          Invokes the periodicLocationReportingStartReq() method on the Parlay Gateway.
 void periodicLocationReportingStop(org.csapi.jr.se.mm.MobilityStopAssignmentData stopRequest)
          Invokes the periodicLocationReportingStop() method on the Parlay Gateway.
 void removePeriodicLocationReportingListener(org.csapi.jr.se.mm.ul.PeriodicLocationReportingListener periodicLocationReportingListener)
          Removes a PeriodicLocationReportingListener which is no longer interested events generated by the PeriodicLocationReporting.
 
Methods inherited from interface org.csapi.jr.se.Activity
addActivityStateChangeListener, getState, removeActivityStateChangeListener
 

Method Detail

getUserLocation

public org.csapi.jr.se.mm.ul.UserLocation getUserLocation()
Returns a reference to the UserLocation responsible for creation of the PeriodicLocationReporting.

Returns:
A reference to the UserLocation responsible for creation of the PeriodicLocationReporting.

addPeriodicLocationReportingListener

public void addPeriodicLocationReportingListener(org.csapi.jr.se.mm.ul.PeriodicLocationReportingListener periodicLocationReportingListener)
Adds a PeriodicLocationReportingListener which is interested in events generated by the PeriodicLocationReporting.

Parameters:
periodicLocationReportingListener - A reference to the PeriodicLocationReportingListener which is to be added as a listener.

removePeriodicLocationReportingListener

public void removePeriodicLocationReportingListener(org.csapi.jr.se.mm.ul.PeriodicLocationReportingListener periodicLocationReportingListener)
Removes a PeriodicLocationReportingListener which is no longer interested events generated by the PeriodicLocationReporting.

Parameters:
periodicLocationReportingListener - A reference to the PeriodicLocationReportingListener which is to be removed as a listener.

periodicLocationReportingStartReq

public void periodicLocationReportingStartReq(org.csapi.jr.se.Address[] users,
                                              org.csapi.jr.se.mm.LocationRequest request,
                                              int reportingInterval)
                                       throws PlatformException,
                                              java.lang.IllegalStateException,
                                              CommonException,
                                              InvalidReportingIntervalException,
                                              RequestedAccuracyCannotBeDeliveredException,
                                              RequestedResponseTimeCannotBeDeliveredException,
                                              ApplicationNotActivatedException,
                                              InformationNotAvailableException,
                                              InvalidInterfaceTypeException
Invokes the periodicLocationReportingStartReq() method on the Parlay Gateway.

PlatformException
java.lang.IllegalStateException
CommonException
InvalidReportingIntervalException
RequestedAccuracyCannotBeDeliveredException
RequestedResponseTimeCannotBeDeliveredException
ApplicationNotActivatedException
InformationNotAvailableException
InvalidInterfaceTypeException

periodicLocationReportingStop

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

PlatformException
java.lang.IllegalStateException
CommonException