org.csapi.jr.se.mm
Class UserLocationEmergency

java.lang.Object
  |
  +--org.csapi.jr.se.mm.UserLocationEmergency
All Implemented Interfaces:
java.io.Serializable

public final class UserLocationEmergency
extends java.lang.Object
implements java.io.Serializable

Defines the Sequence of Data Elements that specify the identity and location of an emergency service user. The emergency service user is identified by a combination of UserID, NaESRD, NaESRK and IMEI. NaESRD, NaESRK and IMEI may be provided, if the emergency service user has originated the emergency service call in North America. The horizontal location is defined by an 'ellipsoid point with uncertainty ellipse' (see TpUlExtendedData).

See Also:
Serialized Form

Constructor Summary
UserLocationEmergency()
          Creates a new UserLocationEmergency instance.
UserLocationEmergency(org.csapi.jr.se.mm.MobilityError _statusCode, boolean _userIdPresent, org.csapi.jr.se.Address _userId, boolean _naEsrdPresent, java.lang.String _naEsrd, boolean _naEsrkPresent, java.lang.String _naEsrk, boolean _imeiPresent, java.lang.String _imei, org.csapi.jr.se.mm.UserLocationEmergencyTrigger _triggeringEvent, boolean _geographicalPositionPresent, org.csapi.jr.se.mm.GeographicalPosition _geographicalPosition, boolean _altitudePresent, float _altitude, float _uncertaintyAltitude, boolean _timestampPresent, java.lang.String _timestamp, java.lang.String _usedLocationMethod)
          Creates a new UserLocationEmergency instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 float getAltitude()
          This method returns a altitude.
 boolean getAltitudePresent()
          This method returns a altitudePresent.
 org.csapi.jr.se.mm.GeographicalPosition getGeographicalPosition()
          This method returns a geographicalPosition.
 boolean getGeographicalPositionPresent()
          This method returns a geographicalPositionPresent.
 java.lang.String getImei()
          This method returns a imei.
 boolean getImeiPresent()
          This method returns a imeiPresent.
 java.lang.String getNaEsrd()
          This method returns a naEsrd.
 boolean getNaEsrdPresent()
          This method returns a naEsrdPresent.
 java.lang.String getNaEsrk()
          This method returns a naEsrk.
 boolean getNaEsrkPresent()
          This method returns a naEsrkPresent.
 org.csapi.jr.se.mm.MobilityError getStatusCode()
          This method returns a statusCode.
 java.lang.String getTimestamp()
          This method returns a timestamp.
 boolean getTimestampPresent()
          This method returns a timestampPresent.
 org.csapi.jr.se.mm.UserLocationEmergencyTrigger getTriggeringEvent()
          This method returns a triggeringEvent.
 float getUncertaintyAltitude()
          This method returns a uncertaintyAltitude.
 java.lang.String getUsedLocationMethod()
          This method returns a usedLocationMethod.
 org.csapi.jr.se.Address getUserId()
          This method returns a userId.
 boolean getUserIdPresent()
          This method returns a userIdPresent.
 int hashCode()
          Returns a hashcode value for the object.
 void setAltitude(float altitude)
          This method sets a altitude.
 void setAltitudePresent(boolean altitudePresent)
          This method sets a altitudePresent.
 void setGeographicalPosition(org.csapi.jr.se.mm.GeographicalPosition geographicalPosition)
          This method sets a geographicalPosition.
 void setGeographicalPositionPresent(boolean geographicalPositionPresent)
          This method sets a geographicalPositionPresent.
 void setImei(java.lang.String imei)
          This method sets a imei.
 void setImeiPresent(boolean imeiPresent)
          This method sets a imeiPresent.
 void setNaEsrd(java.lang.String naEsrd)
          This method sets a naEsrd.
 void setNaEsrdPresent(boolean naEsrdPresent)
          This method sets a naEsrdPresent.
 void setNaEsrk(java.lang.String naEsrk)
          This method sets a naEsrk.
 void setNaEsrkPresent(boolean naEsrkPresent)
          This method sets a naEsrkPresent.
 void setStatusCode(org.csapi.jr.se.mm.MobilityError statusCode)
          This method sets a statusCode.
 void setTimestamp(java.lang.String timestamp)
          This method sets a timestamp.
 void setTimestampPresent(boolean timestampPresent)
          This method sets a timestampPresent.
 void setTriggeringEvent(org.csapi.jr.se.mm.UserLocationEmergencyTrigger triggeringEvent)
          This method sets a triggeringEvent.
 void setUncertaintyAltitude(float uncertaintyAltitude)
          This method sets a uncertaintyAltitude.
 void setUsedLocationMethod(java.lang.String usedLocationMethod)
          This method sets a usedLocationMethod.
 void setUserId(org.csapi.jr.se.Address userId)
          This method sets a userId.
 void setUserIdPresent(boolean userIdPresent)
          This method sets a userIdPresent.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserLocationEmergency

public UserLocationEmergency()
Creates a new UserLocationEmergency instance.


UserLocationEmergency

public UserLocationEmergency(org.csapi.jr.se.mm.MobilityError _statusCode,
                             boolean _userIdPresent,
                             org.csapi.jr.se.Address _userId,
                             boolean _naEsrdPresent,
                             java.lang.String _naEsrd,
                             boolean _naEsrkPresent,
                             java.lang.String _naEsrk,
                             boolean _imeiPresent,
                             java.lang.String _imei,
                             org.csapi.jr.se.mm.UserLocationEmergencyTrigger _triggeringEvent,
                             boolean _geographicalPositionPresent,
                             org.csapi.jr.se.mm.GeographicalPosition _geographicalPosition,
                             boolean _altitudePresent,
                             float _altitude,
                             float _uncertaintyAltitude,
                             boolean _timestampPresent,
                             java.lang.String _timestamp,
                             java.lang.String _usedLocationMethod)
Creates a new UserLocationEmergency instance.

Parameters:
_statusCode - Indicator of error.
_userIdPresent - Flag indicating if the user address is present.
_userId - The user address.
_naEsrdPresent - Flag indicating if the NaESRD is present.
_naEsrd - Current NaESRD for the user.
_naEsrkPresent - Flag indicating if the NaESRK is present.
_naEsrk - Current NaESRK for the user.
_imeiPresent - Flag indicating if the IMEI is present.
_imei - IMEI for the user.
_triggeringEvent - The reason for this location report.
_geographicalPositionPresent - Flag indicating if the geographical position is present.
_geographicalPosition - Specification of a position and an area of uncertainty.
_altitudePresent - Flag indicating if the altitude is present.
_altitude - Decimal altitude in meters.
_uncertaintyAltitude - Uncertainty of the altitude.
_timestampPresent - Flag indicating if a timestamp is present.
_timestamp - Timestamp indicating when the request was processed.
_usedLocationMethod - Specifying which location method was used.
Method Detail

getStatusCode

public org.csapi.jr.se.mm.MobilityError getStatusCode()
This method returns a statusCode.

Returns:
a org.csapi.jr.se.mm.MobilityError value

getUserIdPresent

public boolean getUserIdPresent()
This method returns a userIdPresent.

Returns:
a boolean value

getUserId

public org.csapi.jr.se.Address getUserId()
This method returns a userId.

Returns:
a org.csapi.jr.se.Address value

getNaEsrdPresent

public boolean getNaEsrdPresent()
This method returns a naEsrdPresent.

Returns:
a boolean value

getNaEsrd

public java.lang.String getNaEsrd()
This method returns a naEsrd.

Returns:
a String value

getNaEsrkPresent

public boolean getNaEsrkPresent()
This method returns a naEsrkPresent.

Returns:
a boolean value

getNaEsrk

public java.lang.String getNaEsrk()
This method returns a naEsrk.

Returns:
a String value

getImeiPresent

public boolean getImeiPresent()
This method returns a imeiPresent.

Returns:
a boolean value

getImei

public java.lang.String getImei()
This method returns a imei.

Returns:
a String value

getTriggeringEvent

public org.csapi.jr.se.mm.UserLocationEmergencyTrigger getTriggeringEvent()
This method returns a triggeringEvent.

Returns:
a org.csapi.jr.se.mm.UserLocationEmergencyTrigger value

getGeographicalPositionPresent

public boolean getGeographicalPositionPresent()
This method returns a geographicalPositionPresent.

Returns:
a boolean value

getGeographicalPosition

public org.csapi.jr.se.mm.GeographicalPosition getGeographicalPosition()
This method returns a geographicalPosition.

Returns:
a org.csapi.jr.se.mm.GeographicalPosition value

getAltitudePresent

public boolean getAltitudePresent()
This method returns a altitudePresent.

Returns:
a boolean value

getAltitude

public float getAltitude()
This method returns a altitude.

Returns:
a float value

getUncertaintyAltitude

public float getUncertaintyAltitude()
This method returns a uncertaintyAltitude.

Returns:
a float value

getTimestampPresent

public boolean getTimestampPresent()
This method returns a timestampPresent.

Returns:
a boolean value

getTimestamp

public java.lang.String getTimestamp()
This method returns a timestamp.

Returns:
a String value

getUsedLocationMethod

public java.lang.String getUsedLocationMethod()
This method returns a usedLocationMethod.

Returns:
a String value

setStatusCode

public void setStatusCode(org.csapi.jr.se.mm.MobilityError statusCode)
This method sets a statusCode.


setUserIdPresent

public void setUserIdPresent(boolean userIdPresent)
This method sets a userIdPresent.


setUserId

public void setUserId(org.csapi.jr.se.Address userId)
This method sets a userId.


setNaEsrdPresent

public void setNaEsrdPresent(boolean naEsrdPresent)
This method sets a naEsrdPresent.


setNaEsrd

public void setNaEsrd(java.lang.String naEsrd)
This method sets a naEsrd.


setNaEsrkPresent

public void setNaEsrkPresent(boolean naEsrkPresent)
This method sets a naEsrkPresent.


setNaEsrk

public void setNaEsrk(java.lang.String naEsrk)
This method sets a naEsrk.


setImeiPresent

public void setImeiPresent(boolean imeiPresent)
This method sets a imeiPresent.


setImei

public void setImei(java.lang.String imei)
This method sets a imei.


setTriggeringEvent

public void setTriggeringEvent(org.csapi.jr.se.mm.UserLocationEmergencyTrigger triggeringEvent)
This method sets a triggeringEvent.


setGeographicalPositionPresent

public void setGeographicalPositionPresent(boolean geographicalPositionPresent)
This method sets a geographicalPositionPresent.


setGeographicalPosition

public void setGeographicalPosition(org.csapi.jr.se.mm.GeographicalPosition geographicalPosition)
This method sets a geographicalPosition.


setAltitudePresent

public void setAltitudePresent(boolean altitudePresent)
This method sets a altitudePresent.


setAltitude

public void setAltitude(float altitude)
This method sets a altitude.


setUncertaintyAltitude

public void setUncertaintyAltitude(float uncertaintyAltitude)
This method sets a uncertaintyAltitude.


setTimestampPresent

public void setTimestampPresent(boolean timestampPresent)
This method sets a timestampPresent.


setTimestamp

public void setTimestamp(java.lang.String timestamp)
This method sets a timestamp.


setUsedLocationMethod

public void setUsedLocationMethod(java.lang.String usedLocationMethod)
This method sets a usedLocationMethod.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object