Package dev.metaschema.oscal.lib.model

Class Modify

java.lang.Object
dev.metaschema.oscal.lib.model.Modify
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Modify Controls", description="Set parameters or amend controls in resolution.", name="modify", moduleClass=OscalProfileModule.class, modelConstraints=@AssemblyConstraints(unique=@IsUnique(id="oscal-unique-profile-modify-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 Modify extends Object implements dev.metaschema.core.model.IBoundObject
Set parameters or amend controls in resolution.

  • Constructor Details

    • Modify

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

    • Modify

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

    • getSetParameters

      @NonNull public List<Modify.ProfileSetParameter> getSetParameters()
      Get the "Parameter Setting".

      A parameter setting, to be propagated to points of insertion.

      Returns:
      the set-parameter value

    • setSetParameters

      public void setSetParameters(@NonNull List<Modify.ProfileSetParameter> value)
      Set the "Parameter Setting".

      A parameter setting, to be propagated to points of insertion.

      Parameters:
      value - the set-parameter value to set

    • addSetParameter

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

    • removeSetParameter

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

    • getAlters

      @NonNull public List<Modify.Alter> getAlters()
      Get the "Alteration".

      Specifies changes to be made to an included control when a profile is resolved.

      Returns:
      the alter value

    • setAlters

      public void setAlters(@NonNull List<Modify.Alter> value)
      Set the "Alteration".

      Specifies changes to be made to an included control when a profile is resolved.

      Parameters:
      value - the alter value to set

    • addAlter

      public boolean addAlter(Modify.Alter item)
      Add a new Modify.Alter item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeAlter

      public boolean removeAlter(Modify.Alter item)
      Remove the first matching Modify.Alter 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