com.signalsoftcorp.lst.client
Class MLP300LocationRequest

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

public class MLP300LocationRequest
extends java.lang.Object

Represents a MLP 3.0.0 location request. An instance of this class is passed in a call to WLILocation.getLocation. If one of the request parameters is invalid. you will get a error specified by MLP300Error. see MLP300LocationResponse for more information.\


Constructor Summary
MLP300LocationRequest()
           
 
Method Summary
 int getAltAcc()
          Accuracy of altitude in meters.
 java.lang.String getClientId()
          This is the login id that the client uses when it make calls to LocationStudio
 java.lang.String getClientPwd()
          This is the password that the client uses when it make calls to LocationStudio
 int getHorAcc()
          Requested horizontal accuracy in meters.
 int getLlAcc()
          Longitude and latitude accuracy in seconds.
 java.lang.String getLocType()
          Defines the type of location requested.
 int getMaxLocAge()
          This states the maximum allowable age in seconds of a location sent as a response to a location request.
 MLP300Msid[] getMLP300Msid()
          Returns an array of MLP300Msids.
 java.lang.String getPrioType()
          Defines the priority of a location request.
 java.lang.String getRespReq()
          This field represents response time requirement
 int getRespTimer()
          Defines a timer for the response time (in seconds) within which the current location should be obtained.
 void setAltAcc(int altAcc)
          Accuracy of altitude in meters
 void setClientId(java.lang.String clientId)
          This is the login id that the client uses when it make calls to LocationStudio
 void setClientPwd(java.lang.String clientPwd)
          This is the password that the client uses when it make calls to LocationStudio
 void setHorAcc(int horAcc)
          Requested horizontal accuracy in meters.
 void setLlAcc(int llAcc)
          Longitude and latitude accuracy in seconds.
 void setLocType(java.lang.String locType)
          Defines the type of location requested.
 void setMaxLocAge(int maxLocAge)
          This states the maximum allowable age in seconds of a location sent as a response to a location request.
 void setMLP300Msid(MLP300Msid[] mLP300Msid)
          Sets an array of MLP300Msids.
 void setPrioType(java.lang.String prioType)
          Defines the priority of a location request.
 void setRespReq(java.lang.String respReq)
          This field represents response time requirement
 void setRespTimer(int respTimer)
          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

MLP300LocationRequest

public MLP300LocationRequest()
Method Detail

getMLP300Msid

public MLP300Msid[] getMLP300Msid()
Returns an array of MLP300Msids.
Returns:
MLP300Msid[] Returns an array of MLP300Msids.

setMLP300Msid

public void setMLP300Msid(MLP300Msid[] mLP300Msid)
Sets an array of MLP300Msids.
Parameters:
MLP300Msid[] - Mandatory - The actual subscribers that should positioned.

getClientId

public java.lang.String getClientId()
This is the login id that the client uses when it make calls to LocationStudio
Returns:
clientId.

setClientId

public void setClientId(java.lang.String clientId)
This is the login id that the client uses when it make calls to LocationStudio
Parameters:
clientId - Mandatory - The id that identifies the client in LocationStudio.

getClientPwd

public java.lang.String getClientPwd()
This is the password that the client uses when it make calls to LocationStudio
Returns:
clientPwd.

setClientPwd

public void setClientPwd(java.lang.String clientPwd)
This is the password that the client uses when it make calls to LocationStudio
Parameters:
clientPwd - Mandatory - The password that is used in LocationStudio for authentication.

getRespReq

public java.lang.String getRespReq()

This field represents response time requirement

Valid values
NO_DELAYreturn either initial or last known location of the user
LOW_DELAYreturn the current location with minimum delay. The mobility service shall attempt to fulfill any accuracy requirement, but in doing so shall not add any additional delay.
DELAY_TOLobtain the current location with regard to fulfilling the accuracy

Default value is DELAY_TOL.

Returns:
respResq Optional - This field represents response time requirement

setRespReq

public void setRespReq(java.lang.String respReq)

This field represents response time requirement

Valid values
NO_DELAYreturn either initial or last known location of the user
LOW_DELAYreturn the current location with minimum delay. The mobility service shall attempt to fulfill any accuracy requirement, but in doing so shall not add any additional delay.
DELAY_TOLobtain the current location with regard to fulfilling the accuracy

Default value is DELAY_TOL.

Parameters:
respReq - Optional - This field represents response time requirement

getRespTimer

public int getRespTimer()
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:
respTimer Defines a timer for the response time (in seconds).

setRespTimer

public void setRespTimer(int respTimer)
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.

Default value is 0, meaning that the timeout time is determined by underlaying protocols. setMaxLocAge.

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

getLlAcc

public int getLlAcc()
Longitude and latitude accuracy in seconds.
Returns:
llAcc Longitude and latitude accuracy in seconds.

setLlAcc

public void setLlAcc(int llAcc)
Longitude and latitude accuracy in seconds.

The default value 0 means that this value is undefined.

Parameters:
llAcc - Longitude and latitude accuracy in seconds. Can not be defined (>0) when HorAcc is defined (>0).

getHorAcc

public int getHorAcc()
Requested horizontal accuracy in meters.
Returns:
horAcc. Requested horizontal accuracy in meters.

setHorAcc

public void setHorAcc(int horAcc)
Requested horizontal accuracy in meters.

The default value 0 means that this value is undefined.

Parameters:
horAcc - Requested horizontal accuracy in meters. Can not be defined (>0) when LlAcc is defined (>0).

getAltAcc

public int getAltAcc()
Accuracy of altitude in meters.
Returns:
altAcc Accuracy of altitude in meters

setAltAcc

public void setAltAcc(int altAcc)
Accuracy of altitude in meters

The default value 0 means that this value is undefined.

Parameters:
altAcc - Accuracy of altitude in meters

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.

setLocType

public void setLocType(java.lang.String locType)

Defines the type of location requested.

Valid values
CURRENT After a location attempt has successfully delivered a location estimate, the location estimate is known as the current location at that point in time.
LAST The current location estimate is generally stored in the network until replaced by a later location estimate and is known as the last known location. The last known location may be distinct from the initial location., i.e. more recent.
CURRENT_OR_LAST If a location attempt has successfully delivered, the current location is returned. Otherwise the last known location stored in the network is returned.
Default value: CURRENT
Parameters:
locType - Optional - Defines the type of location requested.

getLocType

public java.lang.String getLocType()

Defines the type of location requested.

Valid values
CURRENT After a location attempt has successfully delivered a location estimate, the location estimate is known as the current location at that point in time.
LAST The current location estimate is generally stored in the network until replaced by a later location estimate and is known as the last known location. The last known location may be distinct from the initial location., i.e. more recent.
CURRENT_OR_LAST If a location attempt has successfully delivered, the current location is returned. Otherwise the last known location stored in the network is returned.
Default value: CURRENT
Returns:
locType Defines the type of location requested.

setPrioType

public void setPrioType(java.lang.String prioType)

Defines the priority of a location request.

Valid values:
NORMAL The request is handled with normal priority
HIGH The request is handled with high priority
Default value: NORMAL
Parameters:
prioType - Optional - Defines the priority of a location request.

getPrioType

public java.lang.String getPrioType()

Defines the priority of a location request.

Valid values:
NORMAL The request is handled with normal priority
HIGH The request is handled with high priority
Default value: NORMAL
Returns:
prioType Defines the priority of a location request.

toString

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


Copyright © SignalSoft Corp. All Rights Reserved.