com.covisint.platform.group.client.group

Interface GroupClient

All Superinterfaces:

com.covisint.core.http.service.client.ResourceClient<Group>

All Known Implementing Classes:

GroupClientImpl

public interface GroupClient
extends com.covisint.core.http.service.client.ResourceClient<Group>

Resource client that operates on Group resources.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	get(String id, boolean includeEntitlements, org.apache.http.protocol.HttpContext httpContext) Get a resource by ID.
com.google.common.util.concurrent.CheckedFuture<List<Group>,com.covisint.core.http.service.core.ServiceException>	search(com.google.common.collect.Multimap<String,String> searchCriteria, com.covisint.core.http.service.core.SortCriteria sortCriteria, com.covisint.core.http.service.core.Page page, boolean isIncludeEntitlements, org.apache.http.protocol.HttpContext httpContext) Search for resources based on the passed search criteria.

Methods inherited from interface com.covisint.core.http.service.client.ResourceClient

add, delete, get, get, persist, search, search

Method Detail

get

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

Get a resource by ID.

Parameters:

id - id of the resource to be returned

includeEntitlements - the boolean flag indicating if entitlements are to be included in response

httpContext - the HTTP Context containing session-level data

Returns:

a future containing the requested resource, if it exists

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<Group>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull
                                                                                                                               com.google.common.collect.Multimap<String,String> searchCriteria,
                                                                                                                               @Nonnull
                                                                                                                               com.covisint.core.http.service.core.SortCriteria sortCriteria,
                                                                                                                               @Nonnull
                                                                                                                               com.covisint.core.http.service.core.Page page,
                                                                                                                               boolean isIncludeEntitlements,
                                                                                                                               @Nonnull
                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

Search for resources based on the passed search criteria.

Parameters:

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - the page of results to return

isIncludeEntitlements - the boolean flag indicating if entitlements should be included in response

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system