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


@RpcInterface(value="ucp.v30.requests.redirect")
@UciService(value="ucp.v30.requests.redirect")
public interface UcpRedirectRequests

This interface defines the requests provided by the UCI server to alter the redirect settings.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 List<Map<String,Object>> getRedirectSettings(String typeRestriction, String groupRestriction, String orderProperty, String orderDirection)
          This request allows the UCI client to retrieve the redirect settings for the current user.
 void setRedirectSetting(Map<String,Object> redirectSetting)
          This request saves the given redirect setting.
 void setRedirectSettings(List<Map<String,Object>> redirectSettings)
          This request saves the given redirect settings.
 

Field Detail

SERVICE_NAME

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

See Also:
Constant Field Values
Method Detail

getRedirectSettings

List<Map<String,Object>> getRedirectSettings(String typeRestriction,
                                             String groupRestriction,
                                             String orderProperty,
                                             String orderDirection)
                                             throws UciException
This request allows the UCI client to retrieve the redirect settings for the current user.

Parameters:
typeRestriction - if one of the constants in RedirectSettingType is given the settings returned are restricted to those of the given type. If an empty String is given no restriction is made.
groupRestriction - restrict returned results to those belonging a specified group. Possible choices are the String GroupRestriction.NON_GROUP to return redirect settings that do not belong to any group, the id of a group to restrict the list to the calls belonging to that group and the empty String to return all calls without restriction.
orderProperty - give the name of one of the RedirectSettingProperties to order results by the value of the property, when an empty String is given the default RedirectSettingProperties.calledNumber is used.
orderDirection - give the name of one of the OrderDirections to define the ordering. If not set the default order direction of the property will be used
Returns:
a List with a Map for each redirect setting containing the values for the properties defined in RedirectSettingProperties
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or 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).

setRedirectSetting

void setRedirectSetting(Map<String,Object> redirectSetting)
                        throws UciException
This request saves the given redirect setting. The value for the properties RedirectSettingProperties.mailboxes and RedirectSettingProperties.groupId are ignored, this is read only information given by the server.

Parameters:
redirectSetting - the setting to be saved
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or 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).

setRedirectSettings

void setRedirectSettings(List<Map<String,Object>> redirectSettings)
                         throws UciException
This request saves the given redirect settings. The value for the properties RedirectSettingProperties.mailboxes and RedirectSettingProperties.groupId are ignored. This is read only information given by the server.

Parameters:
redirectSettings - the settings to be saved
Throws:
UciException - if the request is not valid as defined by the UCI specification. This may be the case if one of the request's arguments has an illegal value ( UciIllegalArgumentException) or 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.