Package org.ehrbase.dao.access.interfaces

Interface I_FolderAccess

All Superinterfaces:
I_Compensatable, I_VersionedCRUD
All Known Implementing Classes:
FolderAccess, FolderHistoryAccess
public interface I_FolderAccess extends I_VersionedCRUD, I_Compensatable
Data Access Object for CRUD operations on instances of Folder.

  • Method Details

    • retrieveByVersion

      static I_FolderAccess retrieveByVersion(I_DomainAccess domainAccess, UUID folderId, int version)

    • isDeleted

      static boolean isDeleted(I_DomainAccess domainAccess, UUID versionedObjectId)

    • getEhrId

      UUID getEhrId()

    • getSubfoldersList

      Map<UUID,I_FolderAccess> getSubfoldersList()
      Get the list of subfolders for the Folder that corresponds to this I_FolderAccess
      Returns:
      Map<UUID, I_FolderAccess> whose key is the UUID of the child Folder, and whose value is the I_FolderAccess for the child Folder.
      Throws:
      Exception

    • getItems

      List<com.nedap.archie.rm.support.identification.ObjectRef<? extends com.nedap.archie.rm.support.identification.ObjectId>> getItems()
      Get the items references stored as a part of the given Folder
      Returns:
      items of the Folder that corresponds to this I_FolderAccess

    • getNewFolderAccessInstance

      static I_FolderAccess getNewFolderAccessInstance(I_DomainAccess domainAccess, com.nedap.archie.rm.directory.Folder folder, org.joda.time.DateTime dateTime, UUID ehrId, String tenantIdentifier)
      Builds the I_FolderAccess for persisting the Folder provided as param.
      Parameters:
      domainAccess - providing the information about the DB connection.
      folder - to define the I_FolderAccess that allows its DB access.
      dateTime - that will be set as transaction date when the Folder is persisted
      ehrId - of the Ehr that references the Folder provided as param.
      Returns:
      I_FolderAccess with the information to persist the provided Folder

    • retrieveInstanceForExistingFolder

      static I_FolderAccess retrieveInstanceForExistingFolder(I_DomainAccess domainAccess, UUID folderId)
      Retrieve instance of I_FolderAccess with the information needed retrieve the folder and its sub-folders.
      Parameters:
      domainAccess - providing the information about the DB connection.
      folderId - UUID of the Folder to be fetched from the DB.
      Returns:
      the I_FolderAccess that provides DB access to the Folder that corresponds to the provided folderId param.
      Throws:
      Exception

    • retrieveInstanceForExistingFolder

      static I_FolderAccess retrieveInstanceForExistingFolder(I_DomainAccess domainAccess, UUID folderId, Timestamp timestamp)

    • getInstanceForExistingFolder

      static I_FolderAccess getInstanceForExistingFolder(I_DomainAccess domainAccess, com.nedap.archie.rm.support.identification.ObjectVersionId folderId)

    • getInstanceForExistingFolder

      static I_FolderAccess getInstanceForExistingFolder(I_DomainAccess domainAccess, com.nedap.archie.rm.support.identification.ObjectVersionId folderId, Timestamp timestamp)

    • retrieveFolderVersionIdsInContribution

      static Set<com.nedap.archie.rm.support.identification.ObjectVersionId> retrieveFolderVersionIdsInContribution(I_DomainAccess domainAccess, UUID contribution, String nodeName)
      Retrieves the version IDs of all folders, which are linked to the given contribution.
      Parameters:
      domainAccess - DB access
      contribution - Given contribution to query for
      nodeName - Node name to build version ID with (access layer doesn't have access to this info)
      Returns:
      Set of ObjectVersionId for linked folders

    • getFolderId

      UUID getFolderId()

    • setFolderId

      void setFolderId(UUID folderId)

    • getInContribution

      UUID getInContribution()

    • setInContribution

      void setInContribution(UUID inContribution)

    • getFolderName

      String getFolderName()

    • setFolderName

      void setFolderName(String folderName)

    • getFolderArchetypeNodeId

      String getFolderArchetypeNodeId()

    • setFolderNArchetypeNodeId

      void setFolderNArchetypeNodeId(String folderArchetypeNodeId)

    • isFolderActive

      boolean isFolderActive()

    • setIsFolderActive

      void setIsFolderActive(boolean folderActive)

    • getFolderDetails

      com.nedap.archie.rm.datastructures.ItemStructure getFolderDetails()

    • setFolderDetails

      void setFolderDetails(com.nedap.archie.rm.datastructures.ItemStructure folderDetails)

    • setFolderSysTransaction

      void setFolderSysTransaction(Timestamp folderSysTransaction)

    • getFolderSysTransaction

      Timestamp getFolderSysTransaction()

    • getFolderSysPeriod

      AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> getFolderSysPeriod()

    • setFolderSysPeriod

      void setFolderSysPeriod(AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> folderSysPeriod)

    • getAudit

      UUID getAudit()

    • setAudit

      void setAudit(UUID auditId)

    • adminDeleteFolder

      void adminDeleteFolder()
      Invoke physical deletion.