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

Class QueryBuilder

java.lang.Object

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

org.openehealth.ipf.commons.audit.event.QueryBuilder

All Implemented Interfaces:

AuditMessageBuilder<QueryBuilder>, Validateable

public class QueryBuilder
extends BaseAuditMessageBuilder<QueryBuilder>

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

This message describes the event of a Query being issued or received. The message does NOT record the response to the query, but merely records the fact that a query was issued.

Since:

3.5

Author:

Christian Ohr

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
QueryBuilder	addOtherActiveParticipant(String userId, String altUserId, String userName, ActiveParticipantRoleId roleId, String networkId, boolean userIsRequestor)
QueryBuilder	setQueryingParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)	Process Issuing the Query
QueryBuilder	setRespondingParticipant(String userId, String altUserId, String userName, String networkAccessPointId, boolean userIsRequestor)	The process that will respond to the query
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

QueryBuilder

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

QueryBuilder

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

Method Detail

setQueryingParticipant

public QueryBuilder setQueryingParticipant(String userId,
                                           String altUserId,
                                           String userName,
                                           String networkAccessPointId,
                                           boolean userIsRequestor)

Process Issuing the Query

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

setRespondingParticipant

public QueryBuilder setRespondingParticipant(String userId,
                                             String altUserId,
                                             String userName,
                                             String networkAccessPointId,
                                             boolean userIsRequestor)

The process that will respond to the query

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

addOtherActiveParticipant

public QueryBuilder addOtherActiveParticipant(String userId,
                                              String altUserId,
                                              String userName,
                                              ActiveParticipantRoleId roleId,
                                              String networkId,
                                              boolean userIsRequestor)

Parameters:

userId - UserID

altUserId - Alternate UserID

userName - UserName

networkId - Network Access Point ID

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

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