com.covisint.platform.group.client.sdk

Interface GroupEntitlementSDK.GroupEntitlementClient

Enclosing class:

GroupEntitlementSDK

public static interface GroupEntitlementSDK.GroupEntitlementClient

Client interface for the GroupEntitlement resource APIs.

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 entitlement) Adds a new entitlement to the specified group.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	delete(String groupId, String entitlementId) Deletes a specified group entitlement.
com.google.common.util.concurrent.CheckedFuture<GroupEntitlement,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String entitlementId) Retrieves the entitlement for the specified group id and entitlement id.
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,com.covisint.core.http.service.core.ServiceException>	listEntitlements(String groupId, com.covisint.core.http.service.core.Page page) List all entitlements for the given group id.
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,com.covisint.core.http.service.core.ServiceException>	search(String groupId, List<String> entitlementIds, com.covisint.core.http.service.core.Page page) List all entitlements for the given group id.

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 entitlement)

Adds a new entitlement to the specified group.

Parameters:

groupId - The id of the group where the entitlement will be added.

entitlement - The group entitlement to add.

Returns:

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

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)

Retrieves the entitlement for the specified group id and entitlement id.

Parameters:

groupId - The id of the owning group.

entitlementId - The entitlement id to retrieve.

Returns:

Returns a future producing the requested entitlement, or null if it doesn't exist for the given group.

listEntitlements

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,com.covisint.core.http.service.core.ServiceException> listEntitlements(@Nonnull@NotEmpty
                                                                                                                                                    String groupId,
                                                                                                                                                    @Nonnull
                                                                                                                                                    com.covisint.core.http.service.core.Page page)

List all entitlements for the given group id.

Parameters:

groupId - The id of the group whose entitlements are requested.

page - The pagination criteria. Pass Page.DEFAULT if no specific pagination is required.

Returns:

Returns a future producing the list of entitlement for the given group id. Result may be empty if the group id doesn't exist or the group contains no entitlements.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupEntitlement>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull@NotEmpty
                                                                                                                                          String groupId,
                                                                                                                                          @Nonnull@NotEmpty@NonnullElements
                                                                                                                                          List<String> entitlementIds,
                                                                                                                                          @Nonnull
                                                                                                                                          com.covisint.core.http.service.core.Page page)

List all entitlements for the given group id.

Parameters:

groupId - The id of the group whose entitlements are requested.

entitlementIds - The ids of the entitlements to return.

page - The pagination criteria. Pass Page.DEFAULT if no specific pagination is required.

Returns:

Returns a future producing the list of entitlement for the given group id. Result may be empty if the group id doesn't exist or the group contains no entitlements.

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)

Deletes a specified group entitlement.

Parameters:

groupId - The id of the owning group.

entitlementId - The id of the entitlement to delete.

Returns:

Returns a future producing Void, at which point the requested entitlement has been deleted.