/*
 * 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.mobicents.protocols.ss7.m3ua.parameter;

/**
 * The optional Congestion Indications parameter contains a Congestion Level
 * field. This optional parameter is used to communicate congestion levels in
 * national MTP networks with multiple congestion thresholds
 * 
 * @author amit bhayani
 * 
 */
public interface CongestedIndication extends Parameter {

    public CongestionLevel getCongestionLevel();

    /**
     * <p>
     * The Congestion Level field, associated with all of the Affected DPC(s) in
     * the Affected Destinations parameter, contains one of the following
     * values:
     * </p>
     * <p>
     * <ul>
     * <li> 0 No Congestion or Undefined </li>
     * <li>1 Congestion Level 1 </li>
     * <li>2 Congestion Level 2 </li>
     * <li>3 Congestion Level 3 </li>
     * </ul>
     * </p>
     * 
     * @author abhayani
     * 
     */
    public enum CongestionLevel {

        UNDEFINED(0), LEVEL1(1), LEVEL2(2), LEVEL3(3);

        int level;

        private CongestionLevel(int level) {
            this.level = level;
        }
        
        public int getLevel(){
            return this.level;
        }

        public static CongestionLevel getCongestionLevel(int level) {
            switch (level) {
            case 0:
                return UNDEFINED;
            case 1:
                return LEVEL1;
            case 2:
                return LEVEL2;
            case 3:
                return LEVEL3;
            default:
                return null;
            }
        }

    }

}