Package dev.metaschema.oscal.lib.model

Class Modify.Alter.Remove

java.lang.Object
dev.metaschema.oscal.lib.model.Modify.Alter.Remove
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Modify.Alter
@MetaschemaAssembly(formalName="Removal", description="Specifies objects to be removed from a control based on specific aspects of the object that must all match.", name="remove", moduleClass=OscalProfileModule.class, remarks="Use `by-name`, `by-class`, `by-id` or `by-item-name` to indicate class tokens or ID reference, or the formal name, of the component to be removed or erased from a control, when a catalog is resolved. The control affected is indicated by the pointer on the removal\'s parent (containing) `alter` element.\n\nTo change an element, use `remove` to remove the element, then `add` to add it back again with changes.") public static class Modify.Alter.Remove extends Object implements dev.metaschema.core.model.IBoundObject
Specifies objects to be removed from a control based on specific aspects of the object that must all match.

  • Constructor Details

    • Remove

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

    • Remove

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

    • getByName

      @Nullable public String getByName()
      Get the "Reference by (assigned) name".

      Identify items remove by matching their assigned name.

      Returns:
      the by-name value, or null if not set

    • setByName

      public void setByName(@Nullable String value)
      Set the "Reference by (assigned) name".

      Identify items remove by matching their assigned name.

      Parameters:
      value - the by-name value to set, or null to clear

    • getByClass

      @Nullable public String getByClass()
      Get the "Reference by class".

      Identify items to remove by matching their class.

      Returns:
      the by-class value, or null if not set

    • setByClass

      public void setByClass(@Nullable String value)
      Set the "Reference by class".

      Identify items to remove by matching their class.

      Parameters:
      value - the by-class value to set, or null to clear

    • getById

      @Nullable public String getById()
      Get the "Reference by ID".

      Identify items to remove indicated by their id.

      Returns:
      the by-id value, or null if not set

    • setById

      public void setById(@Nullable String value)
      Set the "Reference by ID".

      Identify items to remove indicated by their id.

      Parameters:
      value - the by-id value to set, or null to clear

    • getByItemName

      @Nullable public String getByItemName()
      Get the "Item Name Reference".

      Identify items to remove by the name of the item's information object name, e.g. title or prop.

      Returns:
      the by-item-name value, or null if not set

    • setByItemName

      public void setByItemName(@Nullable String value)
      Set the "Item Name Reference".

      Identify items to remove by the name of the item's information object name, e.g. title or prop.

      Parameters:
      value - the by-item-name value to set, or null to clear

    • getByNs

      @Nullable public URI getByNs()
      Get the "Item Namespace Reference".

      Identify items to remove by the item's ns, which is the namespace associated with a part, or prop.

      Returns:
      the by-ns value, or null if not set

    • setByNs

      public void setByNs(@Nullable URI value)
      Set the "Item Namespace Reference".

      Identify items to remove by the item's ns, which is the namespace associated with a part, or prop.

      Parameters:
      value - the by-ns value to set, or null to clear

    • 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