com.covisint.platform.user.client.sdk

Interface PersonSDK.PersonClient

Enclosing class:

PersonSDK

public static interface PersonSDK.PersonClient

Client interface for the Person resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	activate(String personId) Activates a Person in pending status.
com.google.common.util.concurrent.CheckedFuture<Person,com.covisint.core.http.service.core.ServiceException>	add(Person person) Add a new person.
com.google.common.util.concurrent.CheckedFuture<Person,com.covisint.core.http.service.core.ServiceException>	get(String personId) Get a person by id.
com.google.common.util.concurrent.CheckedFuture<List<Person>,com.covisint.core.http.service.core.ServiceException>	search(List<String> ids, String authenicationDomain, String username, String parentOrganizationId, com.covisint.core.http.service.core.Page page) Search for persons based on the given criteria.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	suspend(String personId) Suspends a Person in active status.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	unsuspend(String personId) Unsuspends a Person in suspend status.
com.google.common.util.concurrent.CheckedFuture<Person,com.covisint.core.http.service.core.ServiceException>	update(Person person) Updates an existing person on the server.

Method Detail

get

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

Get a person by id.

Parameters:

personId - The id of the person to be returned.

Returns:

Returns a future providing the person resource, if it exists.

add

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

Add a new person.

Parameters:

person - The person to be added.

Returns:

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

update

@Nonnull
com.google.common.util.concurrent.CheckedFuture<Person,com.covisint.core.http.service.core.ServiceException> update(@Nonnull
                                                                                                                          Person person)

Updates an existing person on the server. The person must already exist, otherwise an error is thrown.

Parameters:

person - The person to persist.

Returns:

Returns a future that will produce the updated person.

search

@Nonnull
com.google.common.util.concurrent.CheckedFuture<List<Person>,com.covisint.core.http.service.core.ServiceException> search(List<String> ids,
                                                                                                                                String authenicationDomain,
                                                                                                                                String username,
                                                                                                                                String parentOrganizationId,
                                                                                                                                @Nonnull
                                                                                                                                com.covisint.core.http.service.core.Page page)

Search for persons based on the given criteria.

Parameters:

ids - The ids of the persons to retrieve.

authenicationDomain - The person's authentication domain. This value is useful to constrain the username parameter further, since there may be multiple usernames in use across multiple authentication domains. If unsure what value to provide, leave this null.

username - The username to search for.

parentOrganizationId - The id of the person's parent organization.

page - The pagination criteria. Pass Page.DEFAULT to return the default page.

Returns:

Returns a future producing a list of matching person resources.

activate

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

Activates a Person in pending status.

Parameters:

personId - The id of the Person to activate.

Returns:

Returns a future used to check for successful completion (or error).

suspend

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

Suspends a Person in active status.

Parameters:

personId - The id of the Person to suspend.

Returns:

Returns a future used to check for successful completion (or error).

unsuspend

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

Unsuspends a Person in suspend status.

Parameters:

personId - The id of the Person to unsuspend.

Returns:

Returns a future used to check for successful completion (or error).