|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.panama.mp.PositionResult
PositionResult class. A PositionResult object represents the result returned by mobile positioner. A PositionResult object mainly contains one or more PositionArea
objects, each of which represents an area that the mobile device is located. Certain positioning providers locate a mobile device in only one area or at one point.
A PositionResult contains either an error (including an ID and a message) or a successful result value (including position areas, the mobile station's id, a time stamp and the provider info). After retrieving a PositionResult from a positioning server, you should first check if the result is an error.
Field Summary | |
static int |
UNKNOWNSUBSCRIBER |
static java.lang.String |
UNKNOWNSUBSCRIBER_STR |
Constructor Summary | |
PositionResult(int errorID, java.lang.String errorMsg, PositionArea[] areas, MPProvider provider, java.lang.String mobileID, java.util.Date timeStamp) Constructor. |
Method Summary | |
int |
getErrorID() Returns the error ID. |
java.lang.String |
getErrorMessage() Returns the error message. |
java.lang.String |
getMobileID() Returns the MobileID of the result. |
PositionArea[] |
getPositionAreas() Get PositionAreas in a positioning result. |
MPProvider |
getProvider() Returns the MP Provider that returns the result. |
java.util.Date |
getTimeStamp() Get the time stamp of the PositionResult. |
void |
setTimeStamp(java.util.Date ts) Set the time stamp of the PositionResult. |
java.lang.String |
toString() Represent a PositionResult as a string. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int UNKNOWNSUBSCRIBER
public static final java.lang.String UNKNOWNSUBSCRIBER_STR
Constructor Detail |
public PositionResult(int errorID, java.lang.String errorMsg, PositionArea[] areas, MPProvider provider, java.lang.String mobileID, java.util.Date timeStamp)
errorID
- An integer representing the error ID. 0 means no error.errorMsg
- A String representing the error message. If there is no error, then errorMsg is either null or empty string.areas
- An array of PositionArea
objects.provider
- An MPProvider
object that provides this result.mobileID
- The ID of the located mobile target.timeStamp
- A Date
object representing the time when the positioning result is generated. Please note this time can be either the exact time that the position result is generated by the positioning server or the time that the position result reaches the server. However in most cases the difference between these two is short.Method Detail |
public int getErrorID()
public java.lang.String getErrorMessage()
public PositionArea[] getPositionAreas()
public MPProvider getProvider()
public java.lang.String getMobileID()
public java.util.Date getTimeStamp()
Date
object representing the time stamp.public void setTimeStamp(java.util.Date ts)
ts
- A Date
object representing the time stamp.public java.lang.String toString()
toString
in class java.lang.Object
|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |