org.restcomm.protocols.ss7.m3ua.parameter.UserCause Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of m3ua-api Show documentation
The newest version!
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.restcomm.protocols.ss7.m3ua.parameter;

/**
 * The Unavailability Cause and MTP3-User Identity fields, associated with the Affected PC in the Affected Point Code parameter
 *
 * @author amit bhayani
 *
 */
public interface UserCause extends Parameter {

    /**
     * 
     * The Unavailability Cause parameter provides the reason for the unavailability of the MTP3-User. The valid values for the
     * Unavailability Cause parameter are
     * 
     * 
     * 

     * 0 Unknown
     * 1 Unequipped Remote User
     * 2 Inaccessible Remote User
     * 
     * 
     *
     * @return
     */
    int getCause();

    /**
     * 
     * The MTP3-User Identity describes the specific MTP3-User that is unavailable (e.g., ISUP, SCCP, etc.). Some of the valid
     * values for the MTP3-User Identity are
     * 
     * 
     * 

     * 0 to 2 Reserved
     * 3 SCCP
     * 4 TUP
     * 5 ISUP
     * 6 to 8 Reserved
     * 9 Broadband ISUP
     * 10 Satellite ISUP
     * 11 Reserved
     * 12 AAL type 2 Signalling
     * 13 Bearer Independent Call Control (BICC)
     * 14 Gateway Control Protocol
     * 15 Reserved
     * 
     * 
     *
     * @return
     */
    int getUser();

}