org.gsm.oneapi.responsebean.location
Class LocationResponse

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

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

The LocationResponse contains all information returned from the OneAPI server given a request to locate one or more mobile terminals

See Also:
Serialized Form

Nested Class Summary
static class LocationResponse.TerminalLocationList
          the array of TerminalLocation responses is contained within the TerminalLocationList inner class
 
Constructor Summary
LocationResponse()
           
 
Method Summary
 java.lang.String getContentType()
          return the HTTP Content-Type returned from the server if available
 int getHTTPResponseCode()
          return the HTTP response code returned from the server
 java.lang.String getLocation()
          return the HTTP location field returned form the server
 RequestError getRequestError()
          return the server generated error response (from the JSON based error response)
 LocationResponse.TerminalLocationList getTerminalLocationList()
          return the actual location responses
 void setContentType(java.lang.String contentType)
          set the HTTP Content-Type header returned by the server
 void setHTTPResponseCode(int httpResponseCode)
          set the stored HTTP response code
 void setLocation(java.lang.String location)
          set the HTTP location field
 void setRequestError(RequestError requestError)
          set the contents of the error response
 void setTerminalLocationList(LocationResponse.TerminalLocationList terminalLocationList)
          set terminalLocationList containing the actual location responses.
 java.lang.String toString()
          generate a textual representation of the LocationResponse 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

LocationResponse

public LocationResponse()
Method Detail

getHTTPResponseCode

public int getHTTPResponseCode()
return the HTTP response code returned from the server


getContentType

public java.lang.String getContentType()
return the HTTP Content-Type returned from the server if available


getRequestError

public RequestError getRequestError()
return the server generated error response (from the JSON based error response)


setHTTPResponseCode

public void setHTTPResponseCode(int httpResponseCode)
set the stored HTTP response code

Parameters:
httpResponseCode - sets the stored HTTP response code

setContentType

public void setContentType(java.lang.String contentType)
set the HTTP Content-Type header returned by the server

Parameters:
contentType - sets the stored HTTP Content-Type header

setRequestError

public void setRequestError(RequestError requestError)
set the contents of the error response

Parameters:
requestError - sets the contents of the error response
See Also:
RequestError

getLocation

public java.lang.String getLocation()
return the HTTP location field returned form the server


setLocation

public void setLocation(java.lang.String location)
set the HTTP location field

Parameters:
location - contents of the HTTP location header

getTerminalLocationList

public LocationResponse.TerminalLocationList getTerminalLocationList()
return the actual location responses


setTerminalLocationList

public void setTerminalLocationList(LocationResponse.TerminalLocationList terminalLocationList)
set terminalLocationList containing the actual location responses. 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 LocationResponse including all nested elements and classes

Overrides:
toString in class java.lang.Object