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


@UciService(value="ucp.v30.requests.group")
@RpcInterface(value="ucp.v30.requests.group")
public interface UcpGroupRequests

This interface defines the group requests provided by the UCI server.


Field Summary
static String SERVICE_NAME
          The UCI service name used for this interface
 
Method Summary
 List<Map<String,Object>> getGroupSettings()
          This request allows the UCI client to query the group settings of the groups the current user is a member of.
 void setGroupSetting(Map<String,Object> groupSetting)
          This request saves the given group setting.
 void setGroupSettings(List<Map<String,Object>> groupSettings)
          This request saves the given group 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

getGroupSettings

List<Map<String,Object>> getGroupSettings()
                                          throws UciException
This request allows the UCI client to query the group settings of the groups the current user is a member of.

Returns:
a List with a Map for each group containing the values for the properties defined in GroupSettingProperties
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).

setGroupSetting

void setGroupSetting(Map<String,Object> groupSetting)
                     throws UciException
This request saves the given group setting. The value for the properties GroupSettingProperties.name and GroupSettingProperties.phoneNumbers are ignored. This is read only information given by the server.

Parameters:
groupSetting - 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).

setGroupSettings

void setGroupSettings(List<Map<String,Object>> groupSettings)
                      throws UciException
This request saves the given group settings. The value for the properties GroupSettingProperties.name and GroupSettingProperties.phoneNumbers are ignored. This is read only information given by the server.

Parameters:
groupSettings - 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.