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.event;
18  
19  /***
20   * A HangupEvent is triggered when a channel is hung up.<br>
21   * It is implemented in <code>channel.c</code>
22   * 
23   * @author srt
24   * @version $Id: HangupEvent.java,v 1.3 2005/08/27 02:26:59 srt Exp $
25   */
26  public class HangupEvent extends ChannelEvent
27  {
28      /***
29       * Serializable version identifier
30       */
31      static final long serialVersionUID = 650153034857116588L;
32  
33      private Integer cause;
34      private String causeTxt;
35  
36      /***
37       * @param source
38       */
39      public HangupEvent(Object source)
40      {
41          super(source);
42      }
43  
44      /***
45       * Returns the cause of the hangup.
46       */
47      public Integer getCause()
48      {
49          return cause;
50      }
51  
52      /***
53       * Sets the cause of the hangup.
54       */
55      public void setCause(Integer cause)
56      {
57          this.cause = cause;
58      }
59  
60      /***
61       * Returns the textual representation of the hangup cause.
62       * 
63       * @return the textual representation of the hangup cause.
64       * @since 0.2
65       */
66      public String getCauseTxt()
67      {
68          return causeTxt;
69      }
70  
71      /***
72       * Sets the textual representation of the hangup cause.
73       * 
74       * @param causeTxt the textual representation of the hangup cause.
75       * @since 0.2
76       */
77      public void setCauseTxt(String causeTxt)
78      {
79          this.causeTxt = causeTxt;
80      }
81  }