Package org.gbif.api.service.registry

Interface NodeService

All Superinterfaces:

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

public interface NodeService
extends NetworkEntityService<Node>

Actions on a GBIF node. Be aware that of 2013 Nodes DO NOT support the ContactInterface although advertised in this interface!!!

Method Summary

Modifier and Type	Method	Description
PagingResponse<Dataset>	endorsedDatasets(@NotNull UUID nodeKey, Pageable page)	Provides paging service to list datasets published, i.e.
PagingResponse<Organization>	endorsedOrganizations(@NotNull UUID nodeKey, Pageable page)	Provides access to the organizations endorsed by a single node.
Node	getByCountry(Country country)	Returns a node for a given country.
PagingResponse<Installation>	installations(@NotNull UUID nodeKey, Pageable page)	Provides the installations that are registered to organizations with an approved endorsement from the node.
PagingResponse<Node>	list(NodeRequestSearchParams searchParams)	Provides paging service to list nodes that can be filtered by multiple parameters.
List<Country>	listActiveCountries()	Returns those countries considered active in GBIF.
List<Country>	listNodeCountries()	Returns a list of all countries which do have a GBIF node.
PagingResponse<Organization>	pendingEndorsements(@NotNull UUID nodeKey, Pageable page)	Provides access to the organizations that are awaiting an endorsement approval for the given node.
PagingResponse<Organization>	pendingEndorsements(Pageable page)	Provides access to the organizations that are awaiting an endorsement approval.
List<KeyTitleResult>	suggest(String q)	Provides a simple suggest service.

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

addComment, deleteComment, listComments

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

addContact, deleteContact, listContacts, updateContact

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

addEndpoint, deleteEndpoint, listEndpoints

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

addIdentifier, deleteIdentifier, listIdentifiers

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.NetworkEntityService

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

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

addTag, addTag, deleteTag, listTags

Method Detail

endorsedOrganizations

PagingResponse<Organization> endorsedOrganizations(@NotNull
                                                   @NotNull UUID nodeKey,
                                                   @Nullable
                                                   Pageable page)

Provides access to the organizations endorsed by a single node.

pendingEndorsements

PagingResponse<Organization> pendingEndorsements(@Nullable
                                                 Pageable page)

Provides access to the organizations that are awaiting an endorsement approval.

pendingEndorsements

PagingResponse<Organization> pendingEndorsements(@NotNull
                                                 @NotNull UUID nodeKey,
                                                 @Nullable
                                                 Pageable page)

Provides access to the organizations that are awaiting an endorsement approval for the given node.

installations

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

Provides the installations that are registered to organizations with an approved endorsement from the node.

getByCountry

Node getByCountry(Country country)

Returns a node for a given country.

Returns:

the countries node or null if none exists

listNodeCountries

List<Country> listNodeCountries()

Returns a list of all countries which do have a GBIF node.

Returns:

list of distinct countries having a GBIF node

listActiveCountries

List<Country> listActiveCountries()

Returns those countries considered active in GBIF. To be active a country must have a Node of type country present, that is either of voting or associate status.

Returns:

A list of countries ordered by iso code

endorsedDatasets

PagingResponse<Dataset> endorsedDatasets(@NotNull
                                         @NotNull UUID nodeKey,
                                         @Nullable
                                         Pageable page)

Provides paging service to list datasets published, i.e. owned by organizations endorsed by the given node.

Returns:

list of datasets ordered by creation date with latest coming first

suggest

List<KeyTitleResult> suggest(@Nullable
                             String q)

Provides a simple suggest service.

list

PagingResponse<Node> list(NodeRequestSearchParams searchParams)

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

Parameters:

searchParams - NodeRequestSearchParams

Returns:

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