com.covisint.platform.group.client.group.entitlement

Interface GroupEntitlementClient

All Superinterfaces:

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

All Known Implementing Classes:

GroupEntitlementClientImpl

public interface GroupEntitlementClient
extends com.covisint.core.http.service.client.ResourceClient<GroupEntitlement>

Resource client that operates on GroupEntitlement resources.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<GroupEntitlement,com.covisint.core.http.service.core.ServiceException>	add(String groupId, GroupEntitlement groupEntitlement, org.apache.http.protocol.HttpContext httpContext) Adds the group entitlement.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	delete(String groupId, String entitlementId, org.apache.http.protocol.HttpContext httpContext) Deletes the group entitlement.
com.google.common.util.concurrent.CheckedFuture<GroupEntitlement,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String entitlementId, org.apache.http.protocol.HttpContext httpContext) Retrieves the group entitlement.
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,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, String groupId, org.apache.http.protocol.HttpContext httpContext) Search the group entitlements.

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

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

Method Detail

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<GroupEntitlement,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                 String groupId,
                                                                                                                                 @Nonnull@NotEmpty
                                                                                                                                 GroupEntitlement groupEntitlement,
                                                                                                                                 @Nonnull
                                                                                                                                 org.apache.http.protocol.HttpContext httpContext)

Adds the group entitlement.

Parameters:

groupId - The group id.

groupEntitlement - The group entitlement resource.

httpContext - The http context.

Returns:

The group entitlement.

get

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

Retrieves the group entitlement.

Parameters:

groupId - The group id.

entitlementId - The entitlement id.

httpContext - The http coontext.

Returns:

The group entitlement.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,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,
                                                                                                                                          @Nonnull@NotEmpty
                                                                                                                                          String groupId,
                                                                                                                                          @Nonnull
                                                                                                                                          org.apache.http.protocol.HttpContext httpContext)

Search the group entitlements.

Parameters:

groupId - The group id.

searchCriteria - The search criteria.

sortCriteria - The sort criteria.

page - The pagination criteria.

httpContext - The http coontext.

Returns:

The group entitlement.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                        String groupId,
                                                                                                                        @Nonnull@NotEmpty
                                                                                                                        String entitlementId,
                                                                                                                        @Nonnull
                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Deletes the group entitlement.

Parameters:

groupId - The group id.

entitlementId - The entitlement id.

httpContext - The http coontext.

Returns:

The group entitlement.