/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/service/lsm/LocationType.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 java.io.Serializable;
26
27/**
28 * LocationType ::= SEQUENCE {
29 *    locationEstimateType [0] LocationEstimateType,
30 *    ...,
31 *    deferredLocationEventType [1] DeferredLocationEventType OPTIONAL }
32 * 
33 * @author amit bhayani
34 *
35 */
36public interface LocationType extends Serializable {
37	LocationEstimateType getLocationEstimateType();
38	
39	/**
40	 * DeferredLocationEventType ::= BIT STRING {
41     *     msAvailable (0) ,
42     *     enteringIntoArea (1),
43     *     leavingFromArea (2),
44     *     beingInsideArea (3) } (SIZE (1..16))
45     *  -- beingInsideArea is always treated as oneTimeEvent regardless of the possible value
46     *  -- of occurrenceInfo inside areaEventInfo.
47     *  -- exception handling:
48     *  -- a ProvideSubscriberLocation-Arg containing other values than listed above in
49     *  -- DeferredLocationEventType shall be rejected by the receiver with a return error cause of
50     *  -- unexpected data value.
51	 */
52	DeferredLocationEventType getDeferredLocationEventType();
53}