public interface InstitutionService extends CollectionEntityService<Institution>
Modifier and Type | Method and Description |
---|---|
void |
convertToCollection(UUID targetEntityKey,
UUID collectionKey)
Converts an institution into a collection.
|
UUID |
createFromLatimerCore(@NotNull @Valid OrganisationalUnit organisationalUnit)
Similar to
CrudService.create(CollectionEntity) but it accepts Latimer Core. |
UUID |
createFromOrganization(UUID organizationKey,
String institutionCode)
Creates a
Institution from a Organization . |
OrganisationalUnit |
getAsLatimerCore(@NotNull UUID key)
Similar to the
CrudService.get(UUID) method but returns the results in Latimer Core format. |
PagingResponse<Institution> |
list(InstitutionSearchRequest searchRequest)
Pages
Institution entities based on the parameters received. |
PagingResponse<OrganisationalUnit> |
listAsLatimerCore(InstitutionSearchRequest searchRequest)
Similar to the
list(InstitutionSearchRequest) method but returns the results in
Latimer Core format. |
PagingResponse<Institution> |
listDeleted(InstitutionSearchRequest searchRequest)
Provides access to deleted institutions.
|
org.geojson.FeatureCollection |
listGeojson(InstitutionSearchRequest searchRequest)
Lists the institutions in GeoJson format.
|
List<KeyCodeNameResult> |
suggest(String q)
Provides a simple suggest service.
|
void |
updateFromLatimerCore(@NotNull @Valid OrganisationalUnit entity)
Similar to
CrudService.update(CollectionEntity) )} but it accepts Latimer Core. |
addMasterSourceMetadata, deleteMasterSourceMetadata, findByMasterSource, getMasterSourceMetadata, replace, update
create, delete, exists, get, update
addIdentifier, deleteIdentifier, listIdentifiers
addTag, addTag, deleteTag, listTags
addMachineTag, addMachineTag, addMachineTag, deleteMachineTag, deleteMachineTags, deleteMachineTags, deleteMachineTags, deleteMachineTags, listMachineTags
addComment, deleteComment, listComments
addContactPerson, listContactPersons, removeContactPerson, replaceContactPersons, updateContactPerson
addOccurrenceMapping, deleteOccurrenceMapping, listOccurrenceMappings
PagingResponse<Institution> list(InstitutionSearchRequest searchRequest)
Institution
entities based on the parameters received.
To iterate over all entities you can use code like this: PagingRequest req =
new PagingRequest(); PagingResponse<T> response; do { response = service.list(req); for (T obj
: response.getResults()) { doStuff(); } req.nextPage(); } while (!response.isEndOfRecords());
searchRequest
- InstitutionSearchRequest
with all the parametersPagingResponse<OrganisationalUnit> listAsLatimerCore(InstitutionSearchRequest searchRequest)
list(InstitutionSearchRequest)
method but returns the results in
Latimer Core format.OrganisationalUnit getAsLatimerCore(@NotNull @NotNull UUID key)
CrudService.get(UUID)
method but returns the results in Latimer Core format.UUID createFromLatimerCore(@NotNull @Valid @NotNull @Valid OrganisationalUnit organisationalUnit)
CrudService.create(CollectionEntity)
but it accepts Latimer Core.void updateFromLatimerCore(@NotNull @Valid @NotNull @Valid OrganisationalUnit entity)
CrudService.update(CollectionEntity)
)} but it accepts Latimer Core.PagingResponse<Institution> listDeleted(InstitutionSearchRequest searchRequest)
List<KeyCodeNameResult> suggest(@Nullable String q)
void convertToCollection(UUID targetEntityKey, UUID collectionKey)
UUID createFromOrganization(UUID organizationKey, String institutionCode)
Institution
from a Organization
.organizationKey
- key of the dataset to create the institution frominstitutionCode
- the code to assign to the institution since it can't be inferred from
the organizationorg.geojson.FeatureCollection listGeojson(InstitutionSearchRequest searchRequest)
searchRequest
- parameters to filter the requestFeatureCollection
object that conforms with GeoJsonCopyright © 2024 Global Biodiversity Information Facility (GBIF). All rights reserved.