Package org.ehrbase.api.service

Interface DirectoryService

All Superinterfaces:
BaseService
public interface DirectoryService extends BaseService

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    adminDeleteFolder(UUID ehrId, UUID folderId)
    Physical delete a folder with all History
    com.nedap.archie.rm.directory.Folder
    create(UUID ehrId, com.nedap.archie.rm.directory.Folder folder)
    Create a new folder for Ehr with id equal ehrId
    void
    delete(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId ifMatches)
    delete the folder for Ehr with id equal ehrId
    Optional<com.nedap.archie.rm.directory.Folder>
    get(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId folderId, String path)
    Get the Folder for Ehr with id equal ehrId
    Optional<com.nedap.archie.rm.directory.Folder>
    getByTime(UUID ehrId, OffsetDateTime time, String path)
    Get the Folder for Ehr with id equal ehrId for a specific point in time;
    com.nedap.archie.rm.directory.Folder
    update(UUID ehrId, com.nedap.archie.rm.directory.Folder folder, com.nedap.archie.rm.support.identification.ObjectVersionId ifMatches)
    Update the folder for Ehr with id equal ehrId

    Methods inherited from interface org.ehrbase.api.service.BaseService

    getServerConfig, getSystemUuid

  • Method Details

    • get

      Optional<com.nedap.archie.rm.directory.Folder> get(UUID ehrId, @Nullable com.nedap.archie.rm.support.identification.ObjectVersionId folderId, @Nullable String path)
      Get the Folder for Ehr with id equal ehrId
      Parameters:
      ehrId -
      folderId - if null latest version will be returned
      path - optional return folder at path
      Returns:

    • getByTime

      Optional<com.nedap.archie.rm.directory.Folder> getByTime(UUID ehrId, OffsetDateTime time, @Nullable String path)
      Get the Folder for Ehr with id equal ehrId for a specific point in time;
      Parameters:
      ehrId -
      time -
      path - optional return folder at path
      Returns:

    • create

      com.nedap.archie.rm.directory.Folder create(UUID ehrId, com.nedap.archie.rm.directory.Folder folder)
      Create a new folder for Ehr with id equal ehrId
      Parameters:
      ehrId -
      folder -
      Returns:

    • update

      com.nedap.archie.rm.directory.Folder update(UUID ehrId, com.nedap.archie.rm.directory.Folder folder, com.nedap.archie.rm.support.identification.ObjectVersionId ifMatches)
      Update the folder for Ehr with id equal ehrId
      Parameters:
      ehrId -
      folder -
      ifMatches - expected version before update for optimistic looking
      Returns:

    • delete

      void delete(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId ifMatches)
      delete the folder for Ehr with id equal ehrId
      Parameters:
      ehrId -
      ifMatches - expected version before delete for optimistic looking

    • adminDeleteFolder

      void adminDeleteFolder(UUID ehrId, UUID folderId)
      Physical delete a folder with all History
      Parameters:
      ehrId -
      folderId -