Package org.gbif.api.service.registry
Interface OrganizationService
- All Superinterfaces:
CommentService
,ContactService
,EndpointService
,IdentifierService
,MachineTagService
,NetworkEntityService<Organization>
,TagService
-
Method Summary
Modifier and TypeMethodDescriptionboolean
confirmEndorsement
(@NotNull UUID organizationKey) Confirm the endorsement of a newOrganization
without a confirmationKey.boolean
confirmEndorsement
(@NotNull UUID organizationKey, @NotNull UUID confirmationKey) Confirm the endorsement of a newOrganization
by providing a confirmationKey.hostedDatasets
(@NotNull UUID organizationKey, Pageable page) Provides paging service to list datasets hosted by, but not owned by, a specific organization.installations
(@NotNull UUID organizationKey, Pageable page) Provides paging service to list installations for the organization.list
(OrganizationRequestSearchParams searchParams) Provides paging service to list organizations that can be filtered by multiple parameters.listByCountry
(Country country, Pageable page) Provides access to all organizations from a country.listDeleted
(OrganizationRequestSearchParams searchParams) Provides access to deleted organizations.org.geojson.FeatureCollection
Lists the organizations in GeoJson format.listNonPublishing
(Pageable page) Provides access to organizations that are not publishing (e.g.Provides access to organizations that are awaiting their endorsement approval.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 theOrganization
.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 Details
-
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
Provides access to all organizations from a country. -
listDeleted
Provides access to deleted organizations. -
listPendingEndorsement
Provides access to organizations that are awaiting their endorsement approval. -
listNonPublishing
Provides access to organizations that are not publishing (e.g. owning) any datasets. -
suggest
Provides a simple suggest service. -
confirmEndorsement
boolean confirmEndorsement(@NotNull @NotNull UUID organizationKey, @NotNull @NotNull UUID confirmationKey) Confirm the endorsement of a newOrganization
by providing a confirmationKey. Confirming the endorsement of anOrganization
may not be required or possible depending how theOrganization
was created.- Parameters:
organizationKey
- key of the organizationconfirmationKey
- (aka challenge code)- Returns:
- endorsement was confirmed using the provided keys
-
confirmEndorsement
Confirm the endorsement of a newOrganization
without a confirmationKey. Confirming the endorsement of anOrganization
may not be required or possible depending how theOrganization
was created.- Parameters:
organizationKey
- key of the organization- Returns:
- endorsement was confirmed using the provided keys
-
revokeEndorsement
Revoke the endorsement of theOrganization
.- Parameters:
organizationKey
- key of the organization- Returns:
- endorsement was confirmed using the provided keys
-
list
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
-
listGeoJson
Lists the organizations in GeoJson format.- Parameters:
request
- parameters to filter the request- Returns:
- a
FeatureCollection
object that conforms with GeoJson
-