Package dev.metaschema.oscal.lib.model

Class ReviewedControls

java.lang.Object
dev.metaschema.oscal.lib.model.ReviewedControls
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Reviewed Controls and Control Objectives", description="Identifies the controls being assessed and their control objectives.", name="reviewed-controls", moduleClass=OscalAssessmentCommonModule.class, remarks="In the context of an assessment plan, this construct is used to identify the controls and control objectives that are to be assessed. In the context of an assessment result, this construct is used to identify the actual controls and objectives that were assessed, reflecting any changes from the plan.\n\nWhen resolving the selection of controls and control objectives, the following processing will occur:\n\n1. Controls will be resolved by creating a set of controls based on the control-selections by first handling the includes, and then removing any excluded controls.\n\n2. The set of control objectives will be resolved from the set of controls that was generated in the previous step. The set of control objectives is based on the control-objective-selection by first handling the includes, and then removing any excluded control objectives.") public class ReviewedControls extends Object implements dev.metaschema.core.model.IBoundObject
Identifies the controls being assessed and their control objectives.

  • Constructor Details

    • ReviewedControls

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

    • ReviewedControls

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

      A human-readable description of control objectives.

      Returns:
      the description value, or null if not set

    • setDescription

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

      A human-readable description of control objectives.

      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

    • getControlSelections

      @NonNull public List<ReviewedControls.ControlSelection> getControlSelections()
      Get the "Assessed Controls".

      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.

      Returns:
      the control-selection value

    • setControlSelections

      public void setControlSelections(@NonNull List<ReviewedControls.ControlSelection> value)
      Set the "Assessed Controls".

      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.

      Parameters:
      value - the control-selection value to set

    • addControlSelection

      public boolean addControlSelection(ReviewedControls.ControlSelection item)
      Add a new ReviewedControls.ControlSelection item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeControlSelection

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

    • getControlObjectiveSelections

      @NonNull public List<ReviewedControls.ControlObjectiveSelection> getControlObjectiveSelections()
      Get the "Referenced Control Objectives".

      Identifies the control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.

      Returns:
      the control-objective-selection value

    • setControlObjectiveSelections

      public void setControlObjectiveSelections(@NonNull List<ReviewedControls.ControlObjectiveSelection> value)
      Set the "Referenced Control Objectives".

      Identifies the control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.

      Parameters:
      value - the control-objective-selection value to set

    • addControlObjectiveSelection

      public boolean addControlObjectiveSelection(ReviewedControls.ControlObjectiveSelection item)
      Add a new ReviewedControls.ControlObjectiveSelection item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeControlObjectiveSelection

      public boolean removeControlObjectiveSelection(ReviewedControls.ControlObjectiveSelection item)
      Remove the first matching ReviewedControls.ControlObjectiveSelection 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