Package dev.metaschema.oscal.lib.model

Class SelectControlByIdOscalAssessmentCommon

java.lang.Object
dev.metaschema.oscal.lib.model.SelectControlByIdOscalAssessmentCommon
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Select Control", description="Used to select a control for inclusion/exclusion based on one or more control identifiers. A set of statement identifiers can be used to target the inclusion/exclusion to only specific control statements providing more granularity over the specific statements that are within the assessment scope.", name="select-control-by-id", moduleClass=OscalAssessmentCommonModule.class) public class SelectControlByIdOscalAssessmentCommon extends Object implements dev.metaschema.core.model.IBoundObject
Used to select a control for inclusion/exclusion based on one or more control identifiers. A set of statement identifiers can be used to target the inclusion/exclusion to only specific control statements providing more granularity over the specific statements that are within the assessment scope.

  • Constructor Details

    • SelectControlByIdOscalAssessmentCommon

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

    • SelectControlByIdOscalAssessmentCommon

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

    • getControlId

      @NonNull public String getControlId()
      Get the "Control Identifier Reference".

      A reference to a control with a corresponding id value. When referencing an externally defined control, the Control Identifier Reference must be used in the context of the external / imported OSCAL instance (e.g., uri-reference).

      Returns:
      the control-id value

    • setControlId

      public void setControlId(@NonNull String value)
      Set the "Control Identifier Reference".

      A reference to a control with a corresponding id value. When referencing an externally defined control, the Control Identifier Reference must be used in the context of the external / imported OSCAL instance (e.g., uri-reference).

      Parameters:
      value - the control-id value to set

    • getStatementIds

      @NonNull public List<String> getStatementIds()
      Get the "Include Specific Statements".

      Used to constrain the selection to only specificity identified statements.

      Returns:
      the statement-id value

    • setStatementIds

      public void setStatementIds(@NonNull List<String> value)
      Set the "Include Specific Statements".

      Used to constrain the selection to only specificity identified statements.

      Parameters:
      value - the statement-id value to set

    • addStatementId

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

    • removeStatementId

      public boolean removeStatementId(String item)
      Remove the first matching String 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