org.asteriskjava.manager.event.AlarmEvent Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2004-2006 Stefan Reuter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package org.asteriskjava.manager.event;

/**
 * An AlarmEvent is triggered when a Zap channel enters or changes alarm state.
 * 
 * It is implemented in channels/chan_zap.c
 * 
 * @author srt
 * @version $Id$
 */
public class AlarmEvent extends ManagerEvent {

    private static final long serialVersionUID = 7829444298871248369L;
    private String alarm;
    private Integer channel;

    public AlarmEvent(Object source) {
        super(source);
    }

    /**
     * Returns the kind of alarm that happened.
     * 

     * This may be one of
     * 

     * Red Alarm
     * Yellow Alarm
     * Blue Alarm
     * Recovering
     * Loopback
     * Not Open
     * 
     *
     * @return alarm
     */
    public String getAlarm() {
        return alarm;
    }

    /**
     * Sets the kind of alarm that happened.
     *
     * @param alarm
     *            alarm
     */
    public void setAlarm(String alarm) {
        this.alarm = alarm;
    }

    /**
     * Returns the number of the channel the alarm occured on.
     *
     * @return channel
     */
    public Integer getChannel() {
        return channel;
    }

    /**
     * Sets the number of the channel the alarm occured on.
     *
     * @param channel
     *            channel
     */
    public void setChannel(Integer channel) {
        this.channel = channel;
    }
}