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

Interface HeadwordService

  • All Known Implementing Classes:
    HeadwordServiceImpl
    public interface HeadwordService
    Service for Headword.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void addRelatedEntity​(de.digitalcollections.model.semantic.Headword headword, de.digitalcollections.model.identifiable.entity.Entity entity)  
      void addRelatedEntity​(UUID headwordUuid, UUID entityUuid)  
      default void addRelatedFileresource​(de.digitalcollections.model.semantic.Headword headword, de.digitalcollections.model.identifiable.resource.FileResource fileResource)  
      void addRelatedFileresource​(UUID headwordUuid, UUID fileResourceUuid)  
      long count()  
      boolean delete​(List<UUID> uuids)  
      default boolean delete​(UUID uuid)  
      de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.semantic.Headword> find​(de.digitalcollections.model.list.paging.PageRequest pageRequest)  
      List<de.digitalcollections.model.semantic.Headword> find​(String searchTerm, int maxResults)  
      List<de.digitalcollections.model.semantic.Headword> findByLabelAndLocale​(String label, Locale locale)  
      de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.semantic.Headword> findByLanguageAndInitial​(de.digitalcollections.model.list.paging.PageRequest pageRequest, String language, String initial)  
      de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Entity> findRelatedEntities​(UUID uuid, de.digitalcollections.model.list.paging.PageRequest pageRequest)  
      de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.resource.FileResource> findRelatedFileResources​(UUID uuid, de.digitalcollections.model.list.paging.PageRequest pageRequest)  
      List<de.digitalcollections.model.semantic.Headword> getAll()  
      de.digitalcollections.model.semantic.Headword getByUuid​(UUID uuid)  
      List<Locale> getLanguages()  
      List<de.digitalcollections.model.semantic.Headword> getRandom​(int count)  
      default List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities​(de.digitalcollections.model.semantic.Headword headword)  
      List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities​(UUID headwordUuid)  
      default List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(de.digitalcollections.model.semantic.Headword headword)  
      List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(UUID headwordUuid)  
      de.digitalcollections.model.semantic.Headword save​(de.digitalcollections.model.semantic.Headword headword)  
      default List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(de.digitalcollections.model.semantic.Headword headword, List<de.digitalcollections.model.identifiable.entity.Entity> entities)
      Save list of entities related to an Headword.
      default List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(de.digitalcollections.model.semantic.Headword headword, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
      Save list of file resources related to an Headword.
      List<de.digitalcollections.model.identifiable.entity.Entity> setRelatedEntities​(UUID headwordUuid, List<de.digitalcollections.model.identifiable.entity.Entity> entities)  
      List<de.digitalcollections.model.identifiable.resource.FileResource> setRelatedFileResources​(UUID headwordUuid, List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)  
      de.digitalcollections.model.semantic.Headword update​(de.digitalcollections.model.semantic.Headword headword)  

    • Method Detail

      • addRelatedEntity

        default void addRelatedEntity​(de.digitalcollections.model.semantic.Headword headword,
                              de.digitalcollections.model.identifiable.entity.Entity entity)

      • addRelatedEntity

        void addRelatedEntity​(UUID headwordUuid,
                      UUID entityUuid)

      • addRelatedFileresource

        default void addRelatedFileresource​(de.digitalcollections.model.semantic.Headword headword,
                                    de.digitalcollections.model.identifiable.resource.FileResource fileResource)

      • addRelatedFileresource

        void addRelatedFileresource​(UUID headwordUuid,
                            UUID fileResourceUuid)

      • count

        long count()

      • delete

        default boolean delete​(UUID uuid)

      • delete

        boolean delete​(List<UUID> uuids)

      • find

        de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.semantic.Headword> find​(de.digitalcollections.model.list.paging.PageRequest pageRequest)

      • find

        List<de.digitalcollections.model.semantic.Headword> find​(String searchTerm,
                                                         int maxResults)

      • findByLabelAndLocale

        List<de.digitalcollections.model.semantic.Headword> findByLabelAndLocale​(String label,
                                                                         Locale locale)

      • findByLanguageAndInitial

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

      • findRelatedEntities

        de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.Entity> findRelatedEntities​(UUID uuid,
                                                                                                                                 de.digitalcollections.model.list.paging.PageRequest pageRequest)

      • findRelatedFileResources

        de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.resource.FileResource> findRelatedFileResources​(UUID uuid,
                                                                                                                                              de.digitalcollections.model.list.paging.PageRequest pageRequest)

      • getAll

        List<de.digitalcollections.model.semantic.Headword> getAll()
        Returns:
        list of ALL headwords. USE WITH CARE (only for internal workflow, NOT FOR USER INTERACTION!)!!!

      • getByUuid

        de.digitalcollections.model.semantic.Headword getByUuid​(UUID uuid)

      • getRandom

        List<de.digitalcollections.model.semantic.Headword> getRandom​(int count)

      • getRelatedEntities

        default List<de.digitalcollections.model.identifiable.entity.Entity> getRelatedEntities​(de.digitalcollections.model.semantic.Headword headword)

      • getRelatedEntities

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

      • getRelatedFileResources

        default List<de.digitalcollections.model.identifiable.resource.FileResource> getRelatedFileResources​(de.digitalcollections.model.semantic.Headword headword)

      • getRelatedFileResources

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

      • save

        de.digitalcollections.model.semantic.Headword save​(de.digitalcollections.model.semantic.Headword headword)
                                            throws ServiceException
        Throws:
        ServiceException

      • saveRelatedEntities

        default List<de.digitalcollections.model.identifiable.entity.Entity> saveRelatedEntities​(de.digitalcollections.model.semantic.Headword headword,
                                                                                         List<de.digitalcollections.model.identifiable.entity.Entity> entities)
        Save list of entities related to an Headword. Prerequisite: entities have been saved before (exist already)
        Parameters:
        headword - headword the entities are related to
        entities - the entities that are related to the headword
        Returns:
        the list of the related entities

      • saveRelatedFileResources

        default List<de.digitalcollections.model.identifiable.resource.FileResource> saveRelatedFileResources​(de.digitalcollections.model.semantic.Headword headword,
                                                                                                      List<de.digitalcollections.model.identifiable.resource.FileResource> fileResources)
        Save list of file resources related to an Headword. Prerequisite: file resources have been saved before (exist already)
        Parameters:
        headword - headword 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

      • setRelatedEntities

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

      • setRelatedFileResources

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

      • update

        de.digitalcollections.model.semantic.Headword update​(de.digitalcollections.model.semantic.Headword headword)
                                              throws ServiceException
        Throws:
        ServiceException