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

Class BeginTransferringDicomInstancesBuilder

java.lang.Object

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

org.openehealth.ipf.commons.audit.event.BeginTransferringDicomInstancesBuilder

All Implemented Interfaces:

AuditMessageBuilder<BeginTransferringDicomInstancesBuilder>, Validateable

public class BeginTransferringDicomInstancesBuilder
extends BaseAuditMessageBuilder<BeginTransferringDicomInstancesBuilder>

Builds an Audit Event representing a Begin Transferring DICOM Instances event as specified in http://dicom.nema.org/medical/dicom/current/output/html/part15.html#sect_A.5.3.3

This message describes the event of a system beginning to transfer a set of DICOM instances from one node to another node within control of the system's security domain. This message may only include information about a single patient.

Since:

3.5

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
BeginTransferringDicomInstancesBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventType eventType, PurposeOfUse... purposesOfUse)

Method Summary

Modifier and Type	Method	Description
BeginTransferringDicomInstancesBuilder	addTransferredStudyParticipantObject(String studyId, String uids)
BeginTransferringDicomInstancesBuilder	setPatientParticipantObject(String patientId, String patientName)
BeginTransferringDicomInstancesBuilder	setReceivingProcessParticipant(String userId, String altUserId, String userName, String networkId, boolean userIsRequestor)
BeginTransferringDicomInstancesBuilder	setSendingProcessParticipant(String userId, String altUserId, String userName, String networkId, boolean userIsRequestor)
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

BeginTransferringDicomInstancesBuilder

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

Method Detail

setSendingProcessParticipant

public BeginTransferringDicomInstancesBuilder setSendingProcessParticipant(String userId,
                                                                           String altUserId,
                                                                           String userName,
                                                                           String networkId,
                                                                           boolean userIsRequestor)

Parameters:

userId - The identity of the process sending the data

altUserId - Alternate UserID

userName - UserName

networkId - Network Access Point ID

userIsRequestor - Whether the destination participant represents the requestor (i.e. pull request)

Returns:

this

setReceivingProcessParticipant

public BeginTransferringDicomInstancesBuilder setReceivingProcessParticipant(String userId,
                                                                             String altUserId,
                                                                             String userName,
                                                                             String networkId,
                                                                             boolean userIsRequestor)

Parameters:

userId - The identity of the process receiving the data

altUserId - Alternate UserID

userName - UserName

networkId - Network Access Point ID

userIsRequestor - Whether the destination participant represents the requestor (i.e. pull request)

Returns:

this

setPatientParticipantObject

public BeginTransferringDicomInstancesBuilder setPatientParticipantObject(String patientId,
                                                                          String patientName)

Parameters:

patientId - patient ID

patientName - patient name

Returns:

this

addTransferredStudyParticipantObject

public BeginTransferringDicomInstancesBuilder addTransferredStudyParticipantObject(String studyId,
                                                                                   String uids)

Parameters:

studyId - study ID

uids - one or more SOP Class UID values

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