Package dev.metaschema.oscal.lib.model

Class ReviewedControls.ControlObjectiveSelection

java.lang.Object
dev.metaschema.oscal.lib.model.ReviewedControls.ControlObjectiveSelection
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
ReviewedControls
@MetaschemaAssembly(formalName="Referenced Control Objectives", description="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.", name="control-objective-selection", moduleClass=OscalAssessmentCommonModule.class, remarks="The `include-all` field, specifies all control objectives for any in-scope control. In-scope controls are defined in the `control-selection`.\n\nAny control objective specified within `exclude-controls` must first be within a range of explicitly included control objectives, via `include-objectives` or `include-all`.") public static class ReviewedControls.ControlObjectiveSelection extends Object implements dev.metaschema.core.model.IBoundObject
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.

  • Constructor Details

    • ControlObjectiveSelection

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

    • ControlObjectiveSelection

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

      A human-readable description of this collection 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 Objectives Description".

      A human-readable description of this collection 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

    • 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

    • getIncludeObjectives

      @NonNull public List<SelectObjectiveById> getIncludeObjectives()
      Get the "Select Objective".

      Used to select a control objective for inclusion/exclusion based on the control objective's identifier.

      Returns:
      the include-objective value

    • setIncludeObjectives

      public void setIncludeObjectives(@NonNull List<SelectObjectiveById> value)
      Set the "Select Objective".

      Used to select a control objective for inclusion/exclusion based on the control objective's identifier.

      Parameters:
      value - the include-objective value to set

    • addIncludeObjective

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

    • removeIncludeObjective

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

    • getExcludeObjectives

      @NonNull public List<SelectObjectiveById> getExcludeObjectives()
      Get the "Select Objective".

      Used to select a control objective for inclusion/exclusion based on the control objective's identifier.

      Returns:
      the exclude-objective value

    • setExcludeObjectives

      public void setExcludeObjectives(@NonNull List<SelectObjectiveById> value)
      Set the "Select Objective".

      Used to select a control objective for inclusion/exclusion based on the control objective's identifier.

      Parameters:
      value - the exclude-objective value to set

    • addExcludeObjective

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

    • removeExcludeObjective

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