org.asteriskjava.manager.event.ZapShowChannelsEvent 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;

/**
 * A ZapShowChannelsEvent is triggered in response to a ZapShowChannelsAction
 * and shows the state of a zap channel.
 * 
 * @see org.asteriskjava.manager.action.ZapShowChannelsAction
 * @author srt
 * @version $Id$
 */
public class ZapShowChannelsEvent extends ResponseEvent {

    private static final long serialVersionUID = 5396773457171568819L;
    private Integer channel;
    private String signalling;
    // private String context;
    private Boolean dnd;
    private String alarm;

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

    /**
     * Returns the number of this zap channel.
     *
     * @return channel
     */
    public Integer getChannel() {
        return channel;
    }

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

    /**
     * Returns the signalling of this zap channel.
     * 
     * Possible values are:
     * 

     * E & M Immediate
     * E & M Wink
     * E & M E1
     * Feature Group D (DTMF)
     * Feature Group D (MF)
     * Feature Group B (MF)
     * E911 (MF)
     * FXS Loopstart
     * FXS Groundstart
     * FXS Kewlstart
     * FXO Loopstart
     * FXO Groundstart
     * FXO Kewlstart
     * PRI Signalling
     * R2 Signalling
     * SF (Tone) Signalling Immediate
     * SF (Tone) Signalling Wink
     * SF (Tone) Signalling with Feature Group D (DTMF)
     * SF (Tone) Signalling with Feature Group D (MF)
     * SF (Tone) Signalling with Feature Group B (MF)
     * GR-303 Signalling with FXOKS
     * GR-303 Signalling with FXSKS
     * Pseudo Signalling
     * 
     * 
     * @return signalling
     */
    public String getSignalling() {
        return signalling;
    }

    /**
     * Sets the signalling of this zap channel.
     *
     * @param signalling
     *            signalling
     */
    public void setSignalling(String signalling) {
        this.signalling = signalling;
    }

    /**
     * Returns whether dnd (do not disturb) is enabled for this zap channel.
     * 
     * @return Boolean.TRUE if dnd is enabled, Boolean.FALSE if it is disabled,
     *         null if not set.
     * @since 0.3
     */
    public Boolean getDnd() {
        return dnd;
    }

    /**
     * Sets whether dnd (do not disturb) is enabled for this zap channel.
     * 
     * @param dnd
     *            Boolean.TRUE if dnd is enabled, Boolean.FALSE if it is
     *            disabled.
     * @since 0.3
     */
    public void setDnd(Boolean dnd) {
        this.dnd = dnd;
    }

    /**
     * Returns the alarm state of this zap channel.
     * 
     * This may be one of
     * 

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

    /**
     * Sets the alarm state of this zap channel.
     *
     * @param alarm
     *            alarm
     */
    public void setAlarm(String alarm) {
        this.alarm = alarm;
    }
}