com.covisint.platform.service.client.sdk

Interface ServicePackageSDK.ServicePackageClient

Enclosing class:

ServicePackageSDK

public static interface ServicePackageSDK.ServicePackageClient

Client interface for the ServicePackage resource APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServicePackageSDK.ServicePackageClient.FilterSpec Filter specification populated for and use by the service package search operation.
static class	ServicePackageSDK.ServicePackageClient.Sort All supported sort fields.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<ServicePackage,com.covisint.core.http.service.core.ServiceException>	add(ServicePackage servicePackage) Creates a new service package with a default service.
com.google.common.util.concurrent.CheckedFuture<ServicePackage,com.covisint.core.http.service.core.ServiceException>	get(String packageId) Gets a service package by its id.
com.google.common.util.concurrent.CheckedFuture<List<ServicePackage>,com.covisint.core.http.service.core.ServiceException>	search(ServicePackageSDK.ServicePackageClient.FilterSpec filter, com.covisint.core.http.service.core.Page page, ServicePackageSDK.ServicePackageClient.Sort... sortOrder) Searches for service packages based on the given criteria.

Method Detail

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<ServicePackage>,com.covisint.core.http.service.core.ServiceException> search(ServicePackageSDK.ServicePackageClient.FilterSpec filter,
                                                                                                                                        @Nonnull
                                                                                                                                        com.covisint.core.http.service.core.Page page,
                                                                                                                                        ServicePackageSDK.ServicePackageClient.Sort... sortOrder)

Searches for service packages based on the given criteria.

Parameters:

filter - The filter parameters to use. Pass null if no filtering is desired.

page - The page of results to retrieve. Pass Page.DEFAULT if no specific pagination is required.

sortOrder - The sort criteria to apply before returning the results (optional).

Returns:

Returns a future producing the service packages matching the search criteria.

See Also:

ServicePackageSDK.ServicePackageClient.FilterSpec

add

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackage,com.covisint.core.http.service.core.ServiceException> add(@Nonnull
                                                                                                                               ServicePackage servicePackage)

Creates a new service package with a default service.

Parameters:

servicePackage - The service package to add.

Returns:

Returns a future producing the newly created service package. This object will contain the server-issued id and version of the package.

get

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

Gets a service package by its id.

Parameters:

packageId - The id of the package to retrieve.

Returns:

Returns a future producing the retrieved service package, or null if one doesn't exist for that id.