/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/subscriberInformation/LocationInformation.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.subscriberInformation;
24
25import org.mobicents.protocols.ss7.map.api.primitives.CellGlobalIdOrServiceAreaIdOrLAI;
26import org.mobicents.protocols.ss7.map.api.primitives.ISDNAddressString;
27import org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer;
28
29/**
30*
31LocationInformation ::= SEQUENCE {
32	ageOfLocationInformation	AgeOfLocationInformation	OPTIONAL,
33	geographicalInformation	[0] GeographicalInformation	OPTIONAL,
34	vlr-number	[1] ISDN-AddressString	OPTIONAL,
35	locationNumber	[2] LocationNumber	OPTIONAL,
36	cellGlobalIdOrServiceAreaIdOrLAI	[3] CellGlobalIdOrServiceAreaIdOrLAI	OPTIONAL,
37	extensionContainer	[4] ExtensionContainer	OPTIONAL,
38	... ,
39	selectedLSA-Id	[5] LSAIdentity	OPTIONAL,
40	msc-Number	[6] ISDN-AddressString	OPTIONAL,
41	geodeticInformation	[7] GeodeticInformation	OPTIONAL, 
42	currentLocationRetrieved	[8] NULL		OPTIONAL,
43	sai-Present	[9] NULL		OPTIONAL,
44	locationInformationEPS	[10] LocationInformationEPS	OPTIONAL,
45	userCSGInformation	[11] UserCSGInformation	OPTIONAL }
46-- sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains
47-- a Service Area Identity.
48-- currentLocationRetrieved shall be present 
49-- if the location information were retrieved after a successfull paging.
50-- if the locationinformationEPS IE is present then the cellGlobalIdOrServiceAreaIdOrLAI IE,
51-- the ageOfLocationInformation IE, the geographicalInformation IE, the geodeticInformation IE
52-- and the currentLocationRetrieved IE (outside the locationInformationEPS IE) shall be
53-- absent. 
54-- UserCSGInformation contains the CSG ID, Access mode, and the CSG Membership Indication in
55-- the case the Access mode is Hybrid Mode.
56* 
57* @author sergey vetyutnev
58* 
59*/
60public interface LocationInformation {
61
62	public Integer getAgeOfLocationInformation();
63
64	public GeographicalInformation getGeographicalInformation();
65
66	public ISDNAddressString getVlrNumber();
67
68	public LocationNumberMap getLocationNumber();
69
70	public CellGlobalIdOrServiceAreaIdOrLAI getCellGlobalIdOrServiceAreaIdOrLAI();
71
72	public MAPExtensionContainer getExtensionContainer();
73
74	public LSAIdentity getSelectedLSAId();
75
76	public ISDNAddressString getMscNumber();
77
78	public GeodeticInformation getGeodeticInformation();
79
80	public boolean getCurrentLocationRetrieved();
81
82	public boolean getSaiPresent();
83
84	public LocationInformationEPS getLocationInformationEPS();
85
86	public UserCSGInformation getUserCSGInformation();
87
88}