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

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.

There is a newer version: 3.40.1

/*
 *  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 QueueMemberPausedEvent is triggered when a queue member is paused or
 * unpaused.
 * It is implemented in apps/app_queue.c.

 * Available since Asterisk 1.2
 *
 * @author srt
 * @version $Id: QueueMemberPausedEvent.java 1208 2008-12-09 13:40:39Z srt $
 * @since 0.2
 */
public class QueueMemberPausedEvent extends AbstractQueueMemberEvent
{
    /**
     * Serial version identifier.
     */
    private static final long serialVersionUID = 1L;

    private Boolean paused;

    /**
     * The reason why the queue member has been paused (optional).
     */
    private String reason;

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

    /**
     * Returns if this queue member is paused (not accepting calls).
     *
     * @return Boolean.TRUE if this member has been paused or
     *         Boolean.FALSE if not.
     */
    public Boolean getPaused()
    {
        return paused;
    }

    /**
     * Sets if this member is paused.
     *
     * @param paused Boolean.TRUE if this member has been paused
     *               or Boolean.FALSE if not.
     */
    public void setPaused(Boolean paused)
    {
        this.paused = paused;
    }

    /**
     * Returns the reason why the queue member has been paused. Will be set to
     * Auto-Pause for the case that the queue member has been
     * paused for not answering the call.
     *
     * @return the reason specified for the pause.
     */
    public String getReason()
    {
        return reason;
    }

    /**
     * Sets the reason why the queue member has been paused.
     *
     * @param reason the reason why the queue member has been paused.
     */
    public void setReason(String reason)
    {
        this.reason = reason;
    }
}