Package dev.metaschema.oscal.lib.model

Class SetParameter

java.lang.Object
dev.metaschema.oscal.lib.model.SetParameter
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Set Parameter Value", description="Identifies the parameter that will be set by the enclosed value.", name="set-parameter", moduleClass=OscalImplementationCommonModule.class) public class SetParameter extends Object implements dev.metaschema.core.model.IBoundObject
Identifies the parameter that will be set by the enclosed value.

  • Constructor Details

    • SetParameter

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

    • SetParameter

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

    • getParamId

      @NonNull public String getParamId()
      Get the "Parameter ID".

      A human-oriented reference to a parameter within a control, who's catalog has been imported into the current implementation context.

      Returns:
      the param-id value

    • setParamId

      public void setParamId(@NonNull String value)
      Set the "Parameter ID".

      A human-oriented reference to a parameter within a control, who's catalog has been imported into the current implementation context.

      Parameters:
      value - the param-id value to set

    • getValues

      @NonNull public List<String> getValues()
      Get the "Parameter Value".

      A parameter value or set of values.

      Returns:
      the value value

    • setValues

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

      A parameter value or set of values.

      Parameters:
      value - the value value to set

    • addValue

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

    • removeValue

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

    • 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