Package com.ibm.fhir.audit.cadf

Class CadfReporterStep.Builder

java.lang.Object

com.ibm.fhir.audit.cadf.CadfReporterStep.Builder

Enclosing class:

CadfReporterStep

public static class CadfReporterStep.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Builder(ReporterRole role, CadfResource rep, java.lang.String repId, java.time.ZonedDateTime rTime)	Construct a ReporterStep object.

Method Summary

Modifier and Type	Method	Description
CadfReporterStep.Builder	attachment(CadfAttachment attachment)	A convenience method to add one attachment at a time.
CadfReporterStep.Builder	attachments(CadfAttachment[] attachments)	An optional array of additional data containing information about the reporter or any action it performed that affected the CADF Event Record contents.
CadfReporterStep.Builder	attachments(java.util.ArrayList<CadfAttachment> attachments)	An optional array of additional data containing information about the reporter or any action it performed that affected the CADF Event Record contents.
CadfReporterStep	build()	Build an immutable ReporterStep instance.
CadfReporterStep.Builder	reporter(CadfResource reporter)
CadfReporterStep.Builder	reporterId(java.lang.String reporterId)
CadfReporterStep.Builder	reporterTime(java.time.ZonedDateTime reporterTime)
CadfReporterStep.Builder	role(ReporterRole role)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(ReporterRole role,
               CadfResource rep,
               java.lang.String repId,
               java.time.ZonedDateTime rTime)

Construct a ReporterStep object. This type represents a step in the REPORTERCHAIN that captures information about any notable REPORTER (in addition to the OBSERVER) that modified or relayed the CADF Event Record and any details regarding any modification it performed on the CADF Event Record it is contained within.

Parameters:

role - - The role the REPORTER performed on the CADF Event Record (e.g., an "observer", "modifier" or "relay" role).

rep - - This property defines the resource that acted as a REPORTER on a CADF Event Record. It is required if repId is not supplied.

repId - - This property identifies a resource that acted as a REPORTER on a CADF Event Record by reference and whose definition exists outside the event record itself (e.g., within the same CADF Log or Report). Note: This property can be used instead of the "reporter" property to reference a valid CADF Resource definition, which is already defined and can be referenced by its identifier (e.g., a CADF Resource already defined within the same CADF Event record or at the CADF Log or Report level that also contains the referencing CADF Event record).

rTime - - Optional. The time a REPORTER adds its Reporterstep entry into the REPORTERCHAIN (which follows completion of any updates to or handling of the corresponding CADF Event Record).

See Also:

CadfEvent.getReporterchain()

Method Detail

attachments

public CadfReporterStep.Builder attachments(CadfAttachment[] attachments)

An optional array of additional data containing information about the reporter or any action it performed that affected the CADF Event Record contents.

attachments

public CadfReporterStep.Builder attachments(java.util.ArrayList<CadfAttachment> attachments)

An optional array of additional data containing information about the reporter or any action it performed that affected the CADF Event Record contents.

attachment

public CadfReporterStep.Builder attachment(CadfAttachment attachment)

A convenience method to add one attachment at a time.

See Also:

attachments(CadfAttachment[])

reporter

public CadfReporterStep.Builder reporter(CadfResource reporter)

reporterId

public CadfReporterStep.Builder reporterId(java.lang.String reporterId)

reporterTime

public CadfReporterStep.Builder reporterTime(java.time.ZonedDateTime reporterTime)

role

public CadfReporterStep.Builder role(ReporterRole role)

build

public CadfReporterStep build()

Build an immutable ReporterStep instance.

Returns:

ReporterStep

Throws:

java.lang.IllegalStateException - when the properties do not meet the specification.