com.signalsoftcorp.lst.client
Class WLP10LocationRequest

java.lang.Object
  |
  +--com.signalsoftcorp.lst.client.WLP10LocationRequest

public class WLP10LocationRequest
extends java.lang.Object

Represents a simple location request. An instance of this class is passed in a call to WLILocation.getLocation.


Constructor Summary
WLP10LocationRequest()
           
WLP10LocationRequest(SubscriberId[] subscribers, int timeout, int maxLocAge)
           
 
Method Summary
 int getMaxLocAge()
          This states the maximum allowable age in seconds of a location sent as a response to a location request.
 SubscriberId[] getSubscribers()
          Returns an array of SubscriberId representing the subscribers to be located.
 int getTimeout()
          Defines a timer for the response time (in seconds) within which the current location should be obtained.
 void setMaxLocAge(int maxLocAge)
          This states the maximum allowable age in seconds of a location sent as a response to a location request.
 void setSubscribers(SubscriberId[] subscribers)
          Sets an array of SubscriberId representing the subscribers to be located.
 void setTimeout(int timeout)
          Defines a timer for the response time (in seconds) within which the current location should be obtained.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WLP10LocationRequest

public WLP10LocationRequest(SubscriberId[] subscribers,
                            int timeout,
                            int maxLocAge)

WLP10LocationRequest

public WLP10LocationRequest()
Method Detail

getSubscribers

public SubscriberId[] getSubscribers()
Returns an array of SubscriberId representing the subscribers to be located.

setSubscribers

public void setSubscribers(SubscriberId[] subscribers)
Sets an array of SubscriberId representing the subscribers to be located.
Parameters:
subscribers - Madatory - subscriber array containing all subscribers that should be located.

getTimeout

public int getTimeout()
Defines a timer for the response time (in seconds) within which the current location should be obtained. If the timeout is set low we can get a location that does not meet the requirment set by the MaxLocAge parameter. setMaxLocAge.
Returns:
timeout Defines a timer for the response time (in seconds).

setTimeout

public void setTimeout(int timeout)
Defines a timer for the response time (in seconds) within which the current location should be obtained. If the timeout is set low we can get a location that does not meet the requirment set by the MaxLocAge parameter.

The default value 0 means that this value is undefined. setMaxLocAge.

Parameters:
timeout - Defines a timer for the response time (in seconds).

getMaxLocAge

public int getMaxLocAge()
This states the maximum allowable age in seconds of a location sent as a response to a location request. This location information may have been cached somewhere in the system from a previous location update. Even if this is set the response can contain a location that is older than than the maximum allowable age. This occurs when the LocationServer is unable to fulfill the maximum allowable age in a certain time that is dependent on the timeout.
Returns:
maxLocAge This states the maximum allowable age in seconds of a location sent as a response to a location request.

setMaxLocAge

public void setMaxLocAge(int maxLocAge)
This states the maximum allowable age in seconds of a location sent as a response to a location request. This location information may have been cached somewhere in the system from a previous location update. Even if this is set the response can contain a location that is older than than the maximum allowable age. This occurs when the LocationServer is unable to fulfill the maximum allowable age in a certain time that is dependent on the timeout.

The default value 0 means that this value is undefined.

Parameters:
maxLocAge - This states the maximum allowable age in seconds of a location sent as a response to a location request.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © SignalSoft Corp. All Rights Reserved.