com.covisint.platform.group.client.sdk

Interface GroupSDK.GroupClient

Enclosing class:

GroupSDK

public static interface GroupSDK.GroupClient

Client interface for the Group resource APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GroupSDK.GroupClient.Sort All supported sort fields.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	add(Group group) Adds a new group.
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	get(String id, boolean includeEntitlements) Retrieves a group by its id.
com.google.common.util.concurrent.CheckedFuture<List<Group>,com.covisint.core.http.service.core.ServiceException>	search(List<String> names, List<String> descriptions, boolean includeEntitlements, com.covisint.core.http.service.core.Page page, GroupSDK.GroupClient.Sort... sortOrder) Searches for groups based on supported criteria.
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	update(Group group) Updates the given group on the server.

Method Detail

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException> add(@Nonnull
                                                                                                                      Group group)

Adds a new group.

Parameters:

group - The group to add.

Returns:

Returns a future producing the newly created group. This object contains the server-issued id and version.

update

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException> update(@Nonnull
                                                                                                                         Group group)

Updates the given group on the server. If the group doesn't exist yet, it will be created with the given id.

Parameters:

group - The group to persist.

Returns:

Returns a future producing the updated group. This object contains the new version of the group resource.

get

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException> get(@Nonnull@NotEmpty
                                                                                                                      String id,
                                                                                                                      boolean includeEntitlements)

Retrieves a group by its id.

Parameters:

id - The id of the group to retrieve.

includeEntitlements - Whether to include entitlements within the retrieved group.

Returns:

Returns a future producing the group retrieved for the given id, or null if no matching group was found. If includeEntitlements was set to true, then the group will list its entitlements.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<Group>,com.covisint.core.http.service.core.ServiceException> search(@NonnullElements
                                                                                                                               List<String> names,
                                                                                                                               @NonnullElements
                                                                                                                               List<String> descriptions,
                                                                                                                               boolean includeEntitlements,
                                                                                                                               @Nonnull
                                                                                                                               com.covisint.core.http.service.core.Page page,
                                                                                                                               GroupSDK.GroupClient.Sort... sortOrder)

Searches for groups based on supported criteria.

Parameters:

names - The group names to look for. If null or an empty collection is passed, then no filter is performed on group name.

descriptions - The group descriptions to look for. If null or an empty collection is passed, then no filter is performed on group descriptions.

includeEntitlements - Whether to include entitlements within the retrieved groups.

page - The pagination criteria to apply. Pass Page.DEFAULT to return the standard result collection.

sortOrder - The sort criteria to apply. Leave empty to skip sort operations.

Returns:

Returns a future producing the iterable collection of groups matching the search criteria.