QueueParamsEvent (Asterisk-Java 2.0.2 API)

java.lang.Object
- java.util.EventObject
- - org.asteriskjava.manager.event.ManagerEvent
  - - org.asteriskjava.manager.event.ResponseEvent
    - - org.asteriskjava.manager.event.QueueParamsEvent

All Implemented Interfaces:

Serializable
```
public class QueueParamsEvent
extends ResponseEvent
```
A QueueParamsEvent is triggered in response to a QueueStatusAction and contains the parameters of a queue.
It is implemented in apps/app_queue.c

Version:

$Id$

Author:

srt

See Also:

QueueStatusAction, Serialized Form

Field Summary
- Fields inherited from class org.asteriskjava.manager.event.ManagerEvent
  callerIdName, callerIdNum, channelState, channelStateDesc, connectedLineName, connectedLineNum, context, exten, priority
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor and Description

QueueParamsEvent(Object source)

Constructors
Constructor and Description
`QueueParamsEvent(Object source)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getAbandoned()` Returns the number of abandoned calls.
`Integer`	`getCalls()` Returns the number of calls currently waiting in the queue.
`Integer`	`getCompleted()` Returns the number of completed calls.
`Integer`	`getHoldTime()` Returns the current average holdtime for this queue (in seconds).
`Integer`	`getMax()` Returns the maximum number of people waiting in the queue or 0 for unlimited.
`String`	`getQueue()` Returns the name of the queue.
`Integer`	`getServiceLevel()` Returns the service level (in seconds) as defined by the `servicelevel` setting in `queues.conf`.
`Double`	`getServiceLevelPerf()` Returns the ratio of calls answered within the specified service level per total completed calls (in percent).
`Double`	`getServiceLevelPerf2()`
`String`	`getStrategy()` Returns the strategy used for this queue.
`Integer`	`getTalkTime()` Returns the current avarage talk time for this queue based on an exponential average.
`Integer`	`getWeight()` Returns the weight of this queue.
`void`	`setAbandoned(Integer abandoned)` Sets the number of abandoned calls.
`void`	`setCalls(Integer calls)` Sets the number of calls currently waiting in the queue.
`void`	`setCompleted(Integer complete)` Sets the number of completed calls.
`void`	`setHoldTime(Integer holdTime)` Sets the current average holdtime for this queue.
`void`	`setMax(Integer max)` Sets the maximum number of people waiting in the queue.
`void`	`setQueue(String queue)` Sets the name of the queue.
`void`	`setServiceLevel(Integer serviceLevel)` Sets the service level.
`void`	`setServiceLevelPerf(Double serviceLevelPerf)` Sets the ratio of calls answered within the specified service level per total completed calls.
`void`	`setServiceLevelPerf2(Double serviceLevelPerf2)`
`void`	`setStrategy(String strategy)` Sets the strategy used for this queue.
`void`	`setTalkTime(Integer talkTime)` Sets the current avarage talk time for this queue based on an exponential average.
`void`	`setWeight(Integer weight)` Sets the weight of this queue.

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent
getActionId, getInternalActionId, setActionId, setInternalActionId

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent
appendPropertyIfNotNull, getCallerIdName, getCallerIdNum, getChannelState, getChannelStateDesc, getConnectedLineName, getConnectedLineNum, getContext, getDateReceived, getExten, getFile, getFunc, getLine, getPriority, getPrivilege, getSequenceNumber, getServer, getSystemName, getTimestamp, setCallerIdName, setCallerIdNum, setChannelState, setChannelStateDesc, setConnectedLineName, setConnectedLineNum, setContext, setDateReceived, setExten, setFile, setFunc, setLine, setPriority, setPrivilege, setSequenceNumber, setServer, setSystemName, 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
  - QueueParamsEvent
```
public QueueParamsEvent(Object source)
```
- Method Detail
  - getQueue
```
public String getQueue()
```
    Returns the name of the queue.
    
    Returns:
    
    the name of the queue.
  - setQueue
```
public void setQueue(String queue)
```
    Sets the name of the queue.
    
    Parameters:
    
    queue - the name of the queue.
  - getMax
```
public Integer getMax()
```
    Returns the maximum number of people waiting in the queue or 0 for unlimited.
    This corresponds to the maxlen setting in queues.conf.
    
    Returns:
    
    the maximum number of people waiting in the queue or 0 for unlimited.
  - setMax
```
public void setMax(Integer max)
```
    Sets the maximum number of people waiting in the queue.
    
    Parameters:
    
    max - the maximum number of people waiting in the queue or 0 for unlimited.
  - getStrategy
```
public String getStrategy()
```
    Returns the strategy used for this queue.
    Possible values are:
    - ringall
    - roundrobin
    - leastrecent
    - fewestcalls
    - random
    - rrmemory
    Available since Asterisk 1.6
    Returns:
    
    the strategy used for this queue.
    
    Since:
    
    1.0.0
  - setStrategy
```
public void setStrategy(String strategy)
```
    Sets the strategy used for this queue.
    
    Parameters:
    
    strategy - the strategy used for this queue.
    
    Since:
    
    1.0.0
  - getCalls
```
public Integer getCalls()
```
    Returns the number of calls currently waiting in the queue.
    
    Returns:
    
    the number of calls currently waiting in the queue.
  - setCalls
```
public void setCalls(Integer calls)
```
    Sets the number of calls currently waiting in the queue.
    
    Parameters:
    
    calls - the number of calls currently waiting in the queue.
  - getHoldTime
```
public Integer getHoldTime()
```
    Returns the current average holdtime for this queue (in seconds).
    
    Returns:
    
    the current average holdtime for this queue (in seconds).
  - setHoldTime
```
public void setHoldTime(Integer holdTime)
```
    Sets the current average holdtime for this queue.
    
    Parameters:
    
    holdTime - the current average holdtime for this queue (in seconds).
  - getTalkTime
```
public 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(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
  - getCompleted
```
public Integer getCompleted()
```
    Returns the number of completed calls.
    
    Returns:
    
    the number of completed calls.
  - setCompleted
```
public void setCompleted(Integer complete)
```
    Sets the number of completed calls.
    
    Parameters:
    
    complete - the number of completed calls.
  - getAbandoned
```
public Integer getAbandoned()
```
    Returns the number of abandoned calls.
    
    Returns:
    
    the number of abandoned calls.
  - setAbandoned
```
public void setAbandoned(Integer abandoned)
```
    Sets the number of abandoned calls.
    
    Parameters:
    
    abandoned - the number of abandoned calls.
  - getServiceLevel
```
public Integer getServiceLevel()
```
    Returns the service level (in seconds) as defined by the servicelevel setting in queues.conf.
    
    Returns:
    
    the service level (in seconds).
  - setServiceLevel
```
public void setServiceLevel(Integer serviceLevel)
```
    Sets the service level.
    
    Parameters:
    
    serviceLevel - the service level (in seconds).
  - getServiceLevelPerf
```
public Double getServiceLevelPerf()
```
    Returns the ratio of calls answered within the specified service level per total completed calls (in percent).
    
    Returns:
    
    the ratio of calls answered within the specified service level per total completed calls (in percent).
  - setServiceLevelPerf
```
public void setServiceLevelPerf(Double serviceLevelPerf)
```
    Sets the ratio of calls answered within the specified service level per total completed calls.
    
    Parameters:
    
    serviceLevelPerf - the ratio of calls answered within the specified service level per total completed calls (in percent).
  - getWeight
```
public Integer getWeight()
```
    Returns the weight of this queue.
    A queue can be assigned a 'weight' to ensure calls waiting in a higher priority queue will deliver its calls first. Only delays the lower weight queue's call if the member is also in the higher weight queue.
    Available since Asterisk 1.2
    
    Returns:
    
    the weight of this queue or null if not supported by your version of Asterisk
    
    Since:
    
    0.2
  - setWeight
```
public void setWeight(Integer weight)
```
    Sets the weight of this queue.
    
    Parameters:
    
    weight - the weight of this queue
    
    Since:
    
    0.2
  - getServiceLevelPerf2
```
public Double getServiceLevelPerf2()
```
  - setServiceLevelPerf2
```
public void setServiceLevelPerf2(Double serviceLevelPerf2)
```

Class QueueParamsEvent

Field Summary

Fields inherited from class org.asteriskjava.manager.event.ManagerEvent

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class org.asteriskjava.manager.event.ResponseEvent

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Constructor Detail

QueueParamsEvent

Method Detail

getQueue

setQueue

getMax

setMax

getStrategy

setStrategy

getCalls

setCalls

getHoldTime

setHoldTime

getTalkTime

setTalkTime

getCompleted

setCompleted

getAbandoned

setAbandoned

getServiceLevel

setServiceLevel

getServiceLevelPerf

setServiceLevelPerf

getWeight

setWeight

getServiceLevelPerf2

setServiceLevelPerf2