Package dev.metaschema.oscal.lib.model

Class ParameterGuideline

java.lang.Object
dev.metaschema.oscal.lib.model.ParameterGuideline
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Guideline", description="A prose statement that provides a recommendation for the use of a parameter.", name="parameter-guideline", moduleClass=OscalControlCommonModule.class) public class ParameterGuideline extends Object implements dev.metaschema.core.model.IBoundObject
A prose statement that provides a recommendation for the use of a parameter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParameterGuideline()
    Constructs a new dev.metaschema.oscal.lib.model.ParameterGuideline instance with no metadata.
    ParameterGuideline(dev.metaschema.core.model.IMetaschemaData data)
    Constructs a new dev.metaschema.oscal.lib.model.ParameterGuideline instance with the specified metadata.

  • Method Summary

    Modifier and Type
    Method
    Description
    dev.metaschema.core.model.IMetaschemaData
    getMetaschemaData()
     
    dev.metaschema.core.datatype.markup.MarkupMultiline
    getProse()
    Get the "Guideline Text".
    void
    setProse(dev.metaschema.core.datatype.markup.MarkupMultiline value)
    Set the "Guideline Text".
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ParameterGuideline

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

    • ParameterGuideline

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

    • getProse

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getProse()
      Get the "Guideline Text".

      Prose permits multiple paragraphs, lists, tables etc.

      Returns:
      the prose value

    • setProse

      public void setProse(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Guideline Text".

      Prose permits multiple paragraphs, lists, tables etc.

      Parameters:
      value - the prose value to set

    • toString

      public String toString()
      Overrides:
      toString in class Object