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 ZapHangupAction hangs up a zap channel.
21   * 
22   * @author srt
23   * @version $Id: ZapHangupAction.java,v 1.4 2005/08/07 17:10:29 srt Exp $
24   */
25  public class ZapHangupAction extends AbstractManagerAction
26  {
27      /***
28       * Serializable version identifier
29       */
30      private static final long serialVersionUID = -4064616334146097495L;
31      private Integer zapChannel;
32  
33      /***
34       * Creates a new empty ZapHangupAction.
35       */
36      public ZapHangupAction()
37      {
38  
39      }
40  
41      /***
42       * Creates a new ZapHangupAction that hangs up the given zap channel.
43       * 
44       * @param zapChannel the number of the zap channel to hang up
45       * @since 0.2
46       */
47      public ZapHangupAction(Integer zapChannel)
48      {
49          this.zapChannel = zapChannel;
50      }
51  
52      /***
53       * Returns the name of this action, i.e. "ZapHangup".
54       */
55      public String getAction()
56      {
57          return "ZapHangup";
58      }
59  
60      /***
61       * Returns the number of the zap channel to hangup.
62       */
63      public Integer getZapChannel()
64      {
65          return zapChannel;
66      }
67  
68      /***
69       * Sets the number of the zap channel to hangup.<br>
70       * This property is mandatory.
71       */
72      public void setZapChannel(Integer channel)
73      {
74          this.zapChannel = channel;
75      }
76  }