/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/lsm/ProvideSubscriberLocationRequestIndication.java
Java | 141 lines | 26 code | 23 blank | 92 comment | 0 complexity | 2faa64c1d6939f815f2e1334804d2db7 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.IMEI; 26import org.mobicents.protocols.ss7.map.api.primitives.IMSI; 27import org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString; 28import org.mobicents.protocols.ss7.map.api.primitives.LMSI; 29import org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer; 30 31/** 32 * ProvideSubscriberLocation-Arg ::= SEQUENCE { 33 * locationType LocationType, 34 * mlc-Number ISDN-AddressString, 35 * lcs-ClientID [0] LCS-ClientID OPTIONAL, 36 * privacyOverride [1] NULL OPTIONAL, 37 * imsi [2] IMSI OPTIONAL, 38 * msisdn [3] ISDN-AddressString OPTIONAL, 39 * lmsi [4] LMSI OPTIONAL, 40 * imei [5] IMEI OPTIONAL, 41 * lcs-Priority [6] LCS-Priority OPTIONAL, 42 * lcs-QoS [7] LCS-QoS OPTIONAL, 43 * extensionContainer [8] ExtensionContainer OPTIONAL, 44 * ... , 45 * supportedGADShapes [9] SupportedGADShapes OPTIONAL, 46 * lcs-ReferenceNumber [10] LCS-ReferenceNumber OPTIONAL, 47 * lcsServiceTypeID [11] LCSServiceTypeID OPTIONAL, 48 * lcsCodeword [12] LCSCodeword OPTIONAL, 49 * lcs-PrivacyCheck [13] LCS-PrivacyCheck OPTIONAL, 50 * areaEventInfo [14] AreaEventInfo OPTIONAL, 51 * h-gmlc-Address [15] GSN-Address OPTIONAL } 52 * -- one of imsi or msisdn is mandatory 53 * -- If a location estimate type indicates activate deferred location or cancel deferred 54 * -- location, a lcs-Reference number shall be included 55 * 56 * @author amit bhayani 57 * 58 */ 59public interface ProvideSubscriberLocationRequestIndication extends LsmMessage { 60 61 /** 62 * 63 * @return 64 */ 65 public LocationType getLocationType(); 66 67 public ISDNAddressString getMlcNumber(); 68 69 public LCSClientID getLCSClientID(); 70 71 public Boolean getPrivacyOverride(); 72 73 public IMSI getIMSI(); 74 75 public ISDNAddressString getMSISDN(); 76 77 public LMSI getLMSI(); 78 79 /** 80 * LCS-Priority ::= OCTET STRING (SIZE (1)) 81 * -- 0 = highest priority 82 * -- 1 = normal priority 83 * -- all other values treated as 1 84 * @return 85 */ 86 public Integer getLCSPriority(); 87 88 public LCSQoS getLCSQoS(); 89 90 public IMEI getIMEI(); 91 92 public MAPExtensionContainer getExtensionContainer(); 93 94 /** 95 * SupportedGADShapes ::= BIT STRING { 96 * ellipsoidPoint (0), 97 * ellipsoidPointWithUncertaintyCircle (1), 98 * ellipsoidPointWithUncertaintyEllipse (2), 99 * polygon (3), 100 * ellipsoidPointWithAltitude (4), 101 * ellipsoidPointWithAltitudeAndUncertaintyElipsoid (5), 102 * ellipsoidArc (6) } (SIZE (7..16)) 103 * -- A node shall mark in the BIT STRING all Shapes defined in 3GPP TS 23.032 it supports. 104 * -- exception handling: bits 7 to 15 shall be ignored if received. 105 * 106 * @return 107 */ 108 public SupportedGADShapes getSupportedGADShapes(); 109 110 /** 111 * LCS-ReferenceNumber::= OCTET STRING (SIZE(1)) 112 * 113 * @return 114 */ 115 public Byte getLCSReferenceNumber(); 116 117 public LCSCodeword getLCSCodeword(); 118 119 /** 120 * LCSServiceTypeID ::= INTEGER (0..127) 121 * -- the integer values 0-63 are reserved for Standard LCS service types 122 * -- the integer values 64-127 are reserved for Non Standard LCS service types 123 * 124 * @return 125 */ 126 public Integer getLCSServiceTypeID(); 127 128 129 130 public LCSPrivacyCheck getLCSPrivacyCheck(); 131 132 public AreaEventInfo getAreaEventInfo(); 133 134 /** 135 * GSN-Address ::= OCTET STRING (SIZE (5..17)) 136 * -- Octets are coded according to TS 3GPP TS 23.003 [17] 137 * 138 * @return 139 */ 140 public byte[] getHGMLCAddress(); 141}