Package dev.metaschema.oscal.lib.model

Class Modify.Alter.Add

java.lang.Object
dev.metaschema.oscal.lib.model.Modify.Alter.Add
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Modify.Alter
@MetaschemaAssembly(formalName="Addition", description="Specifies contents to be added into controls, in resolution.", name="add", moduleClass=OscalProfileModule.class, remarks="When no `by-id` is given, the addition is inserted into the control targeted by the alteration at the start or end as indicated by `position`. Only `position` values of \"starting\" or \"ending\" are permitted when there is no `by-id`.\n\n`by-id`, when given, should indicate, by its ID, an element inside the control to serve as the anchor point for the addition. In this case, `position` value may be any of the permitted values.", valueConstraints=@ValueConstraints(allowedValues=@AllowedValues(id="oscal-profile-modify-alter-prop-name-values",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="label",description="A human-readable label for the parent context, which may be rendered in place of the actual identifier for some use cases."),@AllowedValue(value="sort-id",description="An alternative identifier, whose value is easily sortable among other such values in the document."),@AllowedValue(value="alt-identifier",description="An alternate or aliased identifier for the parent context.")}))) public static class Modify.Alter.Add extends Object implements dev.metaschema.core.model.IBoundObject
Specifies contents to be added into controls, in resolution.

  • Constructor Details

    • Add

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

    • Add

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

    • getPosition

      @Nullable public String getPosition()
      Get the "Position".

      Where to add the new content with respect to the targeted element (beside it or inside it).

      Returns:
      the position value, or null if not set

    • setPosition

      public void setPosition(@Nullable String value)
      Set the "Position".

      Where to add the new content with respect to the targeted element (beside it or inside it).

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

    • getById

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

      Target location of the addition.

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

    • setById

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

      Target location of the addition.

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

    • getTitle

      @Nullable public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Title Change".

      A name given to the control, which may be used by a tool for display and navigation.

      Returns:
      the title value, or null if not set

    • setTitle

      public void setTitle(@Nullable dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Title Change".

      A name given to the control, which may be used by a tool for display and navigation.

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

    • getParams

      @NonNull public List<Parameter> getParams()
      Get the "Parameter".

      Parameters provide a mechanism for the dynamic assignment of value(s) in a control.

      Returns:
      the param value

    • setParams

      public void setParams(@NonNull List<Parameter> value)
      Set the "Parameter".

      Parameters provide a mechanism for the dynamic assignment of value(s) in a control.

      Parameters:
      value - the param value to set

    • addParam

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

    • removeParam

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

    • 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

    • getParts

      @NonNull public List<ControlPart> getParts()
      Get the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Returns:
      the part value

    • setParts

      public void setParts(@NonNull List<ControlPart> value)
      Set the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Parameters:
      value - the part value to set

    • addPart

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

    • removePart

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