Package dev.metaschema.oscal.lib.model

Class ControlImplementation

java.lang.Object
dev.metaschema.oscal.lib.model.ControlImplementation
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Control Implementation", description="Describes how the system satisfies a set of controls.", name="control-implementation", moduleClass=OscalSspModule.class, remarks="Use of `set-parameter` in this context, sets the parameter for all controls referenced by any `implemented-requirement` contained in this context. Any `set-parameter` defined in a child context will override this value. If not overridden by a child, this value applies in the child context.", modelConstraints=@AssemblyConstraints(index=@Index(id="oscal-by-component-export-provided-uuid-index",level=ERROR,target="implemented-requirement//by-component/export/provided",name="by-component-export-provided-uuid",keyFields=@KeyField(target="@uuid")),unique=@IsUnique(id="oscal-unique-ssp-control-implementation-set-parameter",level=ERROR,target="set-parameter",keyFields=@KeyField(target="@param-id"),remarks="Since multiple `set-parameter` entries can be provided, each parameter must be set only once."))) public class ControlImplementation extends Object implements dev.metaschema.core.model.IBoundObject
Describes how the system satisfies a set of controls.

  • Constructor Details

    • ControlImplementation

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

    • ControlImplementation

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

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Control Implementation Description".

      A statement describing important things to know about how this set of control satisfaction documentation is approached.

      Returns:
      the description value

    • setDescription

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

      A statement describing important things to know about how this set of control satisfaction documentation is approached.

      Parameters:
      value - the description value to set

    • getSetParameters

      @NonNull public List<SetParameter> getSetParameters()
      Get the "Set Parameter Value".

      Identifies the parameter that will be set by the enclosed value.

      Returns:
      the set-parameter value

    • setSetParameters

      public void setSetParameters(@NonNull List<SetParameter> value)
      Set the "Set Parameter Value".

      Identifies the parameter that will be set by the enclosed value.

      Parameters:
      value - the set-parameter value to set

    • addSetParameter

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

    • removeSetParameter

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

    • getImplementedRequirements

      @NonNull public List<ImplementedRequirement> getImplementedRequirements()
      Get the "Control-based Requirement".

      Describes how the system satisfies the requirements of an individual control.

      Returns:
      the implemented-requirement value

    • setImplementedRequirements

      public void setImplementedRequirements(@NonNull List<ImplementedRequirement> value)
      Set the "Control-based Requirement".

      Describes how the system satisfies the requirements of an individual control.

      Parameters:
      value - the implemented-requirement value to set

    • addImplementedRequirement

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

    • removeImplementedRequirement

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