Package dev.metaschema.oscal.lib.model

Class ReviewedControls.ControlSelection

java.lang.Object
dev.metaschema.oscal.lib.model.ReviewedControls.ControlSelection
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
ReviewedControls
@MetaschemaAssembly(formalName="Assessed Controls", description="Identifies the controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.", name="control-selection", moduleClass=OscalAssessmentCommonModule.class, remarks="The `include-all`, specifies all control identified in the **baseline** are included in the scope if this assessment, as specified by the `include-profile` statement within the linked SSP.\n\nAny control specified within `exclude-controls` must first be within a range of explicitly included controls, via `include-controls` or `include-all`.") public static class ReviewedControls.ControlSelection extends Object implements dev.metaschema.core.model.IBoundObject
Identifies the controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.

  • Constructor Details

    • ControlSelection

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

    • ControlSelection

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

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Assessed Controls Description".

      A human-readable description of in-scope controls specified for assessment.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Assessed Controls Description".

      A human-readable description of in-scope controls specified for assessment.

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

    • 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

    • getIncludeAll

      @Nullable public IncludeAll getIncludeAll()
      Get the "Include All".

      Include all controls from the imported catalog or profile resources.

      Returns:
      the include-all value, or null if not set

    • setIncludeAll

      public void setIncludeAll(@Nullable IncludeAll value)
      Set the "Include All".

      Include all controls from the imported catalog or profile resources.

      Parameters:
      value - the include-all value to set, or null to clear

    • getIncludeControls

      @NonNull public List<SelectControlByIdOscalAssessmentCommon> getIncludeControls()
      Get the "Select Control".

      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.

      Returns:
      the include-control value

    • setIncludeControls

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

      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.

      Parameters:
      value - the include-control value to set

    • addIncludeControl

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

    • removeIncludeControl

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

    • getExcludeControls

      @NonNull public List<SelectControlByIdOscalAssessmentCommon> getExcludeControls()
      Get the "Select Control".

      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.

      Returns:
      the exclude-control value

    • setExcludeControls

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

      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.

      Parameters:
      value - the exclude-control value to set

    • addExcludeControl

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

    • removeExcludeControl

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