com.covisint.platform.organization.client.sdk

Interface OrganizationSDK.OrganizationClient

Enclosing class:

OrganizationSDK

public static interface OrganizationSDK.OrganizationClient

Client interface for the Organization resource APIs.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.common.util.concurrent.CheckedFuture<Organization,com.covisint.core.http.service.core.ServiceException>	add(Organization organization) Add a new organization.
com.google.common.util.concurrent.CheckedFuture<Organization,com.covisint.core.http.service.core.ServiceException>	get(String organizationId) Retrieves an organization by its id.
com.google.common.util.concurrent.CheckedFuture<com.covisint.core.http.service.core.ResourceReferenceNode<com.covisint.core.http.service.core.NamedResourceReference>,com.covisint.core.http.service.core.ServiceException>	getHierarchy(String organizationId) Retrieves the hierarchy of the given organization id.
com.google.common.util.concurrent.CheckedFuture<List<Organization>,com.covisint.core.http.service.core.ServiceException>	search(List<String> name, String parentOrganizationId, String rootOrganizationId, com.covisint.core.http.service.core.Page page) Searches for organizations based on the supported search criteria.
com.google.common.util.concurrent.CheckedFuture<Organization,com.covisint.core.http.service.core.ServiceException>	update(Organization organization) Updates the given organization on the server.

Method Detail

add

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

Add a new organization.

Parameters:

organization - The organization to add.

Returns:

Returns a future producing the newly created organization. This object contains the server-issued id and version.

update

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

Updates the given organization on the server. The id of the organization must exist on the server, otherwise a resource-not-found error will be thrown.

Parameters:

organization - The organization to update.

Returns:

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

get

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

Retrieves an organization by its id.

Parameters:

organizationId - The id of the organization to retrieve.

Returns:

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

search

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

Searches for organizations based on the supported search criteria.

Parameters:

name - The names of organizations to search for. Pass null or an empty list to skip filtering on name.

parentOrganizationId - The id of the parent organization. If specified, search for all organizations who have the given parent org id.

rootOrganizationId - The id of the root organization. If specified, search for all organization who have the given root/ancestor org id.

page - The pagination criteria to apply. Pass Page.DEFAULT if no specific pagination is required.

Returns:

Returns a future producing the list of matching organizations.

getHierarchy

@Nonnull
com.google.common.util.concurrent.CheckedFuture<com.covisint.core.http.service.core.ResourceReferenceNode<com.covisint.core.http.service.core.NamedResourceReference>,com.covisint.core.http.service.core.ServiceException> getHierarchy(@Nonnull@NotEmpty
                                                                                                                                                                                                                                               String organizationId)

Retrieves the hierarchy of the given organization id. Represented as a tree of NamedResourceReference s.

Parameters:

organizationId - The id of the organization whose hierarchy needs to be retrieved.

Returns:

the root node of the hierarchy of the given organization id.