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

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

public interface UserLocation
extends Service

This interface represents a UserLocation.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addUserLocationListener(org.csapi.jr.se.mm.ul.UserLocationListener userLocationListener)
          Adds a UserLocationListener which is interested in events generated by the UserLocation.
 org.csapi.jr.se.mm.ul.ExtendedLocationReport createExtendedLocationReport()
          Creates a ExtendedLocationReport object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.ul.LocationReport createLocationReport()
          Creates a LocationReport object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.ul.PeriodicLocationReporting createPeriodicLocationReporting()
          Creates a PeriodicLocationReporting object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.PeriodicLocationRequestSetEntry getNextPeriodicLocationRequest(boolean reset)
          Invokes the getNextPeriodicLocationRequest() method on the Parlay Gateway.
 void removeUserLocationListener(org.csapi.jr.se.mm.ul.UserLocationListener userLocationListener)
          Removes a UserLocationListener which is no longer interested in events generated by the UserLocation.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addUserLocationListener

public void addUserLocationListener(org.csapi.jr.se.mm.ul.UserLocationListener userLocationListener)
Adds a UserLocationListener which is interested in events generated by the UserLocation.

Parameters:
userLocationListener - A reference to the UserLocationListener which is to be added as a listener.

removeUserLocationListener

public void removeUserLocationListener(org.csapi.jr.se.mm.ul.UserLocationListener userLocationListener)
Removes a UserLocationListener which is no longer interested in events generated by the UserLocation.

Parameters:
userLocationListener - A reference to the UserLocationListener which is to be removed as a listener.

getNextPeriodicLocationRequest

public org.csapi.jr.se.mm.PeriodicLocationRequestSetEntry getNextPeriodicLocationRequest(boolean reset)
                                                                                  throws PlatformException,
                                                                                         CommonException
Invokes the getNextPeriodicLocationRequest() method on the Parlay Gateway.

PlatformException
CommonException

createLocationReport

public org.csapi.jr.se.mm.ul.LocationReport createLocationReport()
Creates a LocationReport object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the LocationReport interface.

createPeriodicLocationReporting

public org.csapi.jr.se.mm.ul.PeriodicLocationReporting createPeriodicLocationReporting()
Creates a PeriodicLocationReporting object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the PeriodicLocationReporting interface.

createExtendedLocationReport

public org.csapi.jr.se.mm.ul.ExtendedLocationReport createExtendedLocationReport()
Creates a ExtendedLocationReport object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the ExtendedLocationReport interface.