/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/parameter/UserCause.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.m3ua.parameter;
24
25/**
26 * The Unavailability Cause and MTP3-User Identity fields, associated with the
27 * Affected PC in the Affected Point Code parameter
28 * 
29 * @author amit bhayani
30 * 
31 */
32public interface UserCause extends Parameter {
33
34    /**
35     * <p>
36     * The Unavailability Cause parameter provides the reason for the
37     * unavailability of the MTP3-User. The valid values for the Unavailability
38     * Cause parameter are
39     * </p>
40     * <p>
41     * <ul>
42     * <li>0 Unknown</li>
43     * <li>1 Unequipped Remote User</li>
44     * <li>2 Inaccessible Remote User</li>
45     * </ul>
46     * </p>
47     * 
48     * @return
49     */
50    public int getCause();
51
52    /**
53     * <p>
54     * The MTP3-User Identity describes the specific MTP3-User that is
55     * unavailable (e.g., ISUP, SCCP, etc.). Some of the valid values for the
56     * MTP3-User Identity are
57     * </p>
58     * <p>
59     * <ul>
60     * <li>0 to 2 Reserved</li>
61     * <li>3 SCCP</li>
62     * <li>4 TUP</li>
63     * <li>5 ISUP</li>
64     * <li>6 to 8 Reserved</li>
65     * <li>9 Broadband ISUP</li>
66     * <li>10 Satellite ISUP</li>
67     * <li>11 Reserved</li>
68     * <li>12 AAL type 2 Signalling</li>
69     * <li>13 Bearer Independent Call Control (BICC)</li>
70     * <li>14 Gateway Control Protocol</li>
71     * <li>15 Reserved</li>
72     * </ul>
73     * </p>
74     * 
75     * @return
76     */
77    public int getUser();
78
79}