Package org.openehealth.ipf.commons.audit.event

Class DataExportBuilder

java.lang.Object

org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder<DataExportBuilder>

org.openehealth.ipf.commons.audit.event.DataExportBuilder

All Implemented Interfaces:

AuditMessageBuilder<DataExportBuilder>, Validateable

public class DataExportBuilder
extends BaseAuditMessageBuilder<DataExportBuilder>

Builds an Audit Event representing a Data Export event as specified in http://dicom.nema.org/medical/dicom/current/output/html/part15.html#sect_A.5.3.4

This message describes the event of exporting data from a system, meaning that the data is leaving control of the system's security domain. Examples of exporting include printing to paper, recording on film, conversion to another format for storage in an EHR, writing to removable media, or sending via e-mail. Multiple patients may be described in one event message.

Since:

3.5

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
DataExportBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventActionCode eventActionCode, EventType eventType, PurposeOfUse... purposesOfUse)
DataExportBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventType eventType, PurposeOfUse... purposesOfUse)
DataExportBuilder(EventOutcomeIndicator outcome, EventType eventType, PurposeOfUse... purposesOfUse)

Method Summary

Modifier and Type	Method	Description
DataExportBuilder	addExportingParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)
DataExportBuilder	addReceivingParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)
DataExportBuilder	setDestinationMediaParticipant(String userId, String altUserId, String userName, String networkAccessPointId, NetworkAccessPointTypeCode networkAccessPointTypeCode, String mediaIdentifier, MediaType mediaType)
void	validate()	Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Methods inherited from class org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder

addActiveParticipant, addActiveParticipant, addActiveParticipant, addDestinationActiveParticipant, addParticipantObjectIdentification, addParticipantObjectIdentification, addParticipantObjectIdentification, addPatientParticipantObject, addSourceActiveParticipant, addStudyParticipantObject, getMessage, getNetworkAccessPointCodeFromAddress, setAuditSource, setAuditSource, setAuditSource, setAuditSource, setAuditSourceIdentification, setAuditSourceIdentification, setAuditSourceIdentification, setEventIdentification, setEventIdentification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openehealth.ipf.commons.audit.event.AuditMessageBuilder

getMessages, getTypeValuePair, getTypeValuePair, getTypeValuePair, getTypeValuePair, self

Constructor Detail

DataExportBuilder

public DataExportBuilder(EventOutcomeIndicator outcome,
                         EventType eventType,
                         PurposeOfUse... purposesOfUse)

DataExportBuilder

public DataExportBuilder(EventOutcomeIndicator outcome,
                         String eventOutcomeDescription,
                         EventType eventType,
                         PurposeOfUse... purposesOfUse)

DataExportBuilder

public DataExportBuilder(EventOutcomeIndicator outcome,
                         String eventOutcomeDescription,
                         EventActionCode eventActionCode,
                         EventType eventType,
                         PurposeOfUse... purposesOfUse)

Method Detail

addReceivingParticipant

public DataExportBuilder addReceivingParticipant(String userId,
                                                 String altUserId,
                                                 String userName,
                                                 String networkAccessPointId,
                                                 boolean userIsRequestor)

Parameters:

userId - The identity of the remote user or process receiving the data

altUserId - Alternate UserID

userName - UserName

networkAccessPointId - Network Access Point ID

userIsRequestor - A single user (either local or remote) shall be identified as the requestor, i.e., UserIsRequestor with a value of TRUE. This accommodates both push and pull transfer models for media

Returns:

this

addExportingParticipant

public DataExportBuilder addExportingParticipant(String userId,
                                                 String altUserId,
                                                 String userName,
                                                 String networkAccessPointId,
                                                 boolean userIsRequestor)

Parameters:

userId - The identity of the local user or process exporting the data. If both are known, then two active participants shall be included (both the person and the process).

altUserId - Alternate UserID

userName - UserName

networkAccessPointId - Network Access Point ID

userIsRequestor - A single user (either local or remote) shall be identified as the requestor, i.e., UserIsRequestor with a value of TRUE. This accommodates both push and pull transfer models for media

Returns:

this

setDestinationMediaParticipant

public DataExportBuilder setDestinationMediaParticipant(String userId,
                                                        String altUserId,
                                                        String userName,
                                                        String networkAccessPointId,
                                                        NetworkAccessPointTypeCode networkAccessPointTypeCode,
                                                        String mediaIdentifier,
                                                        MediaType mediaType)

Parameters:

userId - UserID

altUserId - Alternate UserID

userName - UserName

networkAccessPointId - Network Access Point ID

mediaIdentifier - Media Identifier

mediaType - Media Type

Returns:

this

validate

public void validate()

Description copied from interface: Validateable

Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Specified by:

validate in interface Validateable

Overrides:

validate in class BaseAuditMessageBuilder<DataExportBuilder>