org.asteriskjava.manager.event.MusicOnHoldEvent Maven / Gradle / Ivy
Show all versions of asterisk-java Show documentation
/*
* 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 MusicOnHoldEvent is triggered when music on hold starts or stops on a channel.
* It is implemented in res/res_musiconhold.c.
* Available since Asterisk 1.6
*
* @author srt
* @version $Id: MusicOnHoldEvent.java 1135 2008-08-18 13:46:59Z srt $
* @since 1.0.0
*/
public class MusicOnHoldEvent extends ManagerEvent
{
private static final long serialVersionUID = 0L;
public static final String STATE_START = "Start";
public static final String STATE_STOP = "Stop";
private String channel;
private String uniqueId;
private String state;
public MusicOnHoldEvent(Object source)
{
super(source);
}
/**
* Returns the name of the channel.
*
* @return channel the name of the channel.
*/
public String getChannel()
{
return channel;
}
/**
* Sets the name of the channel.
*
* @param channel the name of the channel.
*/
public void setChannel(String channel)
{
this.channel = channel;
}
/**
* Returns the unique id of the channel.
*
* @return the unique id of the channel.
*/
public String getUniqueId()
{
return uniqueId;
}
/**
* Sets the unique id of the channel.
*
* @param uniqueId the unique id of the channel.
*/
public void setUniqueId(String uniqueId)
{
this.uniqueId = uniqueId;
}
/**
* Returns the state. This is either "Start" or "Stop" depending on whether music on hold
* started or stopped on the channel.
*
* @return "Start" if music on hold started or "Stop" if music on hold stopped on the channel.
* @see #STATE_START
* @see #STATE_STOP
* @see #isStart()
* @see #isStop()
*/
public String getState()
{
return state;
}
public void setState(String state)
{
this.state = state;
}
/**
* Returns whether this is a start event.
*
* @return true if this a start event, false otherwise.
*/
public boolean isStart()
{
return STATE_START.equals(state);
}
/**
* Returns whether this is a stop event.
*
* @return true if this an stop event, false otherwise.
*/
public boolean isStop()
{
return STATE_STOP.equals(state);
}
}