Asterisk-Java

org.asteriskjava.manager.event
Class QueueSummaryEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.asteriskjava.manager.event.ManagerEvent
          extended by org.asteriskjava.manager.event.ResponseEvent
              extended by org.asteriskjava.manager.event.QueueSummaryEvent
All Implemented Interfaces:
java.io.Serializable

public class QueueSummaryEvent
extends ResponseEvent

A QueueSummaryEvent is triggered in response to a QueueSummaryAction and contains a summary of the current state of a queue.

Available in Asterisk post-1.4.

It is implemented in apps/app_queue.c

Since:
0.3
Version:
$Id: QueueSummaryEvent.java 1290 2009-04-10 23:23:24Z srt $
Author:
srt
See Also:
QueueSummaryCompleteEvent, QueueSummaryAction, Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
QueueSummaryEvent(java.lang.Object source)
           
 
Method Summary
 java.lang.Integer getAvailable()
          Returns the number of members logged in and not in a call.
 java.lang.Integer getCallers()
          Returns the number of callers currently waiting in the queue.
 java.lang.Integer getHoldTime()
          Returns the current avarage hold time for this queue based on an exponential average.
 java.lang.Integer getLoggedIn()
          Returns the number of members logged in.
 java.lang.Integer getLongestHoldTime()
          Returns the longest hold time of the a queue entry currently in the queue.
 java.lang.String getQueue()
          Returns the name of queue.
 java.lang.Integer getTalkTime()
          Returns the current avarage talk time for this queue based on an exponential average.
 void setAvailable(java.lang.Integer available)
          Sets the number of members logged in and not in a call.
 void setCallers(java.lang.Integer callers)
          Sets the number of callers currently waiting in the queue.
 void setHoldTime(java.lang.Integer holdTime)
          Sets the current avarage hold time for this queue based on an exponential average.
 void setLoggedIn(java.lang.Integer loggedIn)
          Sets the number of members logged in.
 void setLongestHoldTime(java.lang.Integer longestHoldTime)
          Sets the longest hold time of the a queue entry currently in the queue.
 void setQueue(java.lang.String queue)
          Sets the name of queue.
 void setTalkTime(java.lang.Integer talkTime)
          Sets the current avarage talk time for this queue based on an exponential average.
 
Methods inherited from class org.asteriskjava.manager.event.ResponseEvent
getActionId, getInternalActionId, setActionId, setInternalActionId
 
Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
getDateReceived, getPrivilege, getServer, getTimestamp, setDateReceived, setPrivilege, setServer, setTimestamp, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueueSummaryEvent

public QueueSummaryEvent(java.lang.Object source)
Method Detail

getQueue

public java.lang.String getQueue()
Returns the name of queue.

Returns:
the name of queue.

setQueue

public void setQueue(java.lang.String queue)
Sets the name of queue.

Parameters:
queue - the name of queue.

getLoggedIn

public java.lang.Integer getLoggedIn()
Returns the number of members logged in.

Returns:
the number of members logged in.

setLoggedIn

public void setLoggedIn(java.lang.Integer loggedIn)
Sets the number of members logged in.

Parameters:
loggedIn - the number of members logged in.

getAvailable

public java.lang.Integer getAvailable()
Returns the number of members logged in and not in a call.

This is the number of queue members currently available for calls.

Returns:
the number of members logged in and not in a call.

setAvailable

public void setAvailable(java.lang.Integer available)
Sets the number of members logged in and not in a call.

Parameters:
available - the number of members logged in and not in a call.

getCallers

public java.lang.Integer getCallers()
Returns the number of callers currently waiting in the queue.

Returns:
the number of callers currently waiting in the queue.

setCallers

public void setCallers(java.lang.Integer callers)
Sets the number of callers currently waiting in the queue.

Parameters:
callers - the number of callers currently waiting in the queue.

getHoldTime

public java.lang.Integer getHoldTime()
Returns the current avarage hold time for this queue based on an exponential average.

Returns:
the current avarage hold time for this queue.

setHoldTime

public void setHoldTime(java.lang.Integer holdTime)
Sets the current avarage hold time for this queue based on an exponential average.

Parameters:
holdTime - the current avarage hold time for this queue.

getTalkTime

public java.lang.Integer getTalkTime()
Returns the current avarage talk time for this queue based on an exponential average.

Returns:
the current avarage talk time for this queue.
Since:
1.0.0

setTalkTime

public void setTalkTime(java.lang.Integer talkTime)
Sets the current avarage talk time for this queue based on an exponential average.

Parameters:
talkTime - the current avarage talk time for this queue.
Since:
1.0.0

getLongestHoldTime

public java.lang.Integer getLongestHoldTime()
Returns the longest hold time of the a queue entry currently in the queue.

Returns:
the longest hold time of the a queue entry currently in the queue.
Since:
1.0.0

setLongestHoldTime

public void setLongestHoldTime(java.lang.Integer longestHoldTime)
Sets the longest hold time of the a queue entry currently in the queue.

Parameters:
longestHoldTime - the longest hold time of the a queue entry currently in the queue.
Since:
1.0.0

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.