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

Class FlagExpect

java.lang.Object
dev.metaschema.databind.model.metaschema.binding.FlagExpect
All Implemented Interfaces:
IBoundObject, IConfigurableMessageConstraintBase, IConstraintBase
@MetaschemaAssembly(formalName="Expect Condition Constraint", name="flag-expect", moduleClass=MetaschemaModelModule.class) public class FlagExpect extends Object implements IBoundObject, IConfigurableMessageConstraintBase
Expect Condition Constraint.

  • Constructor Details

    • FlagExpect

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

    • FlagExpect

      public FlagExpect(IMetaschemaData data)
      Constructs a new dev.metaschema.databind.model.metaschema.binding.FlagExpect instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public IMetaschemaData getMetaschemaData()
      Description copied from interface: IBoundObject
      Get additional Metaschema-related information for the object (i.e., resource location).
      Specified by:
      getMetaschemaData in interface IBoundObject
      Returns:
      the Metaschema-related information

    • getId

      @Nullable public String getId()
      Get the constraint Identifier.
      Specified by:
      getId in interface IConstraintBase
      Returns:
      the id value, or null if not set

    • setId

      public void setId(@Nullable String value)
      Set the constraint Identifier.
      Parameters:
      value - the id value to set, or null to clear

    • getLevel

      @Nullable public String getLevel()
      Get the constraint Severity Level.
      Specified by:
      getLevel in interface IConstraintBase
      Returns:
      the level value, or null if not set

    • setLevel

      public void setLevel(@Nullable String value)
      Set the constraint Severity Level.
      Parameters:
      value - the level value to set, or null to clear

    • getTest

      @NonNull public String getTest()
      Get the expect Test Condition.
      Returns:
      the test value

    • setTest

      public void setTest(@NonNull String value)
      Set the expect Test Condition.
      Parameters:
      value - the test value to set

    • getFormalName

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

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

      Specified by:
      getFormalName in interface IConstraintBase
      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 MarkupLine getDescription()
      Get the description.

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

      Specified by:
      getDescription in interface IConstraintBase
      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable 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.
      Specified by:
      getProps in interface IConstraintBase
      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

    • getMessage

      @Nullable public String getMessage()
      Get the constraint Condition Violation Message.
      Specified by:
      getMessage in interface IConfigurableMessageConstraintBase
      Returns:
      the message value, or null if not set

    • setMessage

      public void setMessage(@Nullable String value)
      Set the constraint Condition Violation Message.
      Parameters:
      value - the message 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.

      Specified by:
      getRemarks in interface IConstraintBase
      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