org.gbif.api.service.registry

Interface InstallationService

All Superinterfaces:

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

public interface InstallationService
extends NetworkEntityService<Installation>

Method Summary

Modifier and Type	Method and Description
PagingResponse<Dataset>	getHostedDatasets(@NotNull UUID installationKey, Pageable page) Provides paging service to list datasets hosted by a specific installation.
PagingResponse<Installation>	list(InstallationRequestSearchParams searchParams) Provides paging service to list installations that can be filtered by multiple parameters.
PagingResponse<Installation>	listByType(InstallationType type, Pageable page) Provides paging service to list installations filtered by a particular installation type.
PagingResponse<Installation>	listDeleted(InstallationRequestSearchParams searchParams) Provides access to deleted installations.
PagingResponse<Installation>	listNonPublishing(Pageable page) Provides access to installations that serve no datasets.
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

getHostedDatasets

PagingResponse<Dataset> getHostedDatasets(@NotNull
                                          @NotNull UUID installationKey,
                                          @Nullable
                                          Pageable page)

Provides paging service to list datasets hosted by a specific installation.

Parameters:

page - paging parameters to use, if page is null sensible defaults will be used

listDeleted

PagingResponse<Installation> listDeleted(InstallationRequestSearchParams searchParams)

Provides access to deleted installations.

listNonPublishing

PagingResponse<Installation> listNonPublishing(@Nullable
                                               Pageable page)

Provides access to installations that serve no datasets.

suggest

List<KeyTitleResult> suggest(@Nullable
                             String q)

Provides a simple suggest service.

listByType

PagingResponse<Installation> listByType(InstallationType type,
                                        @Nullable
                                        Pageable page)

Provides paging service to list installations filtered by a particular installation type.

Parameters:

type - the installation type filter

Returns:

list of installations ordered by creation date with latest coming first

list

PagingResponse<Installation> list(InstallationRequestSearchParams searchParams)

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

Parameters:

searchParams - InstallationRequestSearchParams

Returns:

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