public interface DescriptorsService
Modifier and Type | Method and Description |
---|---|
long |
countDescriptors(DescriptorSearchRequest searchRequest)
Counts the number of
Descriptor for the request received. |
long |
createDescriptorGroup(@NotNull @Valid byte[] descriptorsGroupFile,
@NotNull ExportFormat format,
@NotNull String title,
String description,
@NotNull UUID collectionKey)
Creates a new descriptor group.
|
void |
deleteDescriptorGroup(@NotNull long key)
Deletes a descriptor group by key.
|
Descriptor |
getDescriptor(@NotNull long key)
Retrieves a descriptor by its key.
|
DescriptorGroup |
getDescriptorGroup(@NotNull long key)
Retrieves a descriptor group by its key.
|
Set<String> |
getVerbatimNames(long descriptorGroupKey)
Get the names of the verbatim fields of a descriptor group.
|
PagingResponse<DescriptorGroup> |
listDescriptorGroups(@NotNull UUID collectionKey,
DescriptorGroupSearchRequest searchRequest)
Pages
DescriptorGroup entities based on the parameters received. |
PagingResponse<Descriptor> |
listDescriptors(DescriptorSearchRequest searchRequest)
Pages
Descriptor entities based on the parameters received. |
void |
updateDescriptorGroup(@NotNull long descriptorGroupKey,
@NotNull byte[] descriptorsGroupFile,
@NotNull ExportFormat format,
@NotNull String title,
String description)
Updates an existing descriptor group.
|
long createDescriptorGroup(@NotNull @Valid @NotNull @Valid byte[] descriptorsGroupFile, @NotNull @NotNull ExportFormat format, @NotNull @NotNull String title, String description, @NotNull @NotNull UUID collectionKey)
// TODO
void deleteDescriptorGroup(@NotNull @NotNull long key)
key
- of the descriptor group to be deleted.DescriptorGroup getDescriptorGroup(@NotNull @NotNull long key)
key
- of the descriptor group to be retrieved.void updateDescriptorGroup(@NotNull @NotNull long descriptorGroupKey, @NotNull @NotNull byte[] descriptorsGroupFile, @NotNull @NotNull ExportFormat format, @NotNull @NotNull String title, String description)
//
- TODOPagingResponse<DescriptorGroup> listDescriptorGroups(@NotNull @NotNull UUID collectionKey, DescriptorGroupSearchRequest searchRequest)
DescriptorGroup
entities based on the parameters received.searchRequest
- DescriptorGroupSearchRequest
with all the parametersDescriptor getDescriptor(@NotNull @NotNull long key)
key
- of the descriptor to be retrieved.PagingResponse<Descriptor> listDescriptors(DescriptorSearchRequest searchRequest)
Descriptor
entities based on the parameters received.searchRequest
- DescriptorSearchRequest
with all the parameterslong countDescriptors(DescriptorSearchRequest searchRequest)
Descriptor
for the request received.searchRequest
- DescriptorSearchRequest
with all the parametersSet<String> getVerbatimNames(long descriptorGroupKey)
descriptorGroupKey
- key of the descriptor group.Copyright © 2024 Global Biodiversity Information Facility (GBIF). All rights reserved.