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

Class DataImportBuilder

java.lang.Object

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

org.openehealth.ipf.commons.audit.event.DataImportBuilder

All Implemented Interfaces:

AuditMessageBuilder<DataImportBuilder>, Validateable

public class DataImportBuilder
extends BaseAuditMessageBuilder<DataImportBuilder>

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
DataImportBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventActionCode eventActionCode, EventType eventType, PurposeOfUse... purposesOfUse)
DataImportBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventType eventType, PurposeOfUse... purposesOfUse)
DataImportBuilder(EventOutcomeIndicator outcome, EventType eventType, PurposeOfUse... purposesOfUse)

Method Summary

Modifier and Type	Method	Description
DataImportBuilder	addImportingParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)
DataImportBuilder	addSourceParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)
DataImportBuilder	setSourceMediaParticipant(String userId, String altUserId, String userName, NetworkAccessPointTypeCode networkAccessPointType, String networkAccessPointId, 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

DataImportBuilder

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

DataImportBuilder

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

DataImportBuilder

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

Method Detail

addImportingParticipant

public DataImportBuilder addImportingParticipant(String userId,
                                                 String altUserId,
                                                 String userName,
                                                 String networkAccessPointId,
                                                 boolean userIsRequestor)

Parameters:

userId - The identity of the local user or process importing 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

addSourceParticipant

public DataImportBuilder addSourceParticipant(String userId,
                                              String altUserId,
                                              String userName,
                                              String networkAccessPointId,
                                              boolean userIsRequestor)

Parameters:

userId - UserID

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

setSourceMediaParticipant

public DataImportBuilder setSourceMediaParticipant(String userId,
                                                   String altUserId,
                                                   String userName,
                                                   NetworkAccessPointTypeCode networkAccessPointType,
                                                   String networkAccessPointId,
                                                   String mediaIdentifier,
                                                   MediaType mediaType)

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<DataImportBuilder>