Package dev.metaschema.oscal.lib.model

Class Modify.ProfileSetParameter

java.lang.Object
dev.metaschema.oscal.lib.model.Modify.ProfileSetParameter
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Modify
@MetaschemaAssembly(formalName="Parameter Setting", description="A parameter setting, to be propagated to points of insertion.", name="set-parameter", moduleClass=OscalProfileModule.class) public static class Modify.ProfileSetParameter extends Object implements dev.metaschema.core.model.IBoundObject
A parameter setting, to be propagated to points of insertion.

  • Constructor Details

    • ProfileSetParameter

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

    • ProfileSetParameter

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

      An identifier for the parameter.

      Returns:
      the param-id value

    • setParamId

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

      An identifier for the parameter.

      Parameters:
      value - the param-id value to set

    • getClazz

      @Nullable public String getClazz()
      Get the "Parameter Class".

      A textual label that provides a characterization of the parameter.

      Returns:
      the class value, or null if not set

    • setClazz

      public void setClazz(@Nullable String value)
      Set the "Parameter Class".

      A textual label that provides a characterization of the parameter.

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

    • getDependsOn

      @Nullable public String getDependsOn()
      Get the "Depends On".

      **(deprecated)** Another parameter invoking this one. This construct has been deprecated and should not be used.

      Returns:
      the depends-on value, or null if not set

    • setDependsOn

      public void setDependsOn(@Nullable String value)
      Set the "Depends On".

      **(deprecated)** Another parameter invoking this one. This construct has been deprecated and should not be used.

      Parameters:
      value - the depends-on value to set, or null to clear

    • 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

    • getLabel

      @Nullable public dev.metaschema.core.datatype.markup.MarkupLine getLabel()
      Get the "Parameter Label".

      A short, placeholder name for the parameter, which can be used as a substitute for a value if no value is assigned.

      Returns:
      the label value, or null if not set

    • setLabel

      public void setLabel(@Nullable dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Parameter Label".

      A short, placeholder name for the parameter, which can be used as a substitute for a value if no value is assigned.

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

    • getUsage

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getUsage()
      Get the "Parameter Usage Description".

      Describes the purpose and use of a parameter.

      Returns:
      the usage value, or null if not set

    • setUsage

      public void setUsage(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Parameter Usage Description".

      Describes the purpose and use of a parameter.

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

    • getConstraints

      @NonNull public List<ParameterConstraint> getConstraints()
      Get the "Constraint".

      A formal or informal expression of a constraint or test.

      Returns:
      the constraint value

    • setConstraints

      public void setConstraints(@NonNull List<ParameterConstraint> value)
      Set the "Constraint".

      A formal or informal expression of a constraint or test.

      Parameters:
      value - the constraint value to set

    • addConstraint

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

    • removeConstraint

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

    • getGuidelines

      @NonNull public List<ParameterGuideline> getGuidelines()
      Get the "Guideline".

      A prose statement that provides a recommendation for the use of a parameter.

      Returns:
      the guideline value

    • setGuidelines

      public void setGuidelines(@NonNull List<ParameterGuideline> value)
      Set the "Guideline".

      A prose statement that provides a recommendation for the use of a parameter.

      Parameters:
      value - the guideline value to set

    • addGuideline

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

    • removeGuideline

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

    • 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

    • getSelect

      @Nullable public ParameterSelection getSelect()
      Get the "Selection".

      Presenting a choice among alternatives.

      Returns:
      the select value, or null if not set

    • setSelect

      public void setSelect(@Nullable ParameterSelection value)
      Set the "Selection".

      Presenting a choice among alternatives.

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

    • toString

      public String toString()
      Overrides:
      toString in class Object