de.starface.integration.uci.java.v30.ucp.messages.requests
Interface UCPQueueRequests


@UciService(value="ucp.v30.requests.queue")
@RpcInterface(value="ucp.v30.requests.queue")
public interface UCPQueueRequests


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 List<Map<String,Object>> getCallsForQueue(int queueAccountId)
          Returns a List of ongoing queue calls as defined in UciQueueCallProperties
Use this for initialization only.
 List<Map<String,Object>> getQueueAgents(int queueAccountId)
          Returns a List of QueueAgents as defined in QueueAgentStateProperties for the given queue
 Map<String,Object> getQueueSetting(int queueAccountId)
          Returns the Settings of a queue as defined in QueueSettingProperties
 List<Map<String,Object>> getQueueSettings()
          This request allows the UCI client to query the queues.
 

Field Detail

SERVICE_NAME

static final String SERVICE_NAME
The UCI service name used for this interface

See Also:
Constant Field Values
Method Detail

getQueueSettings

List<Map<String,Object>> getQueueSettings()
                                          throws UciException
This request allows the UCI client to query the queues.

Returns:
a List with a Map for each queue containing the values for the properties defined in QueueSettingProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request with the given parameters is not allowed to the user ( UciIllegalAccessException) or if the request is placed while the UCI client is not connected (UcpNotConnectedException).

getQueueSetting

Map<String,Object> getQueueSetting(int queueAccountId)
                                   throws UciException
Returns the Settings of a queue as defined in QueueSettingProperties

Parameters:
queueAccountId - the accountId of the specific queue
Returns:
the settings of a queue
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request is not allowed to the user (UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getQueueAgents

List<Map<String,Object>> getQueueAgents(int queueAccountId)
                                        throws UciException
Returns a List of QueueAgents as defined in QueueAgentStateProperties for the given queue

Parameters:
queueAccountId - the accountId of the specific queue
Returns:
a list of queueAgents
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request with the given parameters is not allowed to the user ( UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).

getCallsForQueue

List<Map<String,Object>> getCallsForQueue(int queueAccountId)
                                          throws UciException
Returns a List of ongoing queue calls as defined in UciQueueCallProperties
Use this for initialization only. The interface will update any changes by events that contain all the necessary information. Continuous polling will lead to bad system performance!

Parameters:
queueAccountId - the accountid of the specific queue
Returns:
a list of queueCalls
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if the request with the given parameters is not allowed to the user ( UciIllegalAccessException) or if the request is placed while the UCI client is not connected ( UcpNotConnectedException).


Copyright © 2012 STARFACE GmbH. All rights reserved.