Module dev.metaschema.databind
Package dev.metaschema.databind.model.metaschema.binding

Class FlagReference

java.lang.Object
dev.metaschema.databind.model.metaschema.binding.FlagReference
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Flag Reference", name="flag-reference", moduleClass=MetaschemaModelModule.class) public class FlagReference extends Object implements dev.metaschema.core.model.IBoundObject
Flag Reference.

  • Constructor Details

    • FlagReference

      public FlagReference()
      Constructs a new dev.metaschema.databind.model.metaschema.binding.FlagReference instance with no metadata.

    • FlagReference

      public FlagReference(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.databind.model.metaschema.binding.FlagReference 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

    • getRef

      @NonNull public String getRef()
      Get the global Flag Reference.
      Returns:
      the ref value

    • setRef

      public void setRef(@NonNull String value)
      Set the global Flag Reference.
      Parameters:
      value - the ref value to set

    • getIndex

      @Nullable public BigInteger getIndex()
      Get the flag Reference Binary Name.
      Returns:
      the index value, or null if not set

    • setIndex

      public void setIndex(@Nullable BigInteger value)
      Set the flag Reference Binary Name.
      Parameters:
      value - the index value to set, or null to clear

    • getDeprecated

      @Nullable public String getDeprecated()
      Get the deprecated Version.
      Returns:
      the deprecated value, or null if not set

    • setDeprecated

      public void setDeprecated(@Nullable String value)
      Set the deprecated Version.
      Parameters:
      value - the deprecated value to set, or null to clear

    • getDefault

      @Nullable public String getDefault()
      Get the default Flag Value.
      Returns:
      the default value, or null if not set

    • setDefault

      public void setDefault(@Nullable String value)
      Set the default Flag Value.
      Parameters:
      value - the default value to set, or null to clear

    • getRequired

      @Nullable public String getRequired()
      Get the is Flag Required?.
      Returns:
      the required value, or null if not set

    • setRequired

      public void setRequired(@Nullable String value)
      Set the is Flag Required?.
      Parameters:
      value - the required value to set, or null to clear

    • getFormalName

      @Nullable public String getFormalName()
      Get the formal Name.

      A formal name for the data construct, to be presented in documentation.

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

    • setFormalName

      public void setFormalName(@Nullable String value)
      Set the formal Name.

      A formal name for the data construct, to be presented in documentation.

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

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupLine getDescription()
      Get the description.

      A short description of the data construct's purpose, describing the constructs semantics.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the description.

      A short description of the data construct's purpose, describing the constructs semantics.

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

    • getProps

      @NonNull public List<Property> getProps()
      Get the property.
      Returns:
      the prop value

    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the property.
      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

    • getUseName

      @Nullable public UseName getUseName()
      Get the use Name.

      Allows the name of the definition to be overridden.

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

    • setUseName

      public void setUseName(@Nullable UseName value)
      Set the use Name.

      Allows the name of the definition to be overridden.

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

    • getRemarks

      @Nullable public Remarks getRemarks()
      Get the remarks.

      Any explanatory or helpful information to be provided about the remarks parent.

      Returns:
      the remarks value, or null if not set

    • setRemarks

      public void setRemarks(@Nullable Remarks value)
      Set the remarks.

      Any explanatory or helpful information to be provided about the remarks parent.

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

    • toString

      public String toString()
      Overrides:
      toString in class Object