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


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

This interface contains the UCI Communication Redirect Requests


Method Summary
 List<RedirectSetting> getRedirectSettings(RedirectSettingType typeRestriction, String groupRestriction, RedirectSettingProperties orderProperty, OrderDirection orderDirection)
          Retrieve the redirect settings for the current user.
 void setRedirectSetting(RedirectSetting redirectSetting)
          Save the given redirect setting.
 void setRedirectSettings(List<RedirectSetting> redirectSettings)
          Save the given redirect settings.
 

Method Detail

getRedirectSettings

List<RedirectSetting> getRedirectSettings(RedirectSettingType typeRestriction,
                                          String groupRestriction,
                                          RedirectSettingProperties orderProperty,
                                          OrderDirection orderDirection)
                                          throws UciException
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 null 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, if null is given the default RedirectSettingProperties.calledNumber is used.
orderDirection - give the name of one of the OrderDirections to define the ordering. If null is given the default order direction of the property will be used
Returns:
a List of RedirectSetting with the current settings of the user
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(RedirectSetting redirectSetting)
                        throws UciException
Save the given redirect setting. The value for the property RedirectSettingProperties.mailboxes is 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<RedirectSetting> redirectSettings)
                         throws UciException
Save the given redirect settings. The value for the properties RedirectSettingProperties.mailboxes 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.