/protocols/ss7/inap/inap-api/src/main/java/org/mobicents/protocols/ss7/inap/api/primitives/LegID.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.inap.api.primitives;
24
25/**
26*
27LegID::= CHOICE {
28sendingSideID[0] LegType,  -- used in operations sent from SCF to SSF
29receivingSideID[1] LegType   -- used in operations sent from SSF to SCF
30}
31--  Indicates a reference to a specific party in a call. OPTIONAL denotes network operator specific use with
32--  unilateral ID assignment. OPTIONAL for LegID also denotes the following:
33--   - when only one party exists in the call, this parameter is not needed (as no ambiguity exists).
34--   - when more than one party exists in the call, one of the following alternatives applies:
35--     1) LegID is present and indicates which party is concerned.
36--     2) LegID is not present and a default value is assumed (e.g., calling party in the case of the
37--        ApplyCharging operation).
38LegType::= OCTET STRING (SIZE(1))
39leg1 LegType::= '01'H
40leg2 LegType::= '02'H
41
42Other simple primitives:
43Duration::= INTEGER (-2..86400)
44--  Values are seconds. Negative values denote a special value, refer to the procedure description of the
45--  relevant operations for further information.
46
47Integer4::= INTEGER (0..2147483647)
48
49Interval::= INTEGER (-1..60000)
50--  Units are milliseconds. A -1 value denotes infinite.
51
52ServiceKey::= Integer4
53--  Information that allows the SCF to choose the appropriate service logic.
54
55* 
56* @author sergey vetyutnev
57* 
58*/
59public interface LegID {
60
61	public LegType getSendingSideID();
62
63	public LegType getReceivingSideID();
64
65}