Package dev.metaschema.oscal.lib.model

Class Result

java.lang.Object
dev.metaschema.oscal.lib.model.Result
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Assessment Result", description="Used by the assessment results and POA\\&M. In the assessment results, this identifies all of the assessment observations and findings, initial and residual risks, deviations, and disposition. In the POA\\&M, this identifies initial and residual risks, deviations, and disposition.", name="result", moduleClass=OscalArModule.class) public class Result extends Object implements dev.metaschema.core.model.IBoundObject
Used by the assessment results and POA&M. In the assessment results, this identifies all of the assessment observations and findings, initial and residual risks, deviations, and disposition. In the POA&M, this identifies initial and residual risks, deviations, and disposition.

  • Constructor Details

    • Result

      public Result()
      Constructs a new dev.metaschema.oscal.lib.model.Result instance with no metadata.

    • Result

      public Result(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Result instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getUuid

      @NonNull public UUID getUuid()
      Get the "Results Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this set of results in this or other OSCAL instances. The locally defined UUID of the assessment result can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Returns:
      the uuid value

    • setUuid

      public void setUuid(@NonNull UUID value)
      Set the "Results Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this set of results in this or other OSCAL instances. The locally defined UUID of the assessment result can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Parameters:
      value - the uuid value to set

    • getTitle

      @NonNull public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Results Title".

      The title for this set of results.

      Returns:
      the title value

    • setTitle

      public void setTitle(@NonNull dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Results Title".

      The title for this set of results.

      Parameters:
      value - the title value to set

    • getDescription

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Results Description".

      A human-readable description of this set of test results.

      Returns:
      the description value

    • setDescription

      public void setDescription(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Results Description".

      A human-readable description of this set of test results.

      Parameters:
      value - the description value to set

    • getStart

      @NonNull public ZonedDateTime getStart()
      Get the "start field".

      Date/time stamp identifying the start of the evidence collection reflected in these results.

      Returns:
      the start value

    • setStart

      public void setStart(@NonNull ZonedDateTime value)
      Set the "start field".

      Date/time stamp identifying the start of the evidence collection reflected in these results.

      Parameters:
      value - the start value to set

    • getEnd

      @Nullable public ZonedDateTime getEnd()
      Get the "end field".

      Date/time stamp identifying the end of the evidence collection reflected in these results. In a continuous motoring scenario, this may contain the same value as start if appropriate.

      Returns:
      the end value, or null if not set

    • setEnd

      public void setEnd(@Nullable ZonedDateTime value)
      Set the "end field".

      Date/time stamp identifying the end of the evidence collection reflected in these results. In a continuous motoring scenario, this may contain the same value as start if appropriate.

      Parameters:
      value - the end value to set, or null to clear

    • getProps

      @NonNull public List<Property> getProps()
      Get the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Returns:
      the prop value

    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Parameters:
      value - the prop value to set

    • addProp

      public boolean addProp(Property item)
      Add a new Property item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeProp

      public boolean removeProp(Property item)
      Remove the first matching Property item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getLinks

      @NonNull public List<Link> getLinks()
      Get the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Returns:
      the link value

    • setLinks

      public void setLinks(@NonNull List<Link> value)
      Set the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Parameters:
      value - the link value to set

    • addLink

      public boolean addLink(Link item)
      Add a new Link item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeLink

      public boolean removeLink(Link item)
      Remove the first matching Link item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getLocalDefinitions

      @Nullable public Result.LocalDefinitions getLocalDefinitions()
      Get the "Local Definitions".

      Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.

      Returns:
      the local-definitions value, or null if not set

    • setLocalDefinitions

      public void setLocalDefinitions(@Nullable Result.LocalDefinitions value)
      Set the "Local Definitions".

      Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.

      Parameters:
      value - the local-definitions value to set, or null to clear

    • getReviewedControls

      @NonNull public ReviewedControls getReviewedControls()
      Get the "Reviewed Controls and Control Objectives".

      Identifies the controls being assessed and their control objectives.

      Returns:
      the reviewed-controls value

    • setReviewedControls

      public void setReviewedControls(@NonNull ReviewedControls value)
      Set the "Reviewed Controls and Control Objectives".

      Identifies the controls being assessed and their control objectives.

      Parameters:
      value - the reviewed-controls value to set

    • getAttestations

      @NonNull public List<Result.Attestation> getAttestations()
      Get the "Attestation Statements".

      A set of textual statements, typically written by the assessor.

      Returns:
      the attestation value

    • setAttestations

      public void setAttestations(@NonNull List<Result.Attestation> value)
      Set the "Attestation Statements".

      A set of textual statements, typically written by the assessor.

      Parameters:
      value - the attestation value to set

    • addAttestation

      public boolean addAttestation(Result.Attestation item)
      Add a new Result.Attestation item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeAttestation

      public boolean removeAttestation(Result.Attestation item)
      Remove the first matching Result.Attestation item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getAssessmentLog

      @Nullable public Result.AssessmentLog getAssessmentLog()
      Get the "Assessment Log".

      A log of all assessment-related actions taken.

      Returns:
      the assessment-log value, or null if not set

    • setAssessmentLog

      public void setAssessmentLog(@Nullable Result.AssessmentLog value)
      Set the "Assessment Log".

      A log of all assessment-related actions taken.

      Parameters:
      value - the assessment-log value to set, or null to clear

    • getObservations

      @NonNull public List<Observation> getObservations()
      Get the "Observation".

      Describes an individual observation.

      Returns:
      the observation value

    • setObservations

      public void setObservations(@NonNull List<Observation> value)
      Set the "Observation".

      Describes an individual observation.

      Parameters:
      value - the observation value to set

    • addObservation

      public boolean addObservation(Observation item)
      Add a new Observation item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeObservation

      public boolean removeObservation(Observation item)
      Remove the first matching Observation item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getRisks

      @NonNull public List<Risk> getRisks()
      Get the "Identified Risk".

      An identified risk.

      Returns:
      the risk value

    • setRisks

      public void setRisks(@NonNull List<Risk> value)
      Set the "Identified Risk".

      An identified risk.

      Parameters:
      value - the risk value to set

    • addRisk

      public boolean addRisk(Risk item)
      Add a new Risk item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeRisk

      public boolean removeRisk(Risk item)
      Remove the first matching Risk item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getFindings

      @NonNull public List<Finding> getFindings()
      Get the "Finding".

      Describes an individual finding.

      Returns:
      the finding value

    • setFindings

      public void setFindings(@NonNull List<Finding> value)
      Set the "Finding".

      Describes an individual finding.

      Parameters:
      value - the finding value to set

    • addFinding

      public boolean addFinding(Finding item)
      Add a new Finding item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeFinding

      public boolean removeFinding(Finding item)
      Remove the first matching Finding item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getRemarks

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getRemarks()
      Get the "Remarks".

      Additional commentary about the containing object.

      Returns:
      the remarks value, or null if not set

    • setRemarks

      public void setRemarks(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Remarks".

      Additional commentary about the containing object.

      Parameters:
      value - the remarks value to set, or null to clear

    • toString

      public String toString()
      Overrides:
      toString in class Object