Package org.ehrbase.dao.access.interfaces

Interface I_StatusAccess

All Superinterfaces:

I_SimpleCRUD

All Known Implementing Classes:

StatusAccess

public interface I_StatusAccess
extends I_SimpleCRUD

Status access layer interface
the status entry holds data pertaining to an Ehr owner, generally a patient Created by Christian Chevalley on 4/21/2015.

Method Summary

Modifier and Type	Method	Description
UUID	commit(Timestamp transactionTime, UUID ehrId, com.nedap.archie.rm.datastructures.ItemStructure otherDetails)	Commit this status instance.
UUID	commitWithCustomContribution(Timestamp transactionTime, UUID ehrId, com.nedap.archie.rm.datastructures.ItemStructure otherDetails)	commit this instance, which has contribution already set with setContributionId(...) beforehand
I_AuditDetailsAccess	getAuditDetailsAccess()
UUID	getAuditDetailsId()
UUID	getContributionId()
UUID	getId()
StatusRecord	getStatusRecord()
static I_StatusAccess	retrieveInstance(I_DomainAccess domainAccess, UUID statusId)	retrieve a status by given status ID
static I_StatusAccess	retrieveInstanceByEhrId(I_DomainAccess domainAccess, UUID ehrId)	retrieve a status by given EHR ID
static I_StatusAccess	retrieveInstanceByNamedSubject(I_DomainAccess domainAccess, String partyName)	retrieve a status for a named subject (patient) NB.
static I_StatusAccess	retrieveInstanceByParty(I_DomainAccess domainAccess, UUID partyIdentified)	retrieve a status by an identified party id
void	setAuditAndContributionAuditValues(UUID systemId, UUID committerId, String description)	Helper that sets values in Status' direct audit and Status' implicit contribution audit
void	setAuditDetailsAccess(I_AuditDetailsAccess auditDetailsAccess)
void	setContributionAccess(I_ContributionAccess contributionAccess)
void	setContributionId(UUID contribution)
void	setStatusRecord(StatusRecord record)
Boolean	update(com.nedap.archie.rm.datastructures.ItemStructure otherDetails, Timestamp transactionTime, boolean force)	Update this status instance.

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

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

Method Detail

retrieveInstance

static I_StatusAccess retrieveInstance(I_DomainAccess domainAccess,
                                       UUID statusId)

retrieve a status by given status ID

Parameters:

domainAccess - SQL access

statusId - Id of an status to retrieve

Returns:

UUID or null

retrieveInstanceByParty

static I_StatusAccess retrieveInstanceByParty(I_DomainAccess domainAccess,
                                              UUID partyIdentified)

retrieve a status by an identified party id

Parameters:

domainAccess - SQL access

partyIdentified - Id of an identified party

Returns:

UUID or null

retrieveInstanceByEhrId

static I_StatusAccess retrieveInstanceByEhrId(I_DomainAccess domainAccess,
                                              UUID ehrId)

retrieve a status by given EHR ID

Parameters:

domainAccess - SQL access

ehrId - Id of associated EHR

Returns:

UUID or null

retrieveInstanceByNamedSubject

static I_StatusAccess retrieveInstanceByNamedSubject(I_DomainAccess domainAccess,
                                                     String partyName)

retrieve a status for a named subject (patient)
NB. for security reason, most deployment will not provide an explicit subject name, this method is provided for small deployment or test purpose.

Parameters:

domainAccess - SQL access

partyName - a subject name

Returns:

UUID or null

commit

UUID commit(Timestamp transactionTime,
            UUID ehrId,
            com.nedap.archie.rm.datastructures.ItemStructure otherDetails)

Commit this status instance.

Parameters:

transactionTime - Time of transaction

ehrId - Associated EHR

otherDetails - Object representation of otherDetails

Returns:

ID of DB entry if successful

commitWithCustomContribution

UUID commitWithCustomContribution(Timestamp transactionTime,
                                  UUID ehrId,
                                  com.nedap.archie.rm.datastructures.ItemStructure otherDetails)

commit this instance, which has contribution already set with setContributionId(...) beforehand

Parameters:

transactionTime - Time of transaction

ehrId - Associated EHR

otherDetails - Object representation of otherDetails

Returns:

ID of DB entry if successful

update

Boolean update(com.nedap.archie.rm.datastructures.ItemStructure otherDetails,
               Timestamp transactionTime,
               boolean force)

Update this status instance.

Parameters:

otherDetails - Object representation of otherDetails

transactionTime - Time of transaction

force - Option to force

Returns:

True if successful

getId

UUID getId()

setStatusRecord

void setStatusRecord(StatusRecord record)

getStatusRecord

StatusRecord getStatusRecord()

setAuditDetailsAccess

void setAuditDetailsAccess(I_AuditDetailsAccess auditDetailsAccess)

setContributionAccess

void setContributionAccess(I_ContributionAccess contributionAccess)

getAuditDetailsAccess

I_AuditDetailsAccess getAuditDetailsAccess()

getAuditDetailsId

UUID getAuditDetailsId()

setContributionId

void setContributionId(UUID contribution)

getContributionId

UUID getContributionId()

setAuditAndContributionAuditValues

void setAuditAndContributionAuditValues(UUID systemId,
                                        UUID committerId,
                                        String description)

Helper that sets values in Status' direct audit and Status' implicit contribution audit

Parameters:

systemId - ID of committing system

committerId - ID of committer

description - Optional description