Package de.digitalcollections.cudami.server.business.api.service.identifiable

Interface IdentifiableService<I extends de.digitalcollections.model.identifiable.Identifiable>

All Known Subinterfaces:

AgentService, ApplicationFileResourceService, ArticleService, AudioFileResourceService, CollectionService, CorporateBodyService, DigitalObjectService, EntityService<E>, FamilyNameService, FileResourceMetadataService<F>, GeoLocationService, GivenNameService, HeadwordEntryService, HumanSettlementService, ImageFileResourceService, ItemService, LinkedDataFileResourceService, NodeService<N>, PersonService, ProjectService, TextFileResourceService, TopicService, VideoFileResourceService, WebpageService, WebsiteService, WorkService

All Known Implementing Classes:

AgentServiceImpl, ApplicationFileResourceServiceImpl, ArticleServiceImpl, AudioFileResourceServiceImpl, CollectionServiceImpl, CorporateBodyServiceImpl, DigitalObjectServiceImpl, EntityServiceImpl, FamilyNameServiceImpl, FileResourceMetadataServiceImpl, GeoLocationServiceImpl, GivenNameServiceImpl, HeadwordEntryServiceImpl, HumanSettlementServiceImpl, IdentifiableServiceImpl, ImageFileResourceServiceImpl, ItemServiceImpl, LinkedDataFileResourceServiceImpl, PersonServiceImpl, ProjectServiceImpl, TextFileResourceServiceImpl, TopicServiceImpl, VideoFileResourceServiceImpl, WebpageServiceImpl, WebsiteServiceImpl, WorkServiceImpl

public interface IdentifiableService<I extends de.digitalcollections.model.identifiable.Identifiable>

Method Summary

Modifier and Type	Method	Description
default void	addRelatedEntity(I identifiable, de.digitalcollections.model.identifiable.entity.Entity entity)
void	addRelatedEntity(UUID identifiableUuid, UUID entityUuid)
default void	addRelatedFileresource(I identifiable, de.digitalcollections.model.identifiable.resource.FileResource fileResource)
void	addRelatedFileresource(UUID identifiableUuid, UUID fileResourceUuid)
default void	cleanupLabelFromUnwantedLocales(Locale locale, Locale fallbackLocale, de.digitalcollections.model.text.LocalizedText label)
long	count()
boolean	delete(List<UUID> uuids)
default boolean	delete(UUID uuid)
boolean	deleteIdentifiers(UUID identifiableUuid)
de.digitalcollections.model.list.paging.PageResponse<I>	find(de.digitalcollections.model.list.paging.PageRequest pageRequest)
List<I>	find(String searchTerm, int maxResults)
de.digitalcollections.model.list.paging.PageResponse<I>	findByLanguageAndInitial(de.digitalcollections.model.list.paging.PageRequest pageRequest, String language, String initial)
List<I>	getAllFull()
List<I>	getAllReduced()	Returns a list of all identifiables, reduced to their identifiers and last modification date
I	getByIdentifier(de.digitalcollections.model.identifiable.Identifier identifier)
I	getByIdentifier(String namespace, String id)
I	getByUuid(UUID uuid)
I	getByUuidAndLocale(UUID uuid, Locale locale)
List<Locale>	getLanguages()
default List<de.digitalcollections.model.identifiable.entity.Entity>	getRelatedEntities(I identifiable)
List<de.digitalcollections.model.identifiable.entity.Entity>	getRelatedEntities(UUID identifiableUuid)
default List<de.digitalcollections.model.identifiable.resource.FileResource>	getRelatedFileResources(I identifiable)
List<de.digitalcollections.model.identifiable.resource.FileResource>	getRelatedFileResources(UUID identifiableUuid)
I	save(I identifiable)
default List<de.digitalcollections.model.identifiable.entity.Entity>	saveRelatedEntities(I identifiable, List<de.digitalcollections.model.identifiable.entity.Entity> entities)	Save list of entities related to an identifiable.Prerequisite: entities have been saved before (exist already)
List<de.digitalcollections.model.identifiable.entity.Entity>	setRelatedEntities(UUID identifiableUuid, List<de.digitalcollections.model.identifiable.entity.Entity> entities)
default List<de.digitalcollections.model.identifiable.resource.FileResource>	setRelatedFileResources(I identifiable, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)	Save list of file resources related to an identifiable.
List<de.digitalcollections.model.identifiable.resource.FileResource>	setRelatedFileResources(UUID identifiableUuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
I	update(I identifiable)

Method Detail

addRelatedEntity

default void addRelatedEntity(I identifiable,
                              de.digitalcollections.model.identifiable.entity.Entity entity)

addRelatedEntity

void addRelatedEntity(UUID identifiableUuid,
                      UUID entityUuid)

addRelatedFileresource

default void addRelatedFileresource(I identifiable,
                                    de.digitalcollections.model.identifiable.resource.FileResource fileResource)

addRelatedFileresource

void addRelatedFileresource(UUID identifiableUuid,
                            UUID fileResourceUuid)

cleanupLabelFromUnwantedLocales

default void cleanupLabelFromUnwantedLocales(Locale locale,
                                             Locale fallbackLocale,
                                             de.digitalcollections.model.text.LocalizedText label)

count

long count()

delete

default boolean delete(UUID uuid)
                throws IdentifiableServiceException

Throws:

IdentifiableServiceException

delete

boolean delete(List<UUID> uuids)
        throws IdentifiableServiceException

Throws:

IdentifiableServiceException

deleteIdentifiers

boolean deleteIdentifiers(UUID identifiableUuid)

find

de.digitalcollections.model.list.paging.PageResponse<I> find(de.digitalcollections.model.list.paging.PageRequest pageRequest)

find

List<I> find(String searchTerm,
             int maxResults)

getAllFull

List<I> getAllFull()

Returns:

list of ALL identifiables with FULL data. USE WITH CARE (only for internal workflow, NOT FOR USER INTERACTION!)!!!

getAllReduced

List<I> getAllReduced()

Returns a list of all identifiables, reduced to their identifiers and last modification date

Returns:

partially filled complete list of all identifiables of implementing repository entity type

findByLanguageAndInitial

de.digitalcollections.model.list.paging.PageResponse<I> findByLanguageAndInitial(de.digitalcollections.model.list.paging.PageRequest pageRequest,
                                                                                 String language,
                                                                                 String initial)

getByIdentifier

I getByIdentifier(de.digitalcollections.model.identifiable.Identifier identifier)

getByIdentifier

I getByIdentifier(String namespace,
                  String id)

getByUuid

I getByUuid(UUID uuid)

getByUuidAndLocale

I getByUuidAndLocale(UUID uuid,
                     Locale locale)
              throws IdentifiableServiceException

Throws:

IdentifiableServiceException

getLanguages

List<Locale> getLanguages()

getRelatedEntities

default List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities(I identifiable)

getRelatedEntities

List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities(UUID identifiableUuid)

getRelatedFileResources

default List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources(I identifiable)

getRelatedFileResources

List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources(UUID identifiableUuid)

save

I save(I identifiable)
throws IdentifiableServiceException,
       ValidationException

Throws:

IdentifiableServiceException

ValidationException

saveRelatedEntities

default List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities(I identifiable,
                                                                                         List<de.digitalcollections.model.identifiable.entity.Entity> entities)

Save list of entities related to an identifiable.Prerequisite: entities have been saved before (exist already)

Parameters:

identifiable - entity part the entities are related to

entities - the entities that are related to the entity part

Returns:

the list of the related entities

setRelatedEntities

List<de.digitalcollections.model.identifiable.entity.Entity> setRelatedEntities(UUID identifiableUuid,
                                                                                List<de.digitalcollections.model.identifiable.entity.Entity> entities)

setRelatedFileResources

default List<de.digitalcollections.model.identifiable.resource.FileResource> setRelatedFileResources(I identifiable,
                                                                                                     List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)

Save list of file resources related to an identifiable. Prerequisite: file resources have been saved before (exist already)

Parameters:

identifiable - entity part the file resources are related to

fileResources - the file resources that are related to the entity part

Returns:

the list of the related file resources

setRelatedFileResources

List<de.digitalcollections.model.identifiable.resource.FileResource> setRelatedFileResources(UUID identifiableUuid,
                                                                                             List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)

update

I update(I identifiable)
  throws IdentifiableServiceException,
         ValidationException

Throws:

IdentifiableServiceException

ValidationException