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 ParkedCallEvent is triggered when a channel is parked (in this case no
21   * action id is set) and in response to a ParkedCallsAction.<br>
22   * It is implemented in <code>res/res_features.c</code>
23   * 
24   * @see net.sf.asterisk.manager.action.ParkedCallsAction
25   * @author srt
26   * @version $Id: ParkedCallEvent.java,v 1.3 2005/08/27 04:04:29 srt Exp $
27   */
28  public class ParkedCallEvent extends ResponseEvent
29  {
30      /***
31       * Serializable version identifier
32       */
33      private static final long serialVersionUID = -7437833328723536814L;
34      private String exten;
35      private String channel;
36      private String from;
37      private Integer timeout;
38      private String callerId;
39      private String callerIdName;
40      private String uniqueId;
41  
42      /***
43       * @param source
44       */
45      public ParkedCallEvent(Object source)
46      {
47          super(source);
48      }
49  
50      /***
51       * Returns the extension the channel is parked at.
52       */
53      public String getExten()
54      {
55          return exten;
56      }
57  
58      /***
59       * Sets the extension the channel is parked at.
60       */
61      public void setExten(String exten)
62      {
63          this.exten = exten;
64      }
65  
66      /***
67       * Returns the name of the channel that is parked.
68       */
69      public String getChannel()
70      {
71          return channel;
72      }
73  
74      /***
75       * Sets the name of the channel that is parked.
76       */
77      public void setChannel(String channel)
78      {
79          this.channel = channel;
80      }
81  
82      /***
83       * Returns the name of the channel that parked the call.
84       */
85      public String getFrom()
86      {
87          return from;
88      }
89  
90      /***
91       * Sets the name of the channel that parked the call.
92       */
93      public void setFrom(String from)
94      {
95          this.from = from;
96      }
97  
98      /***
99       * Returns the number of seconds this call will be parked.<br>
100      * This corresponds to the <code>parkingtime</code> option in
101      * <code>features.conf</code>.
102      */
103     public Integer getTimeout()
104     {
105         return timeout;
106     }
107 
108     /***
109      * Sets the number of seconds this call will be parked.
110      */
111     public void setTimeout(Integer timeout)
112     {
113         this.timeout = timeout;
114     }
115 
116     /***
117      * Returns the Caller*ID number of the parked channel.
118      * @return the Caller*ID number of the parked channel.
119      */
120     public String getCallerId()
121     {
122         return callerId;
123     }
124 
125     /***
126      * Sets the Caller*ID number of the parked channel.
127      * @param callerId the Caller*ID number of the parked channel.
128      */
129     public void setCallerId(String callerId)
130     {
131         this.callerId = callerId;
132     }
133 
134     /***
135      * Returns the Caller*ID name of the parked channel.
136      * 
137      * @return the Caller*ID name of the parked channel.
138      * @since 0.2
139      */
140     public String getCallerIdName()
141     {
142         return callerIdName;
143     }
144 
145     /***
146      * Sets the Caller*ID name of the parked channel.
147      * 
148      * @param callerIdName the Caller*ID name of the parked channel.
149      * @since 0.2
150      */
151     public void setCallerIdName(String callerIdName)
152     {
153         this.callerIdName = callerIdName;
154     }
155 
156     /***
157      * Returns the unique id of the parked channel.
158      */
159     public String getUniqueId()
160     {
161         return uniqueId;
162     }
163 
164     /***
165      * Sets the unique id of the parked channel.
166      */
167     public void setUniqueId(String uniqueId)
168     {
169         this.uniqueId = uniqueId;
170     }
171 }