org.gsm.oneapi.responsebean.location
Class TerminalLocation

java.lang.Object
  extended by org.gsm.oneapi.responsebean.location.TerminalLocation
All Implemented Interfaces:
java.io.Serializable

public class TerminalLocation
extends java.lang.Object
implements java.io.Serializable

TerminalLocation contains the result of an attempt to locate a single mobile terminal - either successfully or unsuccessfully

See Also:
Serialized Form

Nested Class Summary
static class TerminalLocation.CurrentLocation
          the inner class CurrentLocation contains the location information relating to this mobile terminal
static class TerminalLocation.RequestError
          in the case there is an error raised by the server the details of the error are included within this customised error response
 
Constructor Summary
TerminalLocation()
           
 
Method Summary
 java.lang.String getAddress()
          return the MSISDN of the mobile terminal
 TerminalLocation.CurrentLocation getCurrentLocation()
          return the location details for a successful terminal location request
 TerminalLocation.RequestError getErrorInformation()
          return the errorInformation in case the mobile terminal was not successfully located
 java.lang.String getLocationRetrievalStatus()
          return the status of the location retrieval request
 void setAddress(java.lang.String address)
          set the MSISDN of the mobile terminal.
 void setCurrentLocation(TerminalLocation.CurrentLocation currentLocation)
          set the location details for a successful terminal location request.
 void setErrorInformation(TerminalLocation.RequestError requestError)
          set the errorInformation in case the mobile terminal was not successfully located.
 void setLocationRetrievalStatus(java.lang.String locationRetrievalStatus)
          set the status of the location retrieval request.
 java.lang.String toString()
          generate a textual representation of the TerminalLocation instance including all nested elements and classes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TerminalLocation

public TerminalLocation()
Method Detail

getAddress

public java.lang.String getAddress()
return the MSISDN of the mobile terminal


setAddress

public void setAddress(java.lang.String address)
set the MSISDN of the mobile terminal. This is called internally to set the contents according to the JSON response.


getLocationRetrievalStatus

public java.lang.String getLocationRetrievalStatus()
return the status of the location retrieval request


setLocationRetrievalStatus

public void setLocationRetrievalStatus(java.lang.String locationRetrievalStatus)
set the status of the location retrieval request. This is called internally to set the contents according to the JSON response.


getCurrentLocation

public TerminalLocation.CurrentLocation getCurrentLocation()
return the location details for a successful terminal location request


setCurrentLocation

public void setCurrentLocation(TerminalLocation.CurrentLocation currentLocation)
set the location details for a successful terminal location request. This is called internally to set the contents according to the JSON response.


getErrorInformation

public TerminalLocation.RequestError getErrorInformation()
return the errorInformation in case the mobile terminal was not successfully located


setErrorInformation

public void setErrorInformation(TerminalLocation.RequestError requestError)
set the errorInformation in case the mobile terminal was not successfully located. This is called internally to set the contents according to the JSON response.


toString

public java.lang.String toString()
generate a textual representation of the TerminalLocation instance including all nested elements and classes

Overrides:
toString in class java.lang.Object