com.covisint.platform.service.client.sdk

Interface ServiceSDK.ServiceClient

Enclosing class:

ServiceSDK

public static interface ServiceSDK.ServiceClient

Client interface for the Service resource APIs.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Service,com.covisint.core.http.service.core.ServiceException>	add(Service service) Adds a new service.
com.google.common.util.concurrent.CheckedFuture<Service,com.covisint.core.http.service.core.ServiceException>	get(String serviceId) Gets a service by its id.
com.google.common.util.concurrent.CheckedFuture<List<Service>,com.covisint.core.http.service.core.ServiceException>	search(ServiceSDK.ServiceClient.FilterSpec filter, com.covisint.core.http.service.core.Page page, ServiceSDK.ServiceClient.Sort... sortOrder) Searches for services based on the given criteria.

Method Detail

search

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

Searches for services 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 services matching the search criteria.

See Also:

ServiceSDK.ServiceClient.FilterSpec

add

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

Adds a new service.

Parameters:

service - The service to add.

Returns:

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

get

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

Gets a service by its id.

Parameters:

serviceId - The id of the service to retrieve.

Returns:

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