Package org.ehrbase.api.service

Interface VersionedObjectService<T extends com.nedap.archie.rm.archetyped.Locatable,U>

Type Parameters:

T - Class of target versioned object, e.g. Folder.

U - Class of return value of create and update methods. For instance, FolderDto. Will be wrapped in an Optional.

All Known Subinterfaces:

CompositionService, FolderService

public interface VersionedObjectService<T extends com.nedap.archie.rm.archetyped.Locatable,U>

Service layer interface for versioned openEHR objects.
Helps to always handle the necessary metadata and streamlines C(R)UD operations.
Retrieval is

Method Summary

Modifier and Type	Method	Description
Optional<U>	create(UUID ehrId, T objData)	Creation with default audit meta-data.
Optional<U>	create(UUID ehrId, T objData, UUID contribution)	Creation with a given contribution, and its audit meta-data.
Optional<U>	create(UUID ehrId, T objData, UUID systemId, UUID committerId, String description)	Creation with given audit meta-data.
void	delete(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId)	Deletion with default audit meta-data.
void	delete(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId, UUID contribution)	Deletion with a given contribution, and its audit meta-data.
void	delete(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId, UUID systemId, UUID committerId, String description)	Deletion with given audit meta-data.
Optional<U>	update(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId, T objData)	Update with default audit meta-data.
Optional<U>	update(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId, T objData, UUID contribution)	Update with a given contribution, and its audit meta-data.
Optional<U>	update(UUID ehrId, com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId, T objData, UUID systemId, UUID committerId, String description)	Update with given audit meta-data.

Method Detail

create

Optional<U> create(UUID ehrId,
                   T objData,
                   UUID systemId,
                   UUID committerId,
                   String description)

Creation with given audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

objData - Payload object data

systemId - Audit system ID

committerId - Audit committer ID

description - Optional audit description text

Returns:

VersionedObjectService typed response wrapped in Optional

create

Optional<U> create(UUID ehrId,
                   T objData,
                   UUID contribution)

Creation with a given contribution, and its audit meta-data.

Parameters:

ehrId - EHR ID of context

objData - Payload object data

contribution - Contribution for operation

Returns:

VersionedObjectService typed response wrapped in Optional

create

Optional<U> create(UUID ehrId,
                   T objData)

Creation with default audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

objData - Payload object data

Returns:

VersionedObjectService typed response wrapped in Optional

update

Optional<U> update(UUID ehrId,
                   com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId,
                   T objData,
                   UUID systemId,
                   UUID committerId,
                   String description)

Update with given audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object

objData - Payload object data

systemId - Audit system ID

committerId - Audit committer ID

description - Optional audit description text

Returns:

VersionedObjectService typed response wrapped in Optional

update

Optional<U> update(UUID ehrId,
                   com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId,
                   T objData,
                   UUID contribution)

Update with a given contribution, and its audit meta-data.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object

objData - Payload object data

contribution - Contribution for operation

Returns:

VersionedObjectService typed response wrapped in Optional

update

Optional<U> update(UUID ehrId,
                   com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId,
                   T objData)

Update with default audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object

objData - Payload object data

Returns:

VersionedObjectService typed response wrapped in Optional

delete

void delete(UUID ehrId,
            com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId,
            UUID systemId,
            UUID committerId,
            String description)

Deletion with given audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object

systemId - Audit system ID

committerId - Audit committer ID

description - Optional audit description text

delete

void delete(UUID ehrId,
            com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId,
            UUID contribution)

Deletion with a given contribution, and its audit meta-data.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object

contribution - Contribution for operation

delete

void delete(UUID ehrId,
            com.nedap.archie.rm.support.identification.ObjectVersionId targetObjId)

Deletion with default audit meta-data. Will create a new ad-hoc contribution.

Parameters:

ehrId - EHR ID of context

targetObjId - ID of target object