|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@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 |
|---|
static final String SERVICE_NAME
| Method Detail |
|---|
List<Map<String,Object>> getGroupSettings()
throws UciException
List with a Map for each group containing the values for the
properties defined in GroupSettingProperties
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).
void setGroupSetting(Map<String,Object> groupSetting)
throws UciException
GroupSettingProperties.name and GroupSettingProperties.phoneNumbers are
ignored. This is read only information given by the server.
groupSetting - the setting to be saved
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).
void setGroupSettings(List<Map<String,Object>> groupSettings)
throws UciException
GroupSettingProperties.name and GroupSettingProperties.phoneNumbers are
ignored. This is read only information given by the server.
groupSettings - the settings to be saved
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).
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||