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​(java.util.UUID identifiableUuid, java.util.UUID entityUuid)  
    default void addRelatedFileresource​(I identifiable, de.digitalcollections.model.identifiable.resource.FileResource fileResource)  
    void addRelatedFileresource​(java.util.UUID identifiableUuid, java.util.UUID fileResourceUuid)  
    default void cleanupLabelFromUnwantedLocales​(java.util.Locale locale, java.util.Locale fallbackLocale, de.digitalcollections.model.text.LocalizedText label)  
    long count()  
    boolean delete​(java.util.List<java.util.UUID> uuids)  
    default boolean delete​(java.util.UUID uuid)  
    boolean deleteIdentifiers​(java.util.UUID identifiableUuid)  
    de.digitalcollections.model.paging.PageResponse<I> find​(de.digitalcollections.model.paging.PageRequest pageRequest)  
    de.digitalcollections.model.paging.SearchPageResponse<I> find​(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)  
    java.util.List<I> find​(java.lang.String searchTerm, int maxResults)  
    java.util.List<I> findAllFull()  
    java.util.List<I> findAllReduced()
    Returns a list of all identifiables, reduced to their identifiers and last modification date
    de.digitalcollections.model.paging.PageResponse<I> findByLanguageAndInitial​(de.digitalcollections.model.paging.PageRequest pageRequest, java.lang.String language, java.lang.String initial)  
    I get​(de.digitalcollections.model.identifiable.Identifier identifier)  
    I get​(java.util.UUID uuid)  
    I get​(java.util.UUID uuid, java.util.Locale locale)  
    I getByIdentifier​(java.lang.String namespace, java.lang.String id)  
    java.util.List<java.util.Locale> getLanguages()  
    default java.util.List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities​(I identifiable)  
    java.util.List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities​(java.util.UUID identifiableUuid)  
    default java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(I identifiable)  
    java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(java.util.UUID identifiableUuid)  
    I save​(I identifiable)  
    default java.util.List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(I identifiable, java.util.List<de.digitalcollections.model.identifiable.entity.Entity> entities)
    Save list of entities related to an identifiable.Prerequisite: entities have been saved before (exist already)
    java.util.List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(java.util.UUID identifiableUuid, java.util.List<de.digitalcollections.model.identifiable.entity.Entity> entities)  
    default java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(I identifiable, java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
    Save list of file resources related to an identifiable.
    java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(java.util.UUID identifiableUuid, java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)  
    I update​(I identifiable)  

  • Method Details

    • addRelatedEntity

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

    • addRelatedEntity

      void addRelatedEntity​(java.util.UUID identifiableUuid, java.util.UUID entityUuid)

    • addRelatedFileresource

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

    • addRelatedFileresource

      void addRelatedFileresource​(java.util.UUID identifiableUuid, java.util.UUID fileResourceUuid)

    • cleanupLabelFromUnwantedLocales

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

    • count

      long count()

    • delete

      default boolean delete​(java.util.UUID uuid) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException

    • delete

      boolean delete​(java.util.List<java.util.UUID> uuids) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException

    • deleteIdentifiers

      boolean deleteIdentifiers​(java.util.UUID identifiableUuid)

    • find

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

    • find

      de.digitalcollections.model.paging.SearchPageResponse<I> find​(de.digitalcollections.model.paging.SearchPageRequest searchPageRequest)

    • find

      java.util.List<I> find​(java.lang.String searchTerm, int maxResults)

    • findAllFull

      java.util.List<I> findAllFull()
      Returns:
      list of ALL identifiables with FULL data. USE WITH CARE (only for internal workflow, NOT FOR USER INTERACTION!)!!!

    • findAllReduced

      java.util.List<I> findAllReduced()
      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.paging.PageResponse<I> findByLanguageAndInitial​(de.digitalcollections.model.paging.PageRequest pageRequest, java.lang.String language, java.lang.String initial)

    • get

      I get​(de.digitalcollections.model.identifiable.Identifier identifier)

    • get

      I get​(java.util.UUID uuid)

    • get

      I get​(java.util.UUID uuid, java.util.Locale locale) throws IdentifiableServiceException
      Throws:
      IdentifiableServiceException

    • getByIdentifier

      I getByIdentifier​(java.lang.String namespace, java.lang.String id)

    • getLanguages

      java.util.List<java.util.Locale> getLanguages()

    • getRelatedEntities

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

    • getRelatedEntities

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

    • getRelatedFileResources

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

    • getRelatedFileResources

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

    • save

      I save​(I identifiable) throws IdentifiableServiceException, ValidationException
      Throws:
      IdentifiableServiceException
      ValidationException

    • saveRelatedEntities

      default java.util.List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(I identifiable, java.util.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

    • saveRelatedEntities

      java.util.List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(java.util.UUID identifiableUuid, java.util.List<de.digitalcollections.model.identifiable.entity.Entity> entities)

    • saveRelatedFileResources

      default java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(I identifiable, java.util.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

    • saveRelatedFileResources

      java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(java.util.UUID identifiableUuid, java.util.List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)

    • update

      I update​(I identifiable) throws IdentifiableServiceException, ValidationException
      Throws:
      IdentifiableServiceException
      ValidationException