com.covisint.platform.group.client.group.membership

Interface GroupMembershipClient

All Superinterfaces:

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

All Known Implementing Classes:

GroupMembershipClientImpl

public interface GroupMembershipClient
extends com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Resource client that operates on GroupMembership resources.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	add(String groupId, GroupMembership groupMembership, org.apache.http.protocol.HttpContext httpContext) Adds the group membership.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	delete(String groupId, String membershipId, org.apache.http.protocol.HttpContext httpContext) Deletes the group membership.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String membershipId, boolean isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Retrieves the group membership and returns group with/without entitlements in response.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String membershipId, org.apache.http.protocol.HttpContext httpContext) Retrieves the group membership.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	listGroupMemberships(String groupId, boolean isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Gets all the memberships associated with a group.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,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 isIncludeGroup, boolean isIncludeGroupAndEntitlements, org.apache.http.protocol.HttpContext httpContext) Search for resources based on the passed search criteria.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,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, 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

Method Detail

add

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

Adds the group membership.

Parameters:

groupId - The group id.

groupMembership - The group membership resource.

httpContext - The http context.

Returns:

The group membership.

get

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

Retrieves the group membership.

Parameters:

groupId - The group id.

membershipId - The membership id.

httpContext - The http coontext.

Returns:

The group membership.

delete

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

Deletes the group membership.

Parameters:

groupId - The group id.

membershipId - The membership id.

httpContext - The http coontext.

Returns:

The group membership.

search

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

Search for resources based on the passed search criteria.

Specified by:

search in interface com.covisint.core.http.service.client.ResourceClient<GroupMembership>

Parameters:

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - the pagination criteria

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system

get

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

Retrieves the group membership and returns group with/without entitlements in response.

Parameters:

groupId - The group id.

membershipId - The membership id.

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - The http coontext.

Returns:

The group membership.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,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 isIncludeGroup,
                                                                                                                                         boolean isIncludeGroupAndEntitlements,
                                                                                                                                         @Nonnull
                                                                                                                                         org.apache.http.protocol.HttpContext httpContext)

Search for resources based on the passed search criteria. Return group with/without entitlements in response.

Parameters:

searchCriteria - search information about the query

sortCriteria - sort information about the query

page - pagination criteria

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system

listGroupMemberships

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> listGroupMemberships(@Nonnull@NotEmpty
                                                                                                                                                       String groupId,
                                                                                                                                                       boolean isIncludeGroup,
                                                                                                                                                       boolean isIncludeGroupAndEntitlements,
                                                                                                                                                       @Nonnull
                                                                                                                                                       org.apache.http.protocol.HttpContext httpContext)

Gets all the memberships associated with a group.

Parameters:

groupId - the id of the group whose memberships are being requested.

isIncludeGroup - the boolean flag to indicate if full group resource without entitlements should be included in the response

isIncludeGroupAndEntitlements - the boolean flag to indicate if full group resource with entitlements should be included in the response

httpContext - the HTTP Context containing session-level data

Returns:

all matching resources found in the system