com.covisint.platform.service.client.service.grant

Interface ServicePackageGrantClient

All Superinterfaces:

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

All Known Implementing Classes:

ServicePackageGrantClientImpl

public interface ServicePackageGrantClient
extends com.covisint.core.http.service.client.ResourceClient<ServicePackageGrant>

Resource client that operates on ServicePackageGrant resources.

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, org.apache.http.protocol.HttpContext httpContext) Grants a service package to an organization, based on the given organizationId and packageId.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	assignPersonGrant(String personId, String packageId, org.apache.http.protocol.HttpContext httpContext) Grants a service package to a person, based on the given personId and packageId.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getOrganizationGrant(String organizationId, String packageId, org.apache.http.protocol.HttpContext httpContext) Retrieves a ServicePackageGrant issued to the given organization, that matches the package id.
com.google.common.util.concurrent.CheckedFuture<ServicePackageGrant,com.covisint.core.http.service.core.ServiceException>	getPersonGrant(String personId, String packageId, org.apache.http.protocol.HttpContext httpContext) Retrieves a ServicePackageGrant issued to the given person, that matches the package id.
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	searchOrganizationGrants(String organizationId, org.apache.http.protocol.HttpContext httpContext, com.covisint.core.http.service.core.Page page) Searches for all service package grants issued to the given organization.
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException>	searchPersonGrants(String personId, org.apache.http.protocol.HttpContext httpContext, com.covisint.core.http.service.core.Page page) Searches for all service package grants issued to the given person.

Methods inherited from interface com.covisint.core.http.service.client.ResourceClient

add, delete, get, get, persist, search, search

Method Detail

searchPersonGrants

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> searchPersonGrants(@Nonnull@NotEmpty
                                                                                                                                                             String personId,
                                                                                                                                                             @Nonnull
                                                                                                                                                             org.apache.http.protocol.HttpContext httpContext,
                                                                                                                                                             @Nonnull
                                                                                                                                                             com.covisint.core.http.service.core.Page page)

Searches for all service package grants issued to the given person.

Parameters:

personId - The id of the person to search on.

httpContext - The http context used to store session-level attributes.

page - The pagination criteria.

Returns:

Returns a checked future wrapping an iterable of matching service package grants. May be empty.

searchOrganizationGrants

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Iterable<ServicePackageGrant>,com.covisint.core.http.service.core.ServiceException> searchOrganizationGrants(@Nonnull@NotEmpty
                                                                                                                                                                   String organizationId,
                                                                                                                                                                   @Nonnull
                                                                                                                                                                   org.apache.http.protocol.HttpContext httpContext,
                                                                                                                                                                   @Nonnull
                                                                                                                                                                   com.covisint.core.http.service.core.Page page)

Searches for all service package grants issued to the given organization.

Parameters:

organizationId - The id of the organization to search on.

httpContext - The http context used to store session-level attributes.

page - The pagination criteria.

Returns:

Returns a checked future wrapping an iterable of matching service package grants. May be empty.

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,
                                                                                                                                               @Nonnull
                                                                                                                                               org.apache.http.protocol.HttpContext httpContext)

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

Parameters:

personId - The id of the grantee.

packageId - The id of the granted package.

httpContext - The http context used to store session-level attributes.

Returns:

Returns, if exists, a checked future wrapping the corresponding service package grant.

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,
                                                                                                                                                     @Nonnull
                                                                                                                                                     org.apache.http.protocol.HttpContext httpContext)

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

Parameters:

organizationId - The id of the grantee.

packageId - The id of the granted package.

httpContext - The http context used to store session-level attributes.

Returns:

Returns, if exists, a checked future wrapping the corresponding service package grant.

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,
                                                                                                                                                  @Nonnull
                                                                                                                                                  org.apache.http.protocol.HttpContext httpContext)

Grants a service package to a person, based on the given personId and packageId. 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 about to be granted

httpContext - The http context used to store session-level attributes

Returns:

Returns a checked future wrapping 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,
                                                                                                                                                        @Nonnull
                                                                                                                                                        org.apache.http.protocol.HttpContext httpContext)

Grants a service package to an organization, based on the given organizationId and packageId. 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 about to be granted

httpContext - The http context used to store session-level attributes

Returns:

Returns a checked future wrapping the newly-assigned service package grant