Package org.ehrbase.dao.access.interfaces

Interface I_FolderAccess

All Superinterfaces:

I_SimpleCRUD

All Known Implementing Classes:

FolderAccess, FolderHistoryAccess

public interface I_FolderAccess
extends I_SimpleCRUD

Data Access Object for CRUD operations on instances of Folder.

Method Summary

Modifier and Type	Method	Description
UUID	commit(Timestamp transactionTime, UUID contributionId)	Additional commit method to store a new entry of folder to the database and get all of inserted sub folders connected by one contribution which has been created before.
com.nedap.archie.rm.datastructures.ItemStructure	getDetails()	Get the details stored as a part of the given Folder
String	getFolderArchetypeNodeId()
com.nedap.archie.rm.datastructures.ItemStructure	getFolderDetails()
UUID	getFolderId()
String	getFolderName()
AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime>	getFolderSysPeriod()
Timestamp	getFolderSysTransaction()
UUID	getInContribution()
List<com.nedap.archie.rm.support.identification.ObjectRef>	getItems()	Get the items references stored as a part of the given Folder
static I_FolderAccess	getNewFolderAccessInstance(I_DomainAccess domainAccess, com.nedap.archie.rm.directory.Folder folder, org.joda.time.DateTime dateTime, UUID ehrId)	Builds the I_FolderAccess for persisting the Folder provided as param.
Map<UUID,I_FolderAccess>	getSubfoldersList()	Get the list of subfolders for the Folder that corresponds to this I_FolderAccess
boolean	isFolderActive()
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.
static I_FolderAccess	retrieveInstanceForExistingFolder(I_DomainAccess domainAccess, UUID folderId, Timestamp timestamp)
void	setDetails(com.nedap.archie.rm.datastructures.ItemStructure details)	Set the details stored as a part of the given Folder
void	setFolderDetails(com.nedap.archie.rm.datastructures.ItemStructure folderDetails)
void	setFolderId(UUID folderId)
void	setFolderName(String folderName)
void	setFolderNArchetypeNodeId(String folderArchetypeNodeId)
void	setFolderSysPeriod(AbstractMap.SimpleEntry<OffsetDateTime,OffsetDateTime> folderSysPeriod)
void	setFolderSysTransaction(Timestamp folderSysTransaction)
void	setInContribution(UUID inContribution)
void	setIsFolderActive(boolean folderActive)

Methods inherited from interface org.ehrbase.dao.access.interfaces.I_SimpleCRUD

commit, commit, delete, update, update, update, update

Method Detail

getSubfoldersList

Map<UUID,I_FolderAccess> getSubfoldersList()

Get the list of subfolders for the Folder that corresponds to this I_FolderAccess

Returns:

Map whose key is the UUID of the child Folder, and whose value is the I_FolderAccess for the child Folder.

Throws:

Exception

setDetails

void setDetails(com.nedap.archie.rm.datastructures.ItemStructure details)

Set the details stored as a part of the given Folder

Parameters:

details -

getDetails

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

Get the details stored as a part of the given Folder

Returns:

details of the Folder that corresponds to this I_FolderAccess

getItems

List<com.nedap.archie.rm.support.identification.ObjectRef> 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)

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)

commit

UUID commit(Timestamp transactionTime,
            UUID contributionId)

Additional commit method to store a new entry of folder to the database and get all of inserted sub folders connected by one contribution which has been created before.

Parameters:

transactionTime - - Timestamp which will be applied to all folder sys_transaction values

contributionId - - ID of contribution for CREATE applied to all folders that will be created

Returns:

UUID of the new created root folder

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)