com.covisint.platform.service.client.sdk

Interface ServiceMembershipSDK.ServiceMembershipClient

Enclosing class:

ServiceMembershipSDK

public static interface ServiceMembershipSDK.ServiceMembershipClient

Client interface for the service membership APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	assignServiceMemberships(String packageId, List<String> serviceIds) Assigns membership between a service and package.
com.google.common.util.concurrent.CheckedFuture<Iterable<Service>,com.covisint.core.http.service.core.ServiceException>	listMemberServices(String packageId) List all services that are members of the given package id.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	removeServiceMemberships(String packageId, List<String> serviceIds) Removes membership of a service from a package.

Method Detail

listMemberServices

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Iterable<Service>,com.covisint.core.http.service.core.ServiceException> listMemberServices(@Nonnull@NotEmpty
                                                                                                                                                 String packageId)

List all services that are members of the given package id.

Parameters:

packageId - The package id for which to get services.

Returns:

Returns a future providing an iterable of the member services.

assignServiceMemberships

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> assignServiceMemberships(@Nonnull
                                                                                                                                          String packageId,
                                                                                                                                          @Nonnull@NonnullElements
                                                                                                                                          List<String> serviceIds)

Assigns membership between a service and package. Has no effect if the service is already a member. If the service is already a member of a different package, then the assignment is prohibited and will result in an error.

Parameters:

packageId - The id of the package getting the new services.

serviceIds - The id's of the services to assign.

Returns:

Returns a future which, when complete, indicates a successful assignment.

removeServiceMemberships

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> removeServiceMemberships(@Nonnull
                                                                                                                                          String packageId,
                                                                                                                                          @Nonnull@NonnullElements
                                                                                                                                          List<String> serviceIds)

Removes membership of a service from a package. Has no effect if the service is not currently a member.

Parameters:

packageId - The id of the package losing the service.

serviceIds - The id's of the services to remove.

Returns:

Returns a future which, when complete, indicates a successful removal.