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

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