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


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

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


Method Summary
 List<GroupSetting> getGroupSettings()
          This request allows the UCI client to query the group settings of the groups the current user is a member of.
 void setGroupSetting(GroupSetting groupSetting)
          This request saves the given group setting.
 void setGroupSettings(List<GroupSetting> groupSettings)
          This request saves the given group settings.
 

Method Detail

getGroupSettings

List<GroupSetting> 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 GroupSetting for each group the user is a member 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).

setGroupSetting

void setGroupSetting(GroupSetting groupSetting)
                     throws UciException
This request saves the given group setting. The value for the properties GroupSetting.name and GroupSetting.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<GroupSetting> groupSettings)
                      throws UciException
This request saves the given group settings. The value for the properties GroupSetting.name and GroupSetting.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.