Record Class ComplianceReport

java.lang.Object

java.lang.Record

org.j7m.middleware.compliance.api.ComplianceReport

Record Components:

generatedAt - report timestamp

profile - profile used for mapping

scope - assessed scope

assessments - control assessments

evidence - raw evidence records

summary - summary counters

limitations - known limitations

public record ComplianceReport(Instant generatedAt, ComplianceProfile profile, ComplianceScope scope, List<ControlAssessment> assessments, List<ControlEvidence> evidence, Map<ControlStatus, Long> summary, List<String> limitations)
extends Record

Immutable compliance evidence report.

Constructor Summary

Constructors

Constructor	Description
ComplianceReport(Instant generatedAt, ComplianceProfile profile, ComplianceScope scope, List<ControlAssessment> assessments, List<ControlEvidence> evidence, Map<ControlStatus, Long> summary, List<String> limitations)	Creates immutable report values.

Method Summary

Modifier and Type	Method	Description
List<ControlAssessment>	assessments()	Returns the value of the assessments record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<ControlEvidence>	evidence()	Returns the value of the evidence record component.
Instant	generatedAt()	Returns the value of the generatedAt record component.
final int	hashCode()	Returns a hash code value for this object.
List<String>	limitations()	Returns the value of the limitations record component.
ComplianceProfile	profile()	Returns the value of the profile record component.
ComplianceScope	scope()	Returns the value of the scope record component.
Map<ControlStatus, Long>	summary()	Returns the value of the summary record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ComplianceReport

public ComplianceReport(Instant generatedAt,
 ComplianceProfile profile,
 ComplianceScope scope,
 List<ControlAssessment> assessments,
 List<ControlEvidence> evidence,
 Map<ControlStatus, Long> summary,
 List<String> limitations)

Creates immutable report values.

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

generatedAt

public Instant generatedAt()

Returns the value of the generatedAt record component.

Returns:

the value of the generatedAt record component

profile

public ComplianceProfile profile()

Returns the value of the profile record component.

Returns:

the value of the profile record component

scope

public ComplianceScope scope()

Returns the value of the scope record component.

Returns:

the value of the scope record component

assessments

public List<ControlAssessment> assessments()

Returns the value of the assessments record component.

Returns:

the value of the assessments record component

evidence

public List<ControlEvidence> evidence()

Returns the value of the evidence record component.

Returns:

the value of the evidence record component

summary

public Map<ControlStatus, Long> summary()

Returns the value of the summary record component.

Returns:

the value of the summary record component

limitations

public List<String> limitations()

Returns the value of the limitations record component.

Returns:

the value of the limitations record component