Package dev.metaschema.oscal.lib.model

Class GapSummary

java.lang.Object
dev.metaschema.oscal.lib.model.GapSummary
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Gap Summary", description="A *by-id* collection of all controls that were not mapped at all in this ` mapping-collection`. If a control is partially mapped, the parts of the control are not mappable, the gap and discrepancies should be documented in the ` relationship-gal`.", name="gap-summary", moduleClass=OscalMappingCommonModule.class) public class GapSummary extends Object implements dev.metaschema.core.model.IBoundObject
A by-id collection of all controls that were not mapped at all in this mapping-collection. If a control is partially mapped, the parts of the control are not mappable, the gap and discrepancies should be documented in the relationship-gal.

  • Constructor Details

    • GapSummary

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

    • GapSummary

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

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

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

    • getUnmappedControls

      @NonNull public List<SelectControlById> getUnmappedControls()
      Get the "Select Control".

      Select a control or controls from an imported control set.

      Returns:
      the unmapped-controls value

    • setUnmappedControls

      public void setUnmappedControls(@NonNull List<SelectControlById> value)
      Set the "Select Control".

      Select a control or controls from an imported control set.

      Parameters:
      value - the unmapped-controls value to set

    • addUnmappedControls

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

    • removeUnmappedControls

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

    • toString

      public String toString()
      Overrides:
      toString in class Object