Package dev.metaschema.oscal.lib.model

Class MappingProvenance

java.lang.Object
dev.metaschema.oscal.lib.model.MappingProvenance
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Mapping Provenance", description="Describes requirements, incompatibilities and gaps that are identified between a target and source in a mapping item.", name="mapping-provenance", moduleClass=OscalMappingCommonModule.class) public class MappingProvenance extends Object implements dev.metaschema.core.model.IBoundObject
Describes requirements, incompatibilities and gaps that are identified between a target and source in a mapping item.

  • Constructor Details

    • MappingProvenance

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

    • MappingProvenance

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

    • getMethod

      @NonNull public String getMethod()
      Get the "Method".

      The method used to complete the overall mapping.

      Returns:
      the method value

    • setMethod

      public void setMethod(@NonNull String value)
      Set the "Method".

      The method used to complete the overall mapping.

      Parameters:
      value - the method value to set

    • getMatchingRationale

      @NonNull public String getMatchingRationale()
      Get the "Matching".

      The method used for relating controls within the mapping. The supported methods are aligned with the NIST Interagency Report (IR) 8477, Section 4.3 Set Theory Relationship Mapping.

      Returns:
      the matching-rationale value

    • setMatchingRationale

      public void setMatchingRationale(@NonNull String value)
      Set the "Matching".

      The method used for relating controls within the mapping. The supported methods are aligned with the NIST Interagency Report (IR) 8477, Section 4.3 Set Theory Relationship Mapping.

      Parameters:
      value - the matching-rationale value to set

    • getStatus

      @NonNull public String getStatus()
      Get the "Status".

      The current status of this mapping document.

      Returns:
      the status value

    • setStatus

      public void setStatus(@NonNull String value)
      Set the "Status".

      The current status of this mapping document.

      Parameters:
      value - the status value to set

    • getConfidenceScore

      @Nullable public ConfidenceScore getConfidenceScore()
      Get the "Confidence Score".

      This records either a string category or a decimal value from 0-1 representing a percentage. Both of these values describe an estimation of the author's confidence that this mapping is correct and accurate.

      Returns:
      the confidence-score value, or null if not set

    • setConfidenceScore

      public void setConfidenceScore(@Nullable ConfidenceScore value)
      Set the "Confidence Score".

      This records either a string category or a decimal value from 0-1 representing a percentage. Both of these values describe an estimation of the author's confidence that this mapping is correct and accurate.

      Parameters:
      value - the confidence-score value to set, or null to clear

    • getCoverage

      @Nullable public Coverage getCoverage()
      Get the "Coverage".

      A decimal value from 0-1, representing the percentage coverage of the targets by the sources.

      Returns:
      the coverage value, or null if not set

    • setCoverage

      public void setCoverage(@Nullable Coverage value)
      Set the "Coverage".

      A decimal value from 0-1, representing the percentage coverage of the targets by the sources.

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

    • getMappingDescription

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

      Description of the context and intended use of the mapping set.

      Returns:
      the mapping-description value

    • setMappingDescription

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

      Description of the context and intended use of the mapping set.

      Parameters:
      value - the mapping-description value to set

    • getResponsibleParties

      @NonNull public List<ResponsibleParty> getResponsibleParties()
      Get the "Responsible Party".

      A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.

      Returns:
      the responsible-party value

    • setResponsibleParties

      public void setResponsibleParties(@NonNull List<ResponsibleParty> value)
      Set the "Responsible Party".

      A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.

      Parameters:
      value - the responsible-party value to set

    • addResponsibleParty

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

    • removeResponsibleParty

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

    • 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