/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/lsm/ProvideSubscriberLocationResponseIndication.java
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 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.MAPExtensionContainer; 27 28/** 29 * ProvideSubscriberLocation-Res ::= SEQUENCE { 30 * locationEstimate Ext-GeographicalInformation, 31 * ageOfLocationEstimate [0] AgeOfLocationInformation OPTIONAL, 32 * extensionContainer [1] ExtensionContainer OPTIONAL, 33 * ... , 34 * add-LocationEstimate [2] Add-GeographicalInformation OPTIONAL, 35 * deferredmt-lrResponseIndicator [3] NULL OPTIONAL, 36 * geranPositioningData [4] PositioningDataInformation OPTIONAL, 37 * utranPositioningData [5] UtranPositioningDataInfo OPTIONAL, 38 * cellIdOrSai [6] CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, 39 * sai-Present [7] NULL OPTIONAL, 40 * accuracyFulfilmentIndicator [8] AccuracyFulfilmentIndicator OPTIONAL } 41 * -- if deferredmt-lrResponseIndicator is set, locationEstimate is ignored. 42 * -- the add-LocationEstimate parameter shall not be sent to a node that did not indicate the 43 * -- geographic shapes supported in the ProvideSubscriberLocation-Arg 44 * -- The locationEstimate and the add-locationEstimate parameters shall not be sent if 45 * -- the supportedGADShapes parameter has been received in ProvideSubscriberLocation-Arg 46 * -- and the shape encoded in locationEstimate or add-LocationEstimate is not marked 47 * -- as supported in supportedGADShapes. In such a case ProvideSubscriberLocation 48 * -- shall be rejected with error FacilityNotSupported with additional indication 49 * -- shapeOfLocationEstimateNotSupported. 50 * -- sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity. 51 * 52 * @author amit bhayani 53 * 54 */ 55public interface ProvideSubscriberLocationResponseIndication extends LsmMessage { 56 57 /** 58 * Ext-GeographicalInformation ::= OCTET STRING (SIZE (1..maxExt-GeographicalInformation)) 59 * -- Refers to geographical Information defined in 3GPP TS 23.032. 60 * -- This is composed of 1 or more octets with an internal structure according to 61 * -- 3GPP TS 23.032 62 * -- Octet 1: Type of shape, only the following shapes in 3GPP TS 23.032 are allowed: 63 * -- (a) Ellipsoid point with uncertainty circle 64 * -- (b) Ellipsoid point with uncertainty ellipse 65 * -- (c) Ellipsoid point with altitude and uncertainty ellipsoid 66 * -- (d) Ellipsoid Arc 67 * -- (e) Ellipsoid Point 68 * -- Any other value in octet 1 shall be treated as invalid 69 * -- Octets 2 to 8 for case (a) Ellipsoid point with uncertainty circle 70 * -- Degrees of Latitude 3 octets 71 * -- Degrees of Longitude 3 octets 72 * -- Uncertainty code 1 octet 73 * -- Octets 2 to 11 for case (b) Ellipsoid point with uncertainty ellipse: 74 * -- Degrees of Latitude 3 octets 75 * -- Degrees of Longitude 3 octets 76 * -- Uncertainty semi-major axis 1 octet 77 * -- Uncertainty semi-minor axis 1 octet 78 * -- Angle of major axis 1 octet 79 * -- Confidence 1 octet 80 * -- Octets 2 to 14 for case (c) Ellipsoid point with altitude and uncertainty ellipsoid 81 * -- Degrees of Latitude 3 octets 82 * -- Degrees of Longitude 3 octets 83 * -- Altitude 2 octets 84 * -- Uncertainty semi-major axis 1 octet 85 * -- Uncertainty semi-minor axis 1 octet 86 * -- Angle of major axis 1 octet 87 * -- Uncertainty altitude 1 octet 88 * -- Confidence 1 octet 89 * -- Octets 2 to 13 for case (d) Ellipsoid Arc 90 * -- Degrees of Latitude 3 octets 91 * -- Degrees of Longitude 3 octets 92 * -- Inner radius 2 octets 93 * -- Uncertainty radius 1 octet 94 * -- Offset angle 1 octet 95 * -- Included angle 1 octet 96 * -- Confidence 1 octet 97 * -- Octets 2 to 7 for case (e) Ellipsoid Point 98 * -- Degrees of Latitude 3 octets 99 * -- Degrees of Longitude 3 octets 100 * -- 101 * -- An Ext-GeographicalInformation parameter comprising more than one octet and 102 * -- containing any other shape or an incorrect number of octets or coding according 103 * -- to 3GPP TS 23.032 shall be treated as invalid data by a receiver. 104 * -- 105 * -- An Ext-GeographicalInformation parameter comprising one octet shall be discarded 106 * -- by the receiver if an Add-GeographicalInformation parameter is received 107 * -- in the same message. 108 * -- 109 * -- An Ext-GeographicalInformation parameter comprising one octet shall be treated as 110 * -- invalid data by the receiver if an Add-GeographicalInformation parameter is not 111 * -- received in the same message. 112 * 113 * 114 * maxExt-GeographicalInformation INTEGER ::= 20 115 * -- the maximum length allows for further shapes in 3GPP TS 23.032 to be included in later 116 * -- versions of 3GPP TS 29.002 117 * 118 * @return 119 */ 120 public byte[] getLocationEstimate(); 121 122 /** 123 * PositioningDataInformation ::= OCTET STRING (SIZE (2..maxPositioningDataInformation)) 124 * -- Refers to the Positioning Data defined in 3GPP TS 49.031. 125 * -- This is composed of 2 or more octets with an internal structure according to 126 * -- 3GPP TS 49.031. 127 * 128 * maxPositioningDataInformation INTEGER ::= 10 129 * 130 * @return 131 */ 132 public byte[] getGeranPositioningData(); 133 134 135 /** 136 * UtranPositioningDataInfo ::= OCTET STRING (SIZE (3..maxUtranPositioningDataInfo)) 137 * -- Refers to the Position Data defined in 3GPP TS 25.413. 138 * -- This is composed of the positioningDataDiscriminator and the positioningDataSet 139 * -- included in positionData as defined in 3GPP TS 25.413. 140 * 141 * maxUtranPositioningDataInfo INTEGER ::= 11 142 * 143 * @return 144 */ 145 public byte[] getUtranPositioningData(); 146 147 148 /** 149 * AgeOfLocationInformation ::= INTEGER (0..32767) 150 * -- the value represents the elapsed time in minutes since the last 151 * -- network contact of the mobile station (i.e. the actuality of the 152 * -- location information). 153 * -- value 0 indicates that the MS is currently in contact with the 154 * -- network 155 * -- value 32767 indicates that the location information is at least 156 * -- 32767 minutes old 157 * 158 * @return 159 */ 160 public Integer getAgeOfLocationEstimate(); 161 162 163 /** 164 * Add-GeographicalInformation ::= OCTET STRING (SIZE (1..maxAdd-GeographicalInformation)) 165 * -- Refers to geographical Information defined in 3GPP TS 23.032. 166 * -- This is composed of 1 or more octets with an internal structure according to 167 * -- 3GPP TS 23.032 168 * -- Octet 1: Type of shape, all the shapes defined in 3GPP TS 23.032 are allowed: 169 * -- Octets 2 to n (where n is the total number of octets necessary to encode the shape 170 * -- according to 3GPP TS 23.032) are used to encode the shape itself in accordance with the 171 * -- encoding defined in 3GPP TS 23.032 172 * -- 173 * -- An Add-GeographicalInformation parameter, whether valid or invalid, received 174 * -- together with a valid Ext-GeographicalInformation parameter in the same message 175 * -- shall be discarded. 176 * -- 177 * -- An Add-GeographicalInformation parameter containing any shape not defined in 178 * -- 3GPP TS 23.032 or an incorrect number of octets or coding according to 179 * -- 3GPP TS 23.032 shall be treated as invalid data by a receiver if not received 180 * -- together with a valid Ext-GeographicalInformation parameter in the same message. 181 * 182 * 183 * maxAdd-GeographicalInformation INTEGER ::= 91 184 * -- the maximum length allows support for all the shapes currently defined in 3GPP TS 185 * 23.032 186 * 187 * @return 188 */ 189 public byte[] getAdditionalLocationEstimate(); 190 191 public MAPExtensionContainer getExtensionContainer(); 192 193 public Boolean getDeferredMTLRResponseIndicator(); 194 195 196 public CellGlobalIdOrServiceAreaIdOrLAI getCellGlobalIdOrServiceAreaIdOrLAI(); 197 198 public Boolean getSaiPresent(); 199 200 public AccuracyFulfilmentIndicator getAccuracyFulfilmentIndicator(); 201 202 } 203