Package org.ehrbase.dao.access.interfaces

Interface I_AuditDetailsAccess

All Superinterfaces:

I_SimpleCRUD

All Known Implementing Classes:

AuditDetailsAccess

public interface I_AuditDetailsAccess
extends I_SimpleCRUD

Method Summary

Modifier and Type	Method	Description
UUID	commit(UUID systemId, UUID committerId, String description)	Convenience commit, that sets values on an empty/minimal AuditDetailsAccess before committing.
com.nedap.archie.rm.generic.AuditDetails	getAsAuditDetails()
ContributionChangeType	getChangeType()
UUID	getCommitter()
String	getDescription()
UUID	getId()
static I_AuditDetailsAccess	getInstance(I_DomainAccess dataAccess)	get a new minimal AuditDetails access layer instance
static I_AuditDetailsAccess	getInstance(I_DomainAccess dataAccess, UUID systemId, UUID committer, I_ConceptAccess.ContributionChangeType changeType, String description)	get a new AuditDetails access layer instance
UUID	getSystemId()
Timestamp	getTimeCommitted()
String	getTimeCommittedTzId()
I_AuditDetailsAccess	retrieveInstance(I_DomainAccess dataAccess, UUID auditId)	Retrieve a specific audit instance via UUID
void	setChangeType(UUID changeType)
void	setChangeType(I_ConceptAccess.ContributionChangeType changeType)
void	setCommitter(UUID committer)
void	setDescription(String description)
void	setRecord(AuditDetailsRecord record)
void	setSystemId(UUID systemId)
Boolean	update(UUID systemId, UUID committer, I_ConceptAccess.ContributionChangeType changeType, String description)	Update method with all optional parameters to only set and invoke update with given parameters.

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

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

Method Detail

getInstance

static I_AuditDetailsAccess getInstance(I_DomainAccess dataAccess)

get a new minimal AuditDetails access layer instance

Parameters:

dataAccess - general data access

Returns:

new access instance

getInstance

static I_AuditDetailsAccess getInstance(I_DomainAccess dataAccess,
                                        UUID systemId,
                                        UUID committer,
                                        I_ConceptAccess.ContributionChangeType changeType,
                                        String description)

get a new AuditDetails access layer instance

Parameters:

dataAccess - general data access

systemId - system on which this is initiated

committer - committer ID (Party Identified)

changeType - audit change type, indicating creation, modification and so on

description -

Returns:

new access instance

Throws:

InternalServerException - if creating or retrieving system failed

retrieveInstance

I_AuditDetailsAccess retrieveInstance(I_DomainAccess dataAccess,
                                      UUID auditId)

Retrieve a specific audit instance via UUID

Parameters:

dataAccess - general data access

auditId - ID of audit to retrieve

Returns:

access to instance

Throws:

InternalServerException - when retrieval failed

commit

UUID commit(UUID systemId,
            UUID committerId,
            String description)

Convenience commit, that sets values on an empty/minimal AuditDetailsAccess before committing. Assumes creation as change type.

Parameters:

systemId - system on which this is initiated

committerId - committer ID (Party Identified)

description - optional description

Returns:

ID of created audit DB entry

Throws:

IllegalArgumentException - when systemId or committerId aren't set

update

Boolean update(UUID systemId,
               UUID committer,
               I_ConceptAccess.ContributionChangeType changeType,
               String description)

Update method with all optional parameters to only set and invoke update with given parameters.

Parameters:

systemId - Optional

committer - Optional committer ID (Party Identified)

changeType - Optional audit change type, indicating creation, modification and so on

description - Optional

Returns:

Indicating success of operation

getId

UUID getId()

setSystemId

void setSystemId(UUID systemId)

getSystemId

UUID getSystemId()

setCommitter

void setCommitter(UUID committer)

Parameters:

committer - a Party Identified

getCommitter

UUID getCommitter()

setChangeType

void setChangeType(UUID changeType)

setChangeType

void setChangeType(I_ConceptAccess.ContributionChangeType changeType)

getChangeType

ContributionChangeType getChangeType()

setDescription

void setDescription(String description)

getDescription

String getDescription()

getTimeCommitted

Timestamp getTimeCommitted()

getTimeCommittedTzId

String getTimeCommittedTzId()

setRecord

void setRecord(AuditDetailsRecord record)

getAsAuditDetails

com.nedap.archie.rm.generic.AuditDetails getAsAuditDetails()