com.covisint.platform.user.client.sdk

Interface PersonRequestSDK.PersonRequestClient

Enclosing class:

PersonRequestSDK

public static interface PersonRequestSDK.PersonRequestClient

Client interface for the person request resource APIs.

Method Summary

Methods

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

Method Detail

get

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

Get a person request by id.

Parameters:

requestId - The id of the person request to be returned.

Returns:

Returns a future producing the person request resource, if it exists, otherwise produces null.

add

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

Add a new person request.

Parameters:

request - The person request to be added.

Returns:

Returns a future that will produce the newly created person request resource. This resource will contain the server-issued id and version.

delete

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

Delete a person request.

Parameters:

requestId - The id of the person request to delete.

Returns:

Returns a future that will produce the deleted person request.

search

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

Search for person requests based on the given criteria.

Parameters:

registrantId - The registrant id to search. Returns all requests sent by the registrant.

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

Returns:

Returns a future producing a list of all matching person requests.

approve

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

Approves a person request.

Parameters:

requestId - The id of the person request to approve.

Returns:

Returns a future which can be used to check for successful completion.