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 JoinEvent is triggered when a channel joines a queue.<br>
21   * It is implemented in <code>apps/app_queue.c</code>
22   * 
23   * @author srt
24   * @version $Id: JoinEvent.java,v 1.3 2005/08/27 03:20:13 srt Exp $
25   */
26  public class JoinEvent extends QueueEvent
27  {
28      /***
29       * Serializable version identifier
30       */
31      static final long serialVersionUID = 4961288508235470985L;
32  
33      protected String callerId;
34      protected String callerIdName;
35      protected Integer position;
36  
37      /***
38       * @param source
39       */
40      public JoinEvent(Object source)
41      {
42          super(source);
43      }
44  
45      /***
46       * Returns the Caller*ID number of the channel that joined the queue if set.
47       * If the channel has no caller id set "unknown" is returned.
48       */
49      public String getCallerId()
50      {
51          return callerId;
52      }
53  
54      /***
55       * Sets the Caller*ID number of the channel that joined the queue.
56       */
57      public void setCallerId(String callerId)
58      {
59          this.callerId = callerId;
60      }
61  
62      /***
63       * Returns the Caller*ID name of the channel that joined the queue if set.
64       * If the channel has no caller id set "unknown" is returned.
65       * @since 0.2
66       */
67      public String getCallerIdName()
68      {
69          return callerIdName;
70      }
71  
72      /***
73       * Sets the Caller*ID name of the channel that joined the queue.
74       * @since 0.2
75       */
76      public void setCallerIdName(String callerIdName)
77      {
78          this.callerIdName = callerIdName;
79      }
80  
81      /***
82       * Returns the position of the joined channel in the queue.
83       */
84      public Integer getPosition()
85      {
86          return position;
87      }
88  
89      /***
90       * Sets the position of the joined channel in the queue.
91       */
92      public void setPosition(Integer position)
93      {
94          this.position = position;
95      }
96  }