Package org.ehrbase.dao.access.interfaces

Interface I_ContributionAccess

All Superinterfaces:

I_SimpleCRUD

All Known Implementing Classes:

ContributionAccess

public interface I_ContributionAccess
extends I_SimpleCRUD

Access layer to Contributions Created by Christian Chevalley on 4/21/2015.

Method Summary

Modifier and Type	Method	Description
void	addComposition(I_CompositionAccess compositionAccess)	add a new composition to this contribution NB: The contribution and composition requires commit() to be saved in the DB
UUID	commit(Timestamp transactionTime, UUID committerId, UUID systemId, ContributionDataType contributionType, ContributionDef.ContributionState contributionState, I_ConceptAccess.ContributionChangeType contributionChangeType, String description)	Commits given input as contribution record.
UUID	commit(Timestamp transactionTime, ContributionDataType contributionType, ContributionDef.ContributionState state)	Commits given input as contribution record.
UUID	commitWithSignature(String signature)	commit the contribution with a certifying signature the signature is stored in the Contribution Version entry, the state of the contribution is then 'complete'
UUID	getAuditsCommitter()
String	getAuditsDescription()
UUID	getAuditsSystemId()
I_CompositionAccess	getComposition(UUID id)
Set<UUID>	getCompositionIds()
ContributionDataType	getContributionDataType()
UUID	getContributionId()	get the contribution UUID
ContributionDef.ContributionState	getContributionState()	get the contribution state
ContributionDef.ContributionType	getContributionType()	get the contribution type
String	getDataType()
UUID	getEhrId()	get the contribution Ehr Id it belongs to
UUID	getHasAuditDetails()
UUID	getId()
static I_ContributionAccess	getInstance(I_DomainAccess domain, UUID ehrId)	get a new minimal contribution access layer instance
boolean	removeComposition(I_CompositionAccess compositionAccess)	TODO: doc.
static I_ContributionAccess	retrieveInstance(I_DomainAccess domainAccess, UUID contributionId)	retrieve an instance of I_ContributionAccess layer to the DB
static I_ContributionAccess	retrieveVersionedInstance(I_DomainAccess domainAccess, UUID contributionObjId, Timestamp timestamp)	retrieve a contribution from its object ID and a timestamp FIXME: note: this only looks for instances in *_history table, see called method for details on problem - also naming suggestively wrong?
void	setAuditDetailsChangeType(UUID changeType)
void	setAuditDetailsValues(com.nedap.archie.rm.generic.AuditDetails auditObject)
void	setAuditDetailsValues(UUID committer, UUID system, String description)	Convenience setter for contribution's audit
void	setComplete()	set the contribution as complete
void	setContributionDataType(ContributionDataType contributionDataType)
void	setDataType(ContributionDataType contributionDataType)
void	setDeleted()	set the contribution as deleted
void	setEhrId(UUID ehrId)	set the contribution Ehr Id it belongs to
void	setHasAuditDetails(UUID auditId)
void	setIncomplete()	set the contribution as incomplete
void	setState(ContributionDef.ContributionState state)	set the state of contribution
Boolean	update(Timestamp transactionTime, UUID committerId, UUID systemId, String contributionType, String contributionState, String contributionChangeType, String description)	Update with embedded audit update.
Boolean	update(Timestamp transactionTime, UUID committerId, UUID systemId, ContributionDataType contributionType, ContributionDef.ContributionState contributionState, I_ConceptAccess.ContributionChangeType contributionChangeType, String description)	Update with embedded audit update.
void	updateComposition(I_CompositionAccess compositionAccess)	updateComposition an existing composition only a composition with the same id is effectively updated with this method NB: The contribution and composition requires commit() to be saved in the DB
UUID	updateWithSignature(String signature)

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

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

Method Detail

getInstance

static I_ContributionAccess getInstance(I_DomainAccess domain,
                                        UUID ehrId)

get a new minimal contribution access layer instance

Parameters:

domain - SQL context

ehrId - the EHR uuid this contribution belong to

Returns:

a new minimal I_ContributionAccess

retrieveInstance

static I_ContributionAccess retrieveInstance(I_DomainAccess domainAccess,
                                             UUID contributionId)

retrieve an instance of I_ContributionAccess layer to the DB

Parameters:

domainAccess - SQL context

contributionId - the contribution id

Returns:

an I_ContributionAccess instance or null

Throws:

InternalServerException - on failed fetching of contribution

retrieveVersionedInstance

static I_ContributionAccess retrieveVersionedInstance(I_DomainAccess domainAccess,
                                                      UUID contributionObjId,
                                                      Timestamp timestamp)

retrieve a contribution from its object ID and a timestamp FIXME: note: this only looks for instances in *_history table, see called method for details on problem - also naming suggestively wrong?

Parameters:

domainAccess - SQL context

contributionObjId - the contribution object UUID

timestamp - time in history to calculate related version

Returns:

an I_ContributionAccess instance or null

addComposition

void addComposition(I_CompositionAccess compositionAccess)

add a new composition to this contribution
NB: The contribution and composition requires commit() to be saved in the DB

Parameters:

compositionAccess - a valid I_CompositionAccess

Throws:

IllegalArgumentException - when composition is not complete, e.g. has not embedded audit

updateWithSignature

UUID updateWithSignature(String signature)

updateComposition

void updateComposition(I_CompositionAccess compositionAccess)

updateComposition an existing composition
only a composition with the same id is effectively updated with this method
NB: The contribution and composition requires commit() to be saved in the DB

Parameters:

compositionAccess - access instance

removeComposition

boolean removeComposition(I_CompositionAccess compositionAccess)

TODO: doc. what exactly happens or need to happen, i.e. also commit(..) necessary afterwards?

Parameters:

compositionAccess - access instance

Returns:

?

commit

UUID commit(Timestamp transactionTime,
            ContributionDataType contributionType,
            ContributionDef.ContributionState state)

Commits given input as contribution record. Creation of audit is required beforehand. All parameters are optional and will be provided with default values if NULL.

Parameters:

transactionTime - Timestamp of transaction time

contributionType - String representation of contribution type

state - String representation of contribution state

Returns:

commit

UUID commit(Timestamp transactionTime,
            UUID committerId,
            UUID systemId,
            ContributionDataType contributionType,
            ContributionDef.ContributionState contributionState,
            I_ConceptAccess.ContributionChangeType contributionChangeType,
            String description)

Commits given input as contribution record. Embeds creation of audit for this commit. All parameters are optional and will be provided with default values if NULL.

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer

systemId - ID of committing system

contributionType - String representation of contribution type

contributionState - String representation of contribution state

contributionChangeType - String representation of contribution change type

description - Description

Returns:

UUID of committed contribution

Throws:

InternalServerException - when contribution couldn't be created because of an internal problem

update

Boolean update(Timestamp transactionTime,
               UUID committerId,
               UUID systemId,
               String contributionType,
               String contributionState,
               String contributionChangeType,
               String description)

Update with embedded audit update.

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer (part of AuditDetails)

systemId - ID of committing system (part of AuditDetails)

contributionType - String representation of contribution type

contributionState - String representation of contribution state

contributionChangeType - String representation of contribution change type (part of AuditDetails)

description - Description (part of AuditDetails)

Returns:

True for success

update

Boolean update(Timestamp transactionTime,
               UUID committerId,
               UUID systemId,
               ContributionDataType contributionType,
               ContributionDef.ContributionState contributionState,
               I_ConceptAccess.ContributionChangeType contributionChangeType,
               String description)

Update with embedded audit update.

Parameters:

transactionTime - Timestamp of transaction time

committerId - ID of committer (part of AuditDetails)

systemId - ID of committing system (part of AuditDetails)

contributionType - ContributionDataType representation of contribution type

contributionState - ContributionState representation of contribution state

contributionChangeType - ContributionChangeType representation of contribution change type (part of AuditDetails)

description - Description (part of AuditDetails)

Returns:

True for success

commitWithSignature

UUID commitWithSignature(String signature)

commit the contribution with a certifying signature
the signature is stored in the Contribution Version entry, the state of the contribution is then 'complete'

Parameters:

signature - String representing the certification

Returns:

UUID of committed contribution

getContributionId

UUID getContributionId()

get the contribution UUID

Returns:

ID of contribution

getContributionDataType

ContributionDataType getContributionDataType()

setContributionDataType

void setContributionDataType(ContributionDataType contributionDataType)

setState

void setState(ContributionDef.ContributionState state)

set the state of contribution

Parameters:

state - ContributionDef

See Also:

ContributionDef

setComplete

void setComplete()

set the contribution as complete

setIncomplete

void setIncomplete()

set the contribution as incomplete

setDeleted

void setDeleted()

set the contribution as deleted

getContributionType

ContributionDef.ContributionType getContributionType()

get the contribution type

Returns:

type

See Also:

ContributionDef.ContributionType

getContributionState

ContributionDef.ContributionState getContributionState()

get the contribution state

Returns:

state

See Also:

ContributionDef.ContributionState

getEhrId

UUID getEhrId()

get the contribution Ehr Id it belongs to

Returns:

Ehr UUID

setEhrId

void setEhrId(UUID ehrId)

set the contribution Ehr Id it belongs to

getComposition

I_CompositionAccess getComposition(UUID id)

getCompositionIds

Set<UUID> getCompositionIds()

getDataType

String getDataType()

setDataType

void setDataType(ContributionDataType contributionDataType)

getId

UUID getId()

setAuditDetailsValues

void setAuditDetailsValues(UUID committer,
                           UUID system,
                           String description)

Convenience setter for contribution's audit

Parameters:

committer - committer ID (Party Identified)

system - system on which this is initiated

description - description

setAuditDetailsValues

void setAuditDetailsValues(com.nedap.archie.rm.generic.AuditDetails auditObject)

setAuditDetailsChangeType

void setAuditDetailsChangeType(UUID changeType)

getAuditsCommitter

UUID getAuditsCommitter()

getAuditsSystemId

UUID getAuditsSystemId()

getAuditsDescription

String getAuditsDescription()

setHasAuditDetails

void setHasAuditDetails(UUID auditId)

getHasAuditDetails

UUID getHasAuditDetails()