org.gbif.api.service.registry

Interface OrganizationService

All Superinterfaces:

CommentService, ContactService, EndpointService, IdentifierService, MachineTagService, NetworkEntityService<Organization>, TagService

public interface OrganizationService
extends NetworkEntityService<Organization>

Method Summary

Modifier and Type	Method and Description
boolean	confirmEndorsement(@NotNull UUID organizationKey) Confirm the endorsement of a new Organization without a confirmationKey.
boolean	confirmEndorsement(@NotNull UUID organizationKey, @NotNull UUID confirmationKey) Confirm the endorsement of a new Organization by providing a confirmationKey.
PagingResponse<Dataset>	hostedDatasets(@NotNull UUID organizationKey, Pageable page) Provides paging service to list datasets hosted by, but not owned by, a specific organization.
PagingResponse<Installation>	installations(@NotNull UUID organizationKey, Pageable page) Provides paging service to list installations for the organization.
PagingResponse<Organization>	list(OrganizationRequestSearchParams searchParams) Provides paging service to list organizations that can be filtered by multiple parameters.
PagingResponse<Organization>	listByCountry(Country country, Pageable page) Provides access to all organizations from a country.
PagingResponse<Organization>	listDeleted(OrganizationRequestSearchParams searchParams) Provides access to deleted organizations.
PagingResponse<Organization>	listNonPublishing(Pageable page) Provides access to organizations that are not publishing (e.g.
PagingResponse<Organization>	listPendingEndorsement(Pageable page) Provides access to organizations that are awaiting their endorsement approval.
PagingResponse<Dataset>	publishedDatasets(@NotNull UUID organizationKey, Pageable page) Provides paging service to list datasets published by a specific organization.
boolean	revokeEndorsement(@NotNull UUID organizationKey) Revoke the endorsement of the Organization.
List<KeyTitleResult>	suggest(String q) Provides a simple suggest service.

Methods inherited from interface org.gbif.api.service.registry.NetworkEntityService

create, delete, get, getTitles, list, listByIdentifier, listByIdentifier, listByMachineTag, search, update

Methods inherited from interface org.gbif.api.service.registry.MachineTagService

addMachineTag, addMachineTag, addMachineTag, deleteMachineTag, deleteMachineTags, deleteMachineTags, deleteMachineTags, deleteMachineTags, listMachineTags

Methods inherited from interface org.gbif.api.service.registry.TagService

addTag, addTag, deleteTag, listTags

Methods inherited from interface org.gbif.api.service.registry.CommentService

addComment, deleteComment, listComments

Methods inherited from interface org.gbif.api.service.registry.IdentifierService

addIdentifier, deleteIdentifier, listIdentifiers

Methods inherited from interface org.gbif.api.service.registry.EndpointService

addEndpoint, deleteEndpoint, listEndpoints

Methods inherited from interface org.gbif.api.service.registry.ContactService

addContact, deleteContact, listContacts, updateContact

Method Detail

hostedDatasets

PagingResponse<Dataset> hostedDatasets(@NotNull
                                       @NotNull UUID organizationKey,
                                       @Nullable
                                       Pageable page)

Provides paging service to list datasets hosted by, but not owned by, a specific organization.

publishedDatasets

PagingResponse<Dataset> publishedDatasets(@NotNull
                                          @NotNull UUID organizationKey,
                                          @Nullable
                                          Pageable page)

Provides paging service to list datasets published by a specific organization.

installations

PagingResponse<Installation> installations(@NotNull
                                           @NotNull UUID organizationKey,
                                           @Nullable
                                           Pageable page)

Provides paging service to list installations for the organization.

listByCountry

PagingResponse<Organization> listByCountry(Country country,
                                           @Nullable
                                           Pageable page)

Provides access to all organizations from a country.

listDeleted

PagingResponse<Organization> listDeleted(OrganizationRequestSearchParams searchParams)

Provides access to deleted organizations.

listPendingEndorsement

PagingResponse<Organization> listPendingEndorsement(@Nullable
                                                    Pageable page)

Provides access to organizations that are awaiting their endorsement approval.

listNonPublishing

PagingResponse<Organization> listNonPublishing(@Nullable
                                               Pageable page)

Provides access to organizations that are not publishing (e.g. owning) any datasets.

suggest

List<KeyTitleResult> suggest(@Nullable
                             String q)

Provides a simple suggest service.

confirmEndorsement

boolean confirmEndorsement(@NotNull
                           @NotNull UUID organizationKey,
                           @NotNull
                           @NotNull UUID confirmationKey)

Confirm the endorsement of a new Organization by providing a confirmationKey. Confirming the endorsement of an Organization may not be required or possible depending how the Organization was created.

Parameters:

organizationKey - key of the organization

confirmationKey - (aka challenge code)

Returns:

endorsement was confirmed using the provided keys

confirmEndorsement

boolean confirmEndorsement(@NotNull
                           @NotNull UUID organizationKey)

Confirm the endorsement of a new Organization without a confirmationKey. Confirming the endorsement of an Organization may not be required or possible depending how the Organization was created.

Parameters:

organizationKey - key of the organization

Returns:

endorsement was confirmed using the provided keys

revokeEndorsement

boolean revokeEndorsement(@NotNull
                          @NotNull UUID organizationKey)

Revoke the endorsement of the Organization.

Parameters:

organizationKey - key of the organization

Returns:

endorsement was confirmed using the provided keys

list

PagingResponse<Organization> list(OrganizationRequestSearchParams searchParams)

Provides paging service to list organizations that can be filtered by multiple parameters.

Parameters:

searchParams - OrganizationRequestSearchParams

Returns:

list of organizations ordered by creation date with the latest coming first