Package dev.metaschema.oscal.lib.model

Class Finding

java.lang.Object
dev.metaschema.oscal.lib.model.Finding
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Finding", description="Describes an individual finding.", name="finding", moduleClass=OscalAssessmentCommonModule.class) public class Finding extends Object implements dev.metaschema.core.model.IBoundObject
Describes an individual finding.

  • Constructor Details

    • Finding

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

    • Finding

      public Finding(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Finding 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 "Finding Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this finding in this or other OSCAL instances. The locally defined UUID of the finding 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 "Finding Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this finding in this or other OSCAL instances. The locally defined UUID of the finding 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 "Finding Title".

      The title for this finding.

      Returns:
      the title value

    • setTitle

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

      The title for this finding.

      Parameters:
      value - the title value to set

    • getDescription

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

      A human-readable description of this finding.

      Returns:
      the description value

    • setDescription

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

      A human-readable description of this finding.

      Parameters:
      value - the description value to set

    • 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

    • getOrigins

      @NonNull public List<Origin> getOrigins()
      Get the "Origin".

      Identifies the source of the finding, such as a tool, interviewed person, or activity.

      Returns:
      the origin value

    • setOrigins

      public void setOrigins(@NonNull List<Origin> value)
      Set the "Origin".

      Identifies the source of the finding, such as a tool, interviewed person, or activity.

      Parameters:
      value - the origin value to set

    • addOrigin

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

    • removeOrigin

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

    • getTarget

      @NonNull public FindingTarget getTarget()
      Get the "Objective Status".

      Captures an assessor's conclusions regarding the degree to which an objective is satisfied.

      Returns:
      the target value

    • setTarget

      public void setTarget(@NonNull FindingTarget value)
      Set the "Objective Status".

      Captures an assessor's conclusions regarding the degree to which an objective is satisfied.

      Parameters:
      value - the target value to set

    • getImplementationStatementUuid

      @Nullable public UUID getImplementationStatementUuid()
      Get the "Implementation Statement UUID".

      A machine-oriented identifier reference to the implementation statement in the SSP to which this finding is related.

      Returns:
      the implementation-statement-uuid value, or null if not set

    • setImplementationStatementUuid

      public void setImplementationStatementUuid(@Nullable UUID value)
      Set the "Implementation Statement UUID".

      A machine-oriented identifier reference to the implementation statement in the SSP to which this finding is related.

      Parameters:
      value - the implementation-statement-uuid value to set, or null to clear

    • getRelatedObservations

      @NonNull public List<Finding.RelatedObservation> getRelatedObservations()
      Get the "Related Observation".

      Relates the finding to a set of referenced observations that were used to determine the finding.

      Returns:
      the related-observation value

    • setRelatedObservations

      public void setRelatedObservations(@NonNull List<Finding.RelatedObservation> value)
      Set the "Related Observation".

      Relates the finding to a set of referenced observations that were used to determine the finding.

      Parameters:
      value - the related-observation value to set

    • addRelatedObservation

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

    • removeRelatedObservation

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

    • getRelatedRisks

      @NonNull public List<Finding.AssociatedRisk> getRelatedRisks()
      Get the "Associated Risk".

      Relates the finding to a set of referenced risks that were used to determine the finding.

      Returns:
      the associated-risk value

    • setRelatedRisks

      public void setRelatedRisks(@NonNull List<Finding.AssociatedRisk> value)
      Set the "Associated Risk".

      Relates the finding to a set of referenced risks that were used to determine the finding.

      Parameters:
      value - the associated-risk value to set

    • addAssociatedRisk

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

    • removeAssociatedRisk

      public boolean removeAssociatedRisk(Finding.AssociatedRisk item)
      Remove the first matching Finding.AssociatedRisk 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