com.covisint.platform.group.client.sdk

Interface GroupMembershipSDK.GroupMembershipClient

Enclosing class:

GroupMembershipSDK

public static interface GroupMembershipSDK.GroupMembershipClient

Client interface for the GroupMembership resource APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GroupMembershipSDK.GroupMembershipClient.ResponseOption Enumeration of options used to potentially augment an API response.

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 membership) Add a membership to a group.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	delete(String groupId, String membershipId) Delete a group membership.
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException>	get(String groupId, String membershipId, GroupMembershipSDK.GroupMembershipClient.ResponseOption option) Retrieves a group membership by id.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	listGroupMemberships(String groupId, GroupMembershipSDK.GroupMembershipClient.ResponseOption option) Gets all the memberships associated with a group.
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException>	search(String memberId, String memberType, String groupOwnerId, String groupOwnerType, com.covisint.core.http.service.core.Page page, GroupMembershipSDK.GroupMembershipClient.ResponseOption option) Search for group memberships based on the passed criteria.

Method Detail

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<GroupMembership,com.covisint.core.http.service.core.ServiceException> add(@Nonnull@NotEmpty
                                                                                                                                String groupId,
                                                                                                                                @Nonnull
                                                                                                                                GroupMembership membership)

Add a membership to a group.

Parameters:

groupId - The group id to associate the new member.

membership - The group membership to add.

Returns:

Returns a future providing the added 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)

Delete a group membership.

Parameters:

groupId - The group from which the membership is being removed.

membershipId - The id of the membership to delete.

Returns:

Returns a future which, when complete, indicates that the group was successfully removed.

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
                                                                                                                                GroupMembershipSDK.GroupMembershipClient.ResponseOption option)

Retrieves a group membership by id.

Parameters:

groupId - The id of the owning group.

membershipId - The id of the membership to retrieve.

option - The response option, used to inline request for associated data.

Returns:

Returns a future providing the corresponding group membership, or null if one does not exist for the given ids.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<GroupMembership>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull@NotEmpty
                                                                                                                                         String memberId,
                                                                                                                                         String memberType,
                                                                                                                                         String groupOwnerId,
                                                                                                                                         String groupOwnerType,
                                                                                                                                         @Nonnull
                                                                                                                                         com.covisint.core.http.service.core.Page page,
                                                                                                                                         @Nonnull
                                                                                                                                         GroupMembershipSDK.GroupMembershipClient.ResponseOption option)

Search for group memberships based on the passed criteria.

Parameters:

memberId - The group member's id.

memberType - The group member type, for example, person, organization, etc.

groupOwnerId - The group owner - return all memberships to the group owned by this owner id.

groupOwnerType - The group owner type, for example, person, organization, etc.

page - pagination criteria

option - The response option, used to inline request for associated 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,
                                                                                                                                                       @Nonnull
                                                                                                                                                       GroupMembershipSDK.GroupMembershipClient.ResponseOption option)

Gets all the memberships associated with a group.

Parameters:

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

option - The response option, used to inline request for associated data.

Returns:

Returns a future providing all matching group memberships, which may be an empty list.