/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/lsm/ProvideSubscriberLocationResponseIndication.java

http://mobicents.googlecode.com/ · Java · 203 lines · 15 code · 19 blank · 169 comment · 0 complexity · c7dd39b2c43c5beac88315a71a5d5538 MD5 · raw file

  1. /*
  2. * JBoss, Home of Professional Open Source
  3. * Copyright 2011, Red Hat, Inc. and individual contributors
  4. * by the @authors tag. See the copyright.txt in the distribution for a
  5. * full listing of individual contributors.
  6. *
  7. * This is free software; you can redistribute it and/or modify it
  8. * under the terms of the GNU Lesser General Public License as
  9. * published by the Free Software Foundation; either version 2.1 of
  10. * the License, or (at your option) any later version.
  11. *
  12. * This software is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General Public
  18. * License along with this software; if not, write to the Free
  19. * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20. * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  21. */
  22. package org.mobicents.protocols.ss7.map.api.service.lsm;
  23. import org.mobicents.protocols.ss7.map.api.primitives.CellGlobalIdOrServiceAreaIdOrLAI;
  24. import org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer;
  25. /**
  26. * ProvideSubscriberLocation-Res ::= SEQUENCE {
  27. * locationEstimate Ext-GeographicalInformation,
  28. * ageOfLocationEstimate [0] AgeOfLocationInformation OPTIONAL,
  29. * extensionContainer [1] ExtensionContainer OPTIONAL,
  30. * ... ,
  31. * add-LocationEstimate [2] Add-GeographicalInformation OPTIONAL,
  32. * deferredmt-lrResponseIndicator [3] NULL OPTIONAL,
  33. * geranPositioningData [4] PositioningDataInformation OPTIONAL,
  34. * utranPositioningData [5] UtranPositioningDataInfo OPTIONAL,
  35. * cellIdOrSai [6] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL,
  36. * sai-Present [7] NULL OPTIONAL,
  37. * accuracyFulfilmentIndicator [8] AccuracyFulfilmentIndicator OPTIONAL }
  38. * -- if deferredmt-lrResponseIndicator is set, locationEstimate is ignored.
  39. * -- the add-LocationEstimate parameter shall not be sent to a node that did not indicate the
  40. * -- geographic shapes supported in the ProvideSubscriberLocation-Arg
  41. * -- The locationEstimate and the add-locationEstimate parameters shall not be sent if
  42. * -- the supportedGADShapes parameter has been received in ProvideSubscriberLocation-Arg
  43. * -- and the shape encoded in locationEstimate or add-LocationEstimate is not marked
  44. * -- as supported in supportedGADShapes. In such a case ProvideSubscriberLocation
  45. * -- shall be rejected with error FacilityNotSupported with additional indication
  46. * -- shapeOfLocationEstimateNotSupported.
  47. * -- sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity.
  48. *
  49. * @author amit bhayani
  50. *
  51. */
  52. public interface ProvideSubscriberLocationResponseIndication extends LsmMessage {
  53. /**
  54. * Ext-GeographicalInformation ::= OCTET STRING (SIZE (1..maxExt-GeographicalInformation))
  55. * -- Refers to geographical Information defined in 3GPP TS 23.032.
  56. * -- This is composed of 1 or more octets with an internal structure according to
  57. * -- 3GPP TS 23.032
  58. * -- Octet 1: Type of shape, only the following shapes in 3GPP TS 23.032 are allowed:
  59. * -- (a) Ellipsoid point with uncertainty circle
  60. * -- (b) Ellipsoid point with uncertainty ellipse
  61. * -- (c) Ellipsoid point with altitude and uncertainty ellipsoid
  62. * -- (d) Ellipsoid Arc
  63. * -- (e) Ellipsoid Point
  64. * -- Any other value in octet 1 shall be treated as invalid
  65. * -- Octets 2 to 8 for case (a) – Ellipsoid point with uncertainty circle
  66. * -- Degrees of Latitude 3 octets
  67. * -- Degrees of Longitude 3 octets
  68. * -- Uncertainty code 1 octet
  69. * -- Octets 2 to 11 for case (b) – Ellipsoid point with uncertainty ellipse:
  70. * -- Degrees of Latitude 3 octets
  71. * -- Degrees of Longitude 3 octets
  72. * -- Uncertainty semi-major axis 1 octet
  73. * -- Uncertainty semi-minor axis 1 octet
  74. * -- Angle of major axis 1 octet
  75. * -- Confidence 1 octet
  76. * -- Octets 2 to 14 for case (c) – Ellipsoid point with altitude and uncertainty ellipsoid
  77. * -- Degrees of Latitude 3 octets
  78. * -- Degrees of Longitude 3 octets
  79. * -- Altitude 2 octets
  80. * -- Uncertainty semi-major axis 1 octet
  81. * -- Uncertainty semi-minor axis 1 octet
  82. * -- Angle of major axis 1 octet
  83. * -- Uncertainty altitude 1 octet
  84. * -- Confidence 1 octet
  85. * -- Octets 2 to 13 for case (d) – Ellipsoid Arc
  86. * -- Degrees of Latitude 3 octets
  87. * -- Degrees of Longitude 3 octets
  88. * -- Inner radius 2 octets
  89. * -- Uncertainty radius 1 octet
  90. * -- Offset angle 1 octet
  91. * -- Included angle 1 octet
  92. * -- Confidence 1 octet
  93. * -- Octets 2 to 7 for case (e) – Ellipsoid Point
  94. * -- Degrees of Latitude 3 octets
  95. * -- Degrees of Longitude 3 octets
  96. * --
  97. * -- An Ext-GeographicalInformation parameter comprising more than one octet and
  98. * -- containing any other shape or an incorrect number of octets or coding according
  99. * -- to 3GPP TS 23.032 shall be treated as invalid data by a receiver.
  100. * --
  101. * -- An Ext-GeographicalInformation parameter comprising one octet shall be discarded
  102. * -- by the receiver if an Add-GeographicalInformation parameter is received
  103. * -- in the same message.
  104. * --
  105. * -- An Ext-GeographicalInformation parameter comprising one octet shall be treated as
  106. * -- invalid data by the receiver if an Add-GeographicalInformation parameter is not
  107. * -- received in the same message.
  108. *
  109. *
  110. * maxExt-GeographicalInformation INTEGER ::= 20
  111. * -- the maximum length allows for further shapes in 3GPP TS 23.032 to be included in later
  112. * -- versions of 3GPP TS 29.002
  113. *
  114. * @return
  115. */
  116. public byte[] getLocationEstimate();
  117. /**
  118. * PositioningDataInformation ::= OCTET STRING (SIZE (2..maxPositioningDataInformation))
  119. * -- Refers to the Positioning Data defined in 3GPP TS 49.031.
  120. * -- This is composed of 2 or more octets with an internal structure according to
  121. * -- 3GPP TS 49.031.
  122. *
  123. * maxPositioningDataInformation INTEGER ::= 10
  124. *
  125. * @return
  126. */
  127. public byte[] getGeranPositioningData();
  128. /**
  129. * UtranPositioningDataInfo ::= OCTET STRING (SIZE (3..maxUtranPositioningDataInfo))
  130. * -- Refers to the Position Data defined in 3GPP TS 25.413.
  131. * -- This is composed of the positioningDataDiscriminator and the positioningDataSet
  132. * -- included in positionData as defined in 3GPP TS 25.413.
  133. *
  134. * maxUtranPositioningDataInfo INTEGER ::= 11
  135. *
  136. * @return
  137. */
  138. public byte[] getUtranPositioningData();
  139. /**
  140. * AgeOfLocationInformation ::= INTEGER (0..32767)
  141. * -- the value represents the elapsed time in minutes since the last
  142. * -- network contact of the mobile station (i.e. the actuality of the
  143. * -- location information).
  144. * -- value “0” indicates that the MS is currently in contact with the
  145. * -- network
  146. * -- value “32767” indicates that the location information is at least
  147. * -- 32767 minutes old
  148. *
  149. * @return
  150. */
  151. public Integer getAgeOfLocationEstimate();
  152. /**
  153. * Add-GeographicalInformation ::= OCTET STRING (SIZE (1..maxAdd-GeographicalInformation))
  154. * -- Refers to geographical Information defined in 3GPP TS 23.032.
  155. * -- This is composed of 1 or more octets with an internal structure according to
  156. * -- 3GPP TS 23.032
  157. * -- Octet 1: Type of shape, all the shapes defined in 3GPP TS 23.032 are allowed:
  158. * -- Octets 2 to n (where n is the total number of octets necessary to encode the shape
  159. * -- according to 3GPP TS 23.032) are used to encode the shape itself in accordance with the
  160. * -- encoding defined in 3GPP TS 23.032
  161. * --
  162. * -- An Add-GeographicalInformation parameter, whether valid or invalid, received
  163. * -- together with a valid Ext-GeographicalInformation parameter in the same message
  164. * -- shall be discarded.
  165. * --
  166. * -- An Add-GeographicalInformation parameter containing any shape not defined in
  167. * -- 3GPP TS 23.032 or an incorrect number of octets or coding according to
  168. * -- 3GPP TS 23.032 shall be treated as invalid data by a receiver if not received
  169. * -- together with a valid Ext-GeographicalInformation parameter in the same message.
  170. *
  171. *
  172. * maxAdd-GeographicalInformation INTEGER ::= 91
  173. * -- the maximum length allows support for all the shapes currently defined in 3GPP TS
  174. * 23.032
  175. *
  176. * @return
  177. */
  178. public byte[] getAdditionalLocationEstimate();
  179. public MAPExtensionContainer getExtensionContainer();
  180. public Boolean getDeferredMTLRResponseIndicator();
  181. public CellGlobalIdOrServiceAreaIdOrLAI getCellGlobalIdOrServiceAreaIdOrLAI();
  182. public Boolean getSaiPresent();
  183. public AccuracyFulfilmentIndicator getAccuracyFulfilmentIndicator();
  184. }