com.covisint.platform.oauth.client.sdk

Interface SubjectSDK.SubjectClient

Enclosing class:

SubjectSDK

public static interface SubjectSDK.SubjectClient

Client interface for the Subject resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Subject,com.covisint.core.http.service.core.ServiceException>	delete(String subjectId) Delete a subject by id.
com.google.common.util.concurrent.CheckedFuture<Subject,com.covisint.core.http.service.core.ServiceException>	get(String subjectId) Retrieves a subject by its id.
com.google.common.util.concurrent.CheckedFuture<List<Subject>,com.covisint.core.http.service.core.ServiceException>	search(List<String> subjectIds, com.covisint.core.http.service.core.Page page) Searches for subjects.
com.google.common.util.concurrent.CheckedFuture<Subject,com.covisint.core.http.service.core.ServiceException>	update(Subject subject) Updates the given subject on the server.

Method Detail

delete

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

Delete a subject by id.

Parameters:

subjectId - The id of the subject to delete.

Returns:

Returns a future which, when complete, indicates that the subject was successfully deleted.

update

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

Updates the given subject on the server. If the subject doesn't exist yet, it will be created with the given id.

Parameters:

subject - The subject to persist. The id field must be populated.

Returns:

Returns a future producing the updated subject. This object contains the new version of the subject resource.

get

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

Retrieves a subject by its id.

Parameters:

subjectId - The id of the subject to retrieve.

Returns:

Returns a future producing the subject retrieved for the given id, or null if no matching group was found.

search

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

Searches for subjects.

Parameters:

subjectIds - The subject ids to search for. Pass null to search across all subjects.

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

Returns:

Returns a future producing the iterable collection of subjects.