com.covisint.platform.group.client.group

Class GroupClientImpl

java.lang.Object

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

com.covisint.platform.group.client.group.GroupClientImpl

All Implemented Interfaces:

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

public class GroupClientImpl
extends com.covisint.core.http.service.client.BaseResourceClient<Group>
implements GroupClient

Resource client implementation that operates on Groups.

Field Summary

Fields inherited from class com.covisint.core.http.service.client.BaseResourceClient

ID_URL_VAR

Constructor Summary

Constructors

Constructor and Description
GroupClientImpl()

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	delete(String id, org.apache.http.protocol.HttpContext httpContext)
com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException>	get(String groupId, boolean isIncludeEntitlements, 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 class com.covisint.core.http.service.client.BaseResourceClient

add, buildSearchKey, doGet, execute, executeWithBody, executeWithBody, executeWithPrecondition, get, get, getEndpointWithQueryParams, getLocalCache, persist, search, search

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

add, get, get, persist, search, search

Constructor Detail

GroupClientImpl

public GroupClientImpl()

Method Detail

get

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

Get a resource by ID.

Specified by:

get in interface GroupClient

Parameters:

groupId - id of the resource to be returned

isIncludeEntitlements - 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
public 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.

Specified by:

search in interface GroupClient

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

delete

public com.google.common.util.concurrent.CheckedFuture<Group,com.covisint.core.http.service.core.ServiceException> delete(String id,
                                                                                                                 org.apache.http.protocol.HttpContext httpContext)

Specified by:

delete in interface com.covisint.core.http.service.client.ResourceClient<Group>

Overrides:

delete in class com.covisint.core.http.service.client.BaseResourceClient<Group>