com.covisint.platform.service.client.sdk

Interface ServicePackageRequestSDK.ServicePackageRequestClient

Enclosing class:

ServicePackageRequestSDK

public static interface ServicePackageRequestSDK.ServicePackageRequestClient

Client interface for the ServicePackageRequest resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<ServicePackageRequest,com.covisint.core.http.service.core.ServiceException>	add(ServicePackageRequest request) Add a new service package request.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	approve(String requestId, String justification) Approves a service package request.
com.google.common.util.concurrent.CheckedFuture<ServicePackageRequest,com.covisint.core.http.service.core.ServiceException>	delete(String requestId) Delete a service package request.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	deny(String requestId, String justification) Denies a service package request.
com.google.common.util.concurrent.CheckedFuture<ServicePackageRequest,com.covisint.core.http.service.core.ServiceException>	get(String requestId) Get a service package request by its id.
com.google.common.util.concurrent.CheckedFuture<List<ServicePackageRequest>,com.covisint.core.http.service.core.ServiceException>	search(String requestorId, RequestorType requestorType, com.covisint.core.http.service.core.Page page) Search for service package requests based on the given criteria.

Method Detail

get

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

Get a service package request by its id.

Parameters:

requestId - The id of the request to be returned.

Returns:

Returns a future providing the service package request, if it exists.

add

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

Add a new service package request.

Parameters:

request - The service package request to be added.

Returns:

Returns a future that will produce the newly created service package request. This object will contain the server-issued id and version.

delete

@Nonnull
com.google.common.util.concurrent.CheckedFuture<ServicePackageRequest,com.covisint.core.http.service.core.ServiceException> delete(@Nonnull@NotEmpty
                                                                                                                                         String requestId)

Delete a service package request.

Parameters:

requestId - The id of the service package request to delete.

Returns:

Returns a future that, when complete, will indicate the package request has been deleted.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<ServicePackageRequest>,com.covisint.core.http.service.core.ServiceException> search(String requestorId,
                                                                                                                                               RequestorType requestorType,
                                                                                                                                               @Nonnull
                                                                                                                                               com.covisint.core.http.service.core.Page page)

Search for service package requests based on the given criteria.

Parameters:

requestorId - The id of the requestor.

requestorType - The requestor type. Pass null to find all requestor types.

page - the page of results to return. Pass Page.DEFAULT to return the standard result collection.

Returns:

Returns a future producing all matching package requests found in the system.

approve

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> approve(@Nonnull@NotEmpty
                                                                                                                         String requestId,
                                                                                                                         String justification)

Approves a service package request.

Parameters:

requestId - The id of the service package request to approve.

justification - The optional justification for why the decision was made.

Returns:

Returns a future that, when complete, will indicate the package request has been approved.

deny

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException> deny(@Nonnull@NotEmpty
                                                                                                                      String requestId,
                                                                                                                      String justification)

Denies a service package request.

Parameters:

requestId - The id of the service package request to deny.

justification - The optional justification for why the decision was made.

Returns:

Returns a future that, when complete, will indicate the package request has been denied.