org.gbif.api.service.registry

Interface NetworkService

All Superinterfaces:

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

public interface NetworkService
extends NetworkEntityService<Network>

Method Summary

Modifier and Type	Method and Description
void	addConstituent(@NotNull UUID networkKey, @NotNull UUID datasetKey) Adds an existing dataset to the list of constituents of a network.
PagingResponse<Network>	list(NetworkRequestSearchParams searchParams) Provides paging service to list networks that can be filtered by multiple parameters.
PagingResponse<Dataset>	listConstituents(@NotNull UUID networkKey, Pageable page) Pages through dataset constituents of a network, i.e.
PagingResponse<Organization>	publishingOrganizations(@NotNull UUID networkKey, Pageable page) Pages through publishing organizations of a network.
void	removeConstituent(@NotNull UUID networkKey, @NotNull UUID datasetKey) Removes an existing constituent dataset from a network.
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

listConstituents

PagingResponse<Dataset> listConstituents(@NotNull
                                         @NotNull UUID networkKey,
                                         @Nullable
                                         Pageable page)

Pages through dataset constituents of a network, i.e. returns datasets which have an entry in the dataset_network table.

Parameters:

networkKey - the network identifier

publishingOrganizations

PagingResponse<Organization> publishingOrganizations(@NotNull
                                                     @NotNull UUID networkKey,
                                                     @Nullable
                                                     Pageable page)

Pages through publishing organizations of a network.

Parameters:

networkKey - the network identifier

addConstituent

void addConstituent(@NotNull
                    @NotNull UUID networkKey,
                    @NotNull
                    @NotNull UUID datasetKey)

Adds an existing dataset to the list of constituents of a network.

Parameters:

networkKey - the network to add the dataset to

datasetKey - the dataset to be added

removeConstituent

void removeConstituent(@NotNull
                       @NotNull UUID networkKey,
                       @NotNull
                       @NotNull UUID datasetKey)

Removes an existing constituent dataset from a network.

Parameters:

networkKey - the network to remove the dataset from

datasetKey - the dataset to be removed

suggest

List<KeyTitleResult> suggest(@Nullable
                             String q)

Provides a simple suggest service.

list

PagingResponse<Network> list(NetworkRequestSearchParams searchParams)

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

Parameters:

searchParams - NetworkRequestSearchParams

Returns:

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