Package dev.metaschema.oscal.lib.model

Class InsertControls

java.lang.Object
dev.metaschema.oscal.lib.model.InsertControls
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Insert Controls", description="Specifies which controls to use in the containing context.", name="insert-controls", moduleClass=OscalProfileModule.class, remarks="To be schema-valid, this element must contain either (but not both) a single `include-all` directive, or a sequence of `include-controls` directives.\n\nIf this directive is not provided, then no controls are to be inserted; i.e., all controls are included explicitly.") public class InsertControls extends Object implements dev.metaschema.core.model.IBoundObject
Specifies which controls to use in the containing context.

  • Constructor Details

    • InsertControls

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

    • InsertControls

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

    • getOrder

      @Nullable public String getOrder()
      Get the "Order".

      A designation of how a selection of controls in a profile is to be ordered.

      Returns:
      the order value, or null if not set

    • setOrder

      public void setOrder(@Nullable String value)
      Set the "Order".

      A designation of how a selection of controls in a profile is to be ordered.

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

    • 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<ProfileSelectControlById> getIncludeControls()
      Get the "Select Control".

      Select a control or controls from an imported control set.

      Returns:
      the include-controls value

    • setIncludeControls

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

      Select a control or controls from an imported control set.

      Parameters:
      value - the include-controls value to set

    • addIncludeControls

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

    • removeIncludeControls

      public boolean removeIncludeControls(ProfileSelectControlById item)
      Remove the first matching ProfileSelectControlById 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<ProfileSelectControlById> getExcludeControls()
      Get the "Select Control".

      Select a control or controls from an imported control set.

      Returns:
      the exclude-controls value

    • setExcludeControls

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

      Select a control or controls from an imported control set.

      Parameters:
      value - the exclude-controls value to set

    • addExcludeControls

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

    • removeExcludeControls

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