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

http://mobicents.googlecode.com/ · Java · 259 lines · 29 code · 26 blank · 204 comment · 0 complexity · 833430ee474c78350077b34445d062da 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.IMEI;
  25. import org.mobicents.protocols.ss7.map.api.primitives.IMSI;
  26. import org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString;
  27. /**
  28. *
  29. * SubscriberLocationReport-Arg ::= SEQUENCE {
  30. * lcs-Event LCS-Event,
  31. * lcs-ClientID LCS-ClientID,
  32. * lcsLocationInfo LCSLocationInfo,
  33. * msisdn [0] ISDN-AddressString OPTIONAL,
  34. * imsi [1] IMSI OPTIONAL,
  35. * imei [2] IMEI OPTIONAL,
  36. * na-ESRD [3] ISDN-AddressString OPTIONAL,
  37. * na-ESRK [4] ISDN-AddressString OPTIONAL,
  38. * locationEstimate [5] Ext-GeographicalInformation OPTIONAL,
  39. * ageOfLocationEstimate [6] AgeOfLocationInformation OPTIONAL,
  40. * slr-ArgExtensionContainer [7] SLR-ArgExtensionContainer OPTIONAL,
  41. * ... ,
  42. * add-LocationEstimate [8] Add-GeographicalInformation OPTIONAL,
  43. * deferredmt-lrData [9] Deferredmt-lrData OPTIONAL,
  44. * lcs-ReferenceNumber [10] LCS-ReferenceNumber OPTIONAL,
  45. * geranPositioningData [11] PositioningDataInformation OPTIONAL,
  46. * utranPositioningData [12] UtranPositioningDataInfo OPTIONAL,
  47. * cellIdOrSai [13] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL,
  48. * h-gmlc-Address [14] GSN-Address OPTIONAL,
  49. * lcsServiceTypeID [15] LCSServiceTypeID OPTIONAL,
  50. * sai-Present [17] NULL OPTIONAL,
  51. * pseudonymIndicator [18] NULL OPTIONAL,
  52. * accuracyFulfilmentIndicator [19] AccuracyFulfilmentIndicator OPTIONAL }
  53. * -- one of msisdn or imsi is mandatory
  54. * -- a location estimate that is valid for the locationEstimate parameter should
  55. * -- be transferred in this parameter in preference to the add-LocationEstimate.
  56. * -- the deferredmt-lrData parameter shall be included if and only if the lcs-Event
  57. * -- indicates a deferredmt-lrResponse.
  58. * -- if the lcs-Event indicates a deferredmt-lrResponse then the locationEstimate
  59. * -- and the add-locationEstimate parameters shall not be sent if the
  60. * -- supportedGADShapes parameter had been received in ProvideSubscriberLocation-Arg
  61. * -- and the shape encoded in locationEstimate or add-LocationEstimate was not marked
  62. * -- as supported in supportedGADShapes. In such a case terminationCause
  63. * -- in deferredmt-lrData shall be present with value
  64. * -- shapeOfLocationEstimateNotSupported.
  65. * -- If a lcs event indicates deferred mt-lr response, the lcs-Reference number shall be
  66. * -- included.
  67. * -- sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity.
  68. *
  69. * @author amit bhayani
  70. *
  71. */
  72. public interface SubscriberLocationReportRequestIndication extends LsmMessage {
  73. public LCSEvent getLCSEvent();
  74. public LCSClientID getLCSClientID();
  75. public LCSLocationInfo getLCSLocationInfo();
  76. public ISDNAddressString getMSISDN();
  77. public IMSI getIMSI();
  78. public IMEI getIMEI();
  79. public ISDNAddressString getNaESRD();
  80. public ISDNAddressString getNaESRK();
  81. /**
  82. * Ext-GeographicalInformation ::= OCTET STRING (SIZE (1..maxExt-GeographicalInformation))
  83. * -- Refers to geographical Information defined in 3GPP TS 23.032.
  84. * -- This is composed of 1 or more octets with an internal structure according to
  85. * -- 3GPP TS 23.032
  86. * -- Octet 1: Type of shape, only the following shapes in 3GPP TS 23.032 are allowed:
  87. * -- (a) Ellipsoid point with uncertainty circle
  88. * -- (b) Ellipsoid point with uncertainty ellipse
  89. * -- (c) Ellipsoid point with altitude and uncertainty ellipsoid
  90. * -- (d) Ellipsoid Arc
  91. * -- (e) Ellipsoid Point
  92. * -- Any other value in octet 1 shall be treated as invalid
  93. * -- Octets 2 to 8 for case (a) – Ellipsoid point with uncertainty circle
  94. * -- Degrees of Latitude 3 octets
  95. * -- Degrees of Longitude 3 octets
  96. * -- Uncertainty code 1 octet
  97. * -- Octets 2 to 11 for case (b) – Ellipsoid point with uncertainty ellipse:
  98. * -- Degrees of Latitude 3 octets
  99. * -- Degrees of Longitude 3 octets
  100. * -- Uncertainty semi-major axis 1 octet
  101. * -- Uncertainty semi-minor axis 1 octet
  102. * -- Angle of major axis 1 octet
  103. * -- Confidence 1 octet
  104. * -- Octets 2 to 14 for case (c) – Ellipsoid point with altitude and uncertainty ellipsoid
  105. * -- Degrees of Latitude 3 octets
  106. * -- Degrees of Longitude 3 octets
  107. * -- Altitude 2 octets
  108. * -- Uncertainty semi-major axis 1 octet
  109. * -- Uncertainty semi-minor axis 1 octet
  110. * -- Angle of major axis 1 octet
  111. * -- Uncertainty altitude 1 octet
  112. * -- Confidence 1 octet
  113. * -- Octets 2 to 13 for case (d) – Ellipsoid Arc
  114. * -- Degrees of Latitude 3 octets
  115. * -- Degrees of Longitude 3 octets
  116. * -- Inner radius 2 octets
  117. * -- Uncertainty radius 1 octet
  118. * -- Offset angle 1 octet
  119. * -- Included angle 1 octet
  120. * -- Confidence 1 octet
  121. * -- Octets 2 to 7 for case (e) – Ellipsoid Point
  122. * -- Degrees of Latitude 3 octets
  123. * -- Degrees of Longitude 3 octets
  124. * --
  125. * -- An Ext-GeographicalInformation parameter comprising more than one octet and
  126. * -- containing any other shape or an incorrect number of octets or coding according
  127. * -- to 3GPP TS 23.032 shall be treated as invalid data by a receiver.
  128. * --
  129. * -- An Ext-GeographicalInformation parameter comprising one octet shall be discarded
  130. * -- by the receiver if an Add-GeographicalInformation parameter is received
  131. * -- in the same message.
  132. * --
  133. * -- An Ext-GeographicalInformation parameter comprising one octet shall be treated as
  134. * -- invalid data by the receiver if an Add-GeographicalInformation parameter is not
  135. * -- received in the same message.
  136. *
  137. * maxExt-GeographicalInformation INTEGER ::= 20
  138. * -- the maximum length allows for further shapes in 3GPP TS 23.032 to be included in later
  139. * -- versions of 3GPP TS 29.002
  140. *
  141. * @return
  142. */
  143. public byte[] getLocationEstimate();
  144. /**
  145. * AgeOfLocationInformation ::= INTEGER (0..32767)
  146. * -- the value represents the elapsed time in minutes since the last
  147. * -- network contact of the mobile station (i.e. the actuality of the
  148. * -- location information).
  149. * -- value “0” indicates that the MS is currently in contact with the
  150. * -- network
  151. * -- value “32767” indicates that the location information is at least
  152. * -- 32767 minutes old
  153. *
  154. * @return
  155. */
  156. public Integer getAgeOfLocationEstimate();
  157. public SLRArgExtensionContainer getSLRArgExtensionContainer();
  158. /**
  159. * Add-GeographicalInformation ::= OCTET STRING (SIZE (1..maxAdd-GeographicalInformation))
  160. * -- Refers to geographical Information defined in 3GPP TS 23.032.
  161. * -- This is composed of 1 or more octets with an internal structure according to
  162. * -- 3GPP TS 23.032
  163. * -- Octet 1: Type of shape, all the shapes defined in 3GPP TS 23.032 are allowed:
  164. * -- Octets 2 to n (where n is the total number of octets necessary to encode the shape
  165. * -- according to 3GPP TS 23.032) are used to encode the shape itself in accordance with the
  166. * -- encoding defined in 3GPP TS 23.032
  167. * --
  168. * -- An Add-GeographicalInformation parameter, whether valid or invalid, received
  169. * -- together with a valid Ext-GeographicalInformation parameter in the same message
  170. * -- shall be discarded.
  171. * --
  172. * -- An Add-GeographicalInformation parameter containing any shape not defined in
  173. * -- 3GPP TS 23.032 or an incorrect number of octets or coding according to
  174. * -- 3GPP TS 23.032 shall be treated as invalid data by a receiver if not received
  175. * -- together with a valid Ext-GeographicalInformation parameter in the same message.
  176. *
  177. *
  178. * maxAdd-GeographicalInformation INTEGER ::= 91
  179. * -- the maximum length allows support for all the shapes currently defined in 3GPP TS
  180. * 23.032
  181. *
  182. * @return
  183. */
  184. public byte[] getAdditionalLocationEstimate();
  185. public DeferredmtlrData getDeferredmtlrData();
  186. /**
  187. * LCS-ReferenceNumber::= OCTET STRING (SIZE(1))
  188. *
  189. * @return
  190. */
  191. public Byte getLCSReferenceNumber();
  192. /**
  193. * PositioningDataInformation ::= OCTET STRING (SIZE (2..maxPositioningDataInformation))
  194. * -- Refers to the Positioning Data defined in 3GPP TS 49.031.
  195. * -- This is composed of 2 or more octets with an internal structure according to
  196. * -- 3GPP TS 49.031.
  197. *
  198. * maxPositioningDataInformation INTEGER ::= 10
  199. *
  200. * @return
  201. */
  202. public byte[] getGeranPositioningData();
  203. /**
  204. * UtranPositioningDataInfo ::= OCTET STRING (SIZE (3..maxUtranPositioningDataInfo))
  205. * -- Refers to the Position Data defined in 3GPP TS 25.413.
  206. * -- This is composed of the positioningDataDiscriminator and the positioningDataSet
  207. * -- included in positionData as defined in 3GPP TS 25.413.
  208. *
  209. * maxUtranPositioningDataInfo INTEGER ::= 11
  210. *
  211. * @return
  212. */
  213. public byte[] getUtranPositioningData();
  214. public CellGlobalIdOrServiceAreaIdOrLAI getCellGlobalIdOrServiceAreaIdOrLAI();
  215. public Boolean getSaiPresent();
  216. /**
  217. * GSN-Address ::= OCTET STRING (SIZE (5..17))
  218. * -- Octets are coded according to TS 3GPP TS 23.003 [17]
  219. *
  220. * @return
  221. */
  222. public byte[] getHGMLCAddress();
  223. /**
  224. * LCSServiceTypeID ::= INTEGER (0..127)
  225. * -- the integer values 0-63 are reserved for Standard LCS service types
  226. * -- the integer values 64-127 are reserved for Non Standard LCS service types
  227. *
  228. * @return
  229. */
  230. public Integer getLCSServiceTypeID();
  231. public Boolean getPseudonymIndicator();
  232. public AccuracyFulfilmentIndicator getAccuracyFulfilmentIndicator();
  233. }