com.covisint.platform.user.client.person

Interface PersonClient

All Superinterfaces:

com.covisint.core.http.service.client.ResourceClient<Person>

All Known Implementing Classes:

PersonClientImpl

public interface PersonClient
extends com.covisint.core.http.service.client.ResourceClient<Person>

Client for reading and updating information about people.

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, org.apache.http.protocol.HttpContext context) Activates a Person in pending status.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	suspend(String personId, org.apache.http.protocol.HttpContext context) Suspends a Person in active status.
com.google.common.util.concurrent.CheckedFuture<Void,com.covisint.core.http.service.core.ServiceException>	unsuspend(String personId, org.apache.http.protocol.HttpContext context) Unsuspends a Person in suspend status.

Methods inherited from interface com.covisint.core.http.service.client.ResourceClient

add, delete, get, get, persist, search, search

Method Detail

activate

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

Activates a Person in pending status.

Parameters:

personId - The id of the Person to activate.

context - The HTTP context used to pass state.

Returns:

Returns a future which can be 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,
                                                                                                                 @Nonnull
                                                                                                                 org.apache.http.protocol.HttpContext context)

Suspends a Person in active status.

Parameters:

personId - The id of the Person to suspend.

context - The HTTP context used to pass state.

Returns:

Returns a future which can be 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,
                                                                                                                   @Nonnull
                                                                                                                   org.apache.http.protocol.HttpContext context)

Unsuspends a Person in suspend status.

Parameters:

personId - The id of the Person to unsuspend.

context - The HTTP context used to pass state.

Returns:

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