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 QueueEntryEvent is triggered in response to a QueueStatusAction and
21   * contains information about an entry in a queue.<br>
22   * It is implemented in <code>apps/app_queue.c</code>
23   * 
24   * @see net.sf.asterisk.manager.action.QueueStatusAction
25   * @author srt
26   * @version $Id: QueueEntryEvent.java,v 1.3 2005/08/27 09:36:24 srt Exp $
27   */
28  public class QueueEntryEvent extends ResponseEvent
29  {
30      /***
31       * Serializable version identifier
32       */
33      private static final long serialVersionUID = 3419114730595151514L;
34      private String queue;
35      private Integer position;
36      private String channel;
37      private String callerId;
38      private String callerIdName;
39      private Long wait;
40  
41      /***
42       * @param source
43       */
44      public QueueEntryEvent(Object source)
45      {
46          super(source);
47      }
48  
49      /***
50       * Returns the name of the queue that contains this entry.
51       */
52      public String getQueue()
53      {
54          return queue;
55      }
56  
57      /***
58       * Sets the name of the queue that contains this entry.
59       */
60      public void setQueue(String queue)
61      {
62          this.queue = queue;
63      }
64  
65      /***
66       * Returns the position of this entry in the queue.
67       */
68      public Integer getPosition()
69      {
70          return position;
71      }
72  
73      /***
74       * Sets the position of this entry in the queue.
75       */
76      public void setPosition(Integer position)
77      {
78          this.position = position;
79      }
80  
81      /***
82       * Returns the name of the channel of this entry.
83       */
84      public String getChannel()
85      {
86          return channel;
87      }
88  
89      /***
90       * Sets the name of the channel of this entry.
91       */
92      public void setChannel(String channel)
93      {
94          this.channel = channel;
95      }
96  
97      /***
98       * Returns the the Caller*ID number of this entry.
99       * 
100      * @return the the Caller*ID number of this entry.
101      */
102     public String getCallerId()
103     {
104         return callerId;
105     }
106 
107     /***
108      * Sets the the Caller*ID number of this entry.
109      * 
110      * @param callerId the the Caller*ID number of this entry.
111      */
112     public void setCallerId(String callerId)
113     {
114         this.callerId = callerId;
115     }
116 
117     /***
118      * Returns the Caller*ID name of this entry.
119      * 
120      * @return the Caller*ID name of this entry.
121      * @since 0.2
122      */
123     public String getCallerIdName()
124     {
125         return callerIdName;
126     }
127 
128     /***
129      * Sets the Caller*ID name of this entry.
130      * 
131      * @param callerIdName the Caller*ID name of this entry.
132      * @since 0.2
133      */
134     public void setCallerIdName(String callerIdName)
135     {
136         this.callerIdName = callerIdName;
137     }
138 
139     /***
140      * Returns the number of seconds this entry has spent in the queue.
141      */
142     public Long getWait()
143     {
144         return wait;
145     }
146 
147     /***
148      * Sets the number of seconds this entry has spent in the queue.
149      */
150     public void setWait(Long wait)
151     {
152         this.wait = wait;
153     }
154 }