org.asteriskjava.manager.action.ZapDndOnAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asterisk-java Show documentation

The free Java library for Asterisk PBX integration.

The newest version!

/*
 *  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.action;

/**
 * The ZapDNDOnAction switches a zap channel "Do Not Disturb" status on.
 *
 * @author srt
 * @version $Id$
 */
public class ZapDndOnAction extends AbstractManagerAction {
    /**
     * Serializable version identifier
     */
    private static final long serialVersionUID = -4669362344411680132L;
    private Integer zapChannel;

    /**
     * Creates a new empty ZapDndOnAction.
     */
    public ZapDndOnAction() {

    }

    /**
     * Creates a new ZapDndOnAction that enables "Do Not Disturb" status for
     * the given zap channel.
     *
     * @param zapChannel the number of the zap channel
     * @since 0.2
     */
    public ZapDndOnAction(Integer zapChannel) {
        this.zapChannel = zapChannel;
    }

    /**
     * Returns the name of this action, i.e. "ZapDNDOn".
     */
    @Override
    public String getAction() {
        return "ZapDNDOn";
    }

    /**
     * Returns the number of the zap channel to switch to dnd on.
     */
    public Integer getZapChannel() {
        return zapChannel;
    }

    /**
     * Sets the number of the zap channel to switch to dnd on.
     * This property is mandatory.
     */
    public void setZapChannel(Integer channel) {
        this.zapChannel = channel;
    }
}