com.covisint.platform.service.client.sdk

Interface ServicePackageGrantSDK.ServicePackageGrantClient

Enclosing class:

ServicePackageGrantSDK

public static interface ServicePackageGrantSDK.ServicePackageGrantClient

Client interface for the ServicePackageGrant resource APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServicePackageGrantSDK.ServicePackageGrantClient.GranteeType Enumeration of supported package grantee types.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	assignOrganizationGrant(String organizationId, String packageId) Grants a service package to an organization, based on the given organization and package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	assignPersonGrant(String personId, String packageId) Grants a service package to a person, based on the given person and package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getOrganizationGrant(String organizationId, String packageId) Retrieves a ServicePackageGrant issued to the given organization, matching the package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getPersonGrant(String personId, String packageId) Retrieves a ServicePackageGrant issued to the given person, matching the package id.
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	listOrganizationGrants(String organizationId, com.covisint.core.http.service.core.Page page) Lists all service package grants issued to the given organization.
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	listPersonGrants(String personId, com.covisint.core.http.service.core.Page page) Lists all service package grants issued to the given person.
com.google.common.util.concurrent.CheckedFuture<List<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	search(String grantedPackageId, ServicePackageGrantSDK.ServicePackageGrantClient.GranteeType granteeType, com.covisint.core.http.service.core.Page page) Search for service package grants satisfying the given criteria.

Method Detail

listPersonGrants

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> listPersonGrants(@Nonnull@NotEmpty
                                                                                                                                                           String personId,
                                                                                                                                                           @Nonnull
                                                                                                                                                           com.covisint.core.http.service.core.Page page)

Lists all service package grants issued to the given person.

Parameters:

personId - The id of the person whose package grants are to be returned.

page - The pagination criteria.

Returns:

Returns a future producing an iterable of service package grants, which may be empty if no grants exist for the person.

listOrganizationGrants

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> listOrganizationGrants(@Nonnull@NotEmpty
                                                                                                                                                                 String organizationId,
                                                                                                                                                                 @Nonnull
                                                                                                                                                                 com.covisint.core.http.service.core.Page page)

Lists all service package grants issued to the given organization.

Parameters:

organizationId - The id of the organization whose package grants are to be returned.

page - The pagination criteria.

Returns:

Returns a future producing an iterable of service package grants, which may be empty if no grants exist for the organization.

getPersonGrant

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> getPersonGrant(@Nonnull@NotEmpty
                                                                                                                                               String personId,
                                                                                                                                               @Nonnull@NotEmpty
                                                                                                                                               String packageId)

Retrieves a ServicePackageGrant issued to the given person, matching the package id.

Parameters:

personId - The id of the grantee.

packageId - The id of the granted package.

Returns:

Returns a future producing the corresponding service package grant, or null if one does not exist.

getOrganizationGrant

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> getOrganizationGrant(@Nonnull@NotEmpty
                                                                                                                                                     String organizationId,
                                                                                                                                                     @Nonnull@NotEmpty
                                                                                                                                                     String packageId)

Retrieves a ServicePackageGrant issued to the given organization, matching the package id.

Parameters:

organizationId - The id of the grantee.

packageId - The id of the granted package.

Returns:

Returns a future producing the corresponding service package grant, or null if one does not exist.

assignPersonGrant

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> assignPersonGrant(@Nonnull@NotEmpty
                                                                                                                                                  String personId,
                                                                                                                                                  @Nonnull@NotEmpty
                                                                                                                                                  String packageId)

Grants a service package to a person, based on the given person and package id. If the package is already granted, this operation has no effect.

Parameters:

personId - The id of the person receiving the package grant.

packageId - The id of the package to be granted.

Returns:

Returns a future producing the newly-assigned service package grant.

assignOrganizationGrant

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException> assignOrganizationGrant(@Nonnull@NotEmpty
                                                                                                                                                        String organizationId,
                                                                                                                                                        @Nonnull@NotEmpty
                                                                                                                                                        String packageId)

Grants a service package to an organization, based on the given organization and package id. If the package is already granted, this operation has no effect.

Parameters:

organizationId - The id of the organization receiving the package grant.

packageId - The id of the package to be granted.

Returns:

Returns a future producing the newly-assigned service package grant.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> search(@Nonnull@NotEmpty
                                                                                                                                             String grantedPackageId,
                                                                                                                                             @Nonnull@NotEmpty
                                                                                                                                             ServicePackageGrantSDK.ServicePackageGrantClient.GranteeType granteeType,
                                                                                                                                             @Nonnull
                                                                                                                                             com.covisint.core.http.service.core.Page page)

Search for service package grants satisfying the given criteria.

Parameters:

grantedPackageId - The id of the granted package to search.

granteeType - The package grantee type.

page - The pagination criteria. Pass Page.DEFAULT to return the standard result collection.

Returns:

Returns a future producing the list of matching service package grants.