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

Class ApplicationActivityBuilder<T extends ApplicationActivityBuilder<T>>

java.lang.Object

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

org.openehealth.ipf.commons.audit.event.ApplicationActivityBuilder<T>

All Implemented Interfaces:

AuditMessageBuilder<T>, Validateable

Direct Known Subclasses:

ApplicationActivityBuilder.ApplicationStart, ApplicationActivityBuilder.ApplicationStop

public class ApplicationActivityBuilder<T extends ApplicationActivityBuilder<T>>
extends BaseAuditMessageBuilder<T>

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

This audit message describes the event of an Application Entity starting or stopping. This is closely related to the more general case of any kind of application startup or shutdown, and may be suitable for those purposes also.

Since:

3.5

Author:

Christian Ohr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplicationActivityBuilder.ApplicationStart
static class	ApplicationActivityBuilder.ApplicationStop

Constructor Summary

Constructors

Constructor	Description
ApplicationActivityBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventType type)
ApplicationActivityBuilder(EventOutcomeIndicator outcome, EventType type)

Method Summary

Modifier and Type	Method	Description
T	addApplicationStarterParticipant(String userId)	Add an Application Starter Active Participant to this message.
T	addApplicationStarterParticipant(String userId, String altUserId, String userName, String networkId)	Add an Application Starter Active Participant to this message.
T	setApplicationParticipant(String userId, String altUserId, String userName, String networkId)	Add an Application Participant to this message.
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

ApplicationActivityBuilder

public ApplicationActivityBuilder(EventOutcomeIndicator outcome,
                                  EventType type)

ApplicationActivityBuilder

public ApplicationActivityBuilder(EventOutcomeIndicator outcome,
                                  String eventOutcomeDescription,
                                  EventType type)

Method Detail

addApplicationStarterParticipant

public T addApplicationStarterParticipant(String userId)

Add an Application Starter Active Participant to this message. This participant describes persons or processes that started or stopped the application.

Parameters:

userId - The person or process starting or stopping the Application

Returns:

this

addApplicationStarterParticipant

public T addApplicationStarterParticipant(String userId,
                                          String altUserId,
                                          String userName,
                                          String networkId)

Add an Application Starter Active Participant to this message. This participant describes persons or processes that started or stopped the application.

Parameters:

userId - The person or process starting or stopping the Application

altUserId - The Active Participant's Alternate UserID

userName - The Active Participant's UserName

networkId - The Active Participant's Network Access Point ID

Returns:

this

setApplicationParticipant

public T setApplicationParticipant(String userId,
                                   String altUserId,
                                   String userName,
                                   String networkId)

Add an Application Participant to this message. This participant describes the application that is started or stopped and must be added only once.

Parameters:

userId - The identity of the process started or stopped formatted as specified in A.5.2.1.

altUserId - If the process supports DICOM, then the AE Titles as specified in A.5.2.2.

userName - The Active Participant's UserName

networkId - The Active Participant's Network Access Point ID

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<T extends ApplicationActivityBuilder<T>>