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