View Javadoc

1   /*
2    * Copyright  2004-2005 Stefan Reuter
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *
16   */
17  package net.sf.asterisk.manager.action;
18  
19  /***
20   * The StopMonitorAction ends monitoring (recording) a channel.<br>
21   * It is implemented in <code>res/res_monitor.c</code>
22   * 
23   * @author srt
24   * @version $Id: StopMonitorAction.java,v 1.5 2005/08/07 16:55:18 srt Exp $
25   */
26  public class StopMonitorAction extends AbstractManagerAction
27  {
28      /***
29       * Serializable version identifier
30       */
31      private static final long serialVersionUID = -6316010713240389305L;
32  
33      /***
34       * The name of the channel to end monitoring.
35       */
36      private String channel;
37  
38      /***
39       * Creates a new empty StopMonitorAction.
40       */
41      public StopMonitorAction()
42      {
43  
44      }
45  
46      /***
47       * Creates a new StopMonitorAction that ends monitoring of the given
48       * channel.
49       * 
50       * @param channel the name of the channel to stop monitoring.
51       * @since 0.2
52       */
53      public StopMonitorAction(String channel)
54      {
55  
56      }
57  
58      /***
59       * Returns the name of this action, i.e. "StopMonitor".
60       * 
61       * @return the name of this action.
62       */
63      public String getAction()
64      {
65          return "StopMonitor";
66      }
67  
68      /***
69       * Returns the name of the channel to end monitoring.
70       * 
71       * @return the name of the channel to end monitoring.
72       */
73      public String getChannel()
74      {
75          return channel;
76      }
77  
78      /***
79       * Sets the name of the channel to end monitoring.<br>
80       * This property is mandatory.
81       * 
82       * @param channel the name of the channel to end monitoring.
83       */
84      public void setChannel(String channel)
85      {
86          this.channel = channel;
87      }
88  }