de.starface.integration.uci.java.v30.messages.requests
Interface UciQueueRequests


@UciService(value="ucp.v30.requests.queue")
@RpcInterface(value="ucp.v30.requests.queue")
@RpcValueTranslation(version=30)
public interface UciQueueRequests


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 List<QueueAgentState> getQueueAgents(int queueAccountId)
          Returns a List of QueueAgents with their current states as defined in QueueAgentState of the given queue, if the user is an agent of it.
 List<UciQueueCall> getQueueCalls()
          Returns the waiting, ringin, and ongoing calls of the given queue as defined in UciQueueCall
 QueueSetting getQueueSetting(int queueAccountId)
          Returns the settings of a queue as defined in QueueSetting
 List<QueueSetting> getQueueSettings()
          This request allows the UCI client to query the settings of all queues the user is an agent of.
 

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<QueueSetting> getQueueSettings()
                                    throws UciException
This request allows the UCI client to query the settings of all queues the user is an agent of.

Returns:
a List with a QueueSetting for each Queue the user is an agent of.
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

QueueSetting getQueueSetting(int queueAccountId)
                             throws UciException
Returns the settings of a queue as defined in QueueSetting

Parameters:
queueAccountId - the accountid of the queue
Returns:
a QueueSetting for the requested queue.
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).

getQueueAgents

List<QueueAgentState> getQueueAgents(int queueAccountId)
                                     throws UciException
Returns a List of QueueAgents with their current states as defined in QueueAgentState of the given queue, if the user is an agent of it.

Parameters:
queueAccountId - the accountid of the queue
Returns:
A list of Agents
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).

getQueueCalls

List<UciQueueCall> getQueueCalls()
                                 throws UciException
Returns the waiting, ringin, and ongoing calls of the given queue as defined in UciQueueCall

Returns:
A list of calls, if there are any.
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.