Class Observation.RelevantEvidence

java.lang.Object
dev.metaschema.oscal.lib.model.Observation.RelevantEvidence
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Observation

@MetaschemaAssembly(formalName="Relevant Evidence", description="Links this observation to relevant evidence.", name="relevant-evidence", moduleClass=OscalAssessmentCommonModule.class) public static class Observation.RelevantEvidence extends Object implements dev.metaschema.core.model.IBoundObject
Links this observation to relevant evidence.
  • Constructor Details

    • RelevantEvidence

      Constructs a new dev.metaschema.oscal.lib.model.Observation.RelevantEvidence instance with no metadata.
    • RelevantEvidence

      public RelevantEvidence(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.Observation.RelevantEvidence 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
    • getHref

      @Nullable public URI getHref()
      Get the "Relevant Evidence Reference".

      A resolvable URL reference to relevant evidence.

      Returns:
      the href value, or null if not set
    • setHref

      public void setHref(@Nullable URI value)
      Set the "Relevant Evidence Reference".

      A resolvable URL reference to relevant evidence.

      Parameters:
      value - the href value to set, or null to clear
    • getDescription

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

      A human-readable description of this evidence.

      Returns:
      the description value
    • setDescription

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

      A human-readable description of this evidence.

      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
    • 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