Package com.esprow.oapi.repository

Interface OapiFieldRef

All Superinterfaces:
OapiBaseEntity
public interface OapiFieldRef extends OapiBaseEntity
A reference to a field by its ID and scenario.

The following attributes and references are supported:

  • Method Details

    • getRules

      List<OapiFieldRule> getRules()
      Returns a list of rules.
      Returns:
      a list of rules

    • getAssign

      String getAssign()
      Returns an expression providing a value to set for a field.
      Returns:
      an expression providing a value to set for a field
      See Also:

    • setAssign

      void setAssign(String value)
      Set an expression providing a value to set for a field.
      Parameters:
      value - the new value of the 'Assign' attribute.
      See Also:

    • getAnnotation

      OapiAnnotation getAnnotation()
      Returns all metadata on an element (documentation etc.).
      Returns:
      all metadata on an element (documentation etc.)
      See Also:

    • setAnnotation

      void setAnnotation(OapiAnnotation value)
      Set all metadata on an element (documentation etc.).
      Parameters:
      value - the new value of the 'Annotation' containment reference.
      See Also:

    • getEncoding

      String getEncoding()
      Returns a character encoding if it is other than US-ASCII.
      Returns:
      a character encoding if it is other than US-ASCII
      See Also:

    • setEncoding

      void setEncoding(String value)
      Set a character encoding if it is other than US-ASCII.
      Parameters:
      value - the new value of the 'Encoding' attribute.
      See Also:

    • getId

      BigInteger getId()
      Returns an ID of the referenced field.
      Returns:
      an ID of the referenced field
      See Also:

    • setId

      void setId(BigInteger value)
      Set an ID of the referenced field.
      Parameters:
      value - the new value of the 'Id' attribute.
      See Also:

    • getImplLength

      short getImplLength()
      Returns a fixed length of the field.
      Returns:
      a fixed length of the field
      See Also:

    • setImplLength

      void setImplLength(short value)
      Set a fixed length of the field.
      Parameters:
      value - the new value of the 'Impl Length' attribute.
      See Also:

    • getImplMaxLength

      short getImplMaxLength()
      Returns the maximum length of the field.
      Returns:
      the maximum length of the field
      See Also:

    • setImplMaxLength

      void setImplMaxLength(short value)
      Set the maximum length of the field.
      Parameters:
      value - the new value of the 'Impl Max Length' attribute.
      See Also:

    • getImplMinLength

      short getImplMinLength()
      Returns the minimum length of the field.
      Returns:
      the minimum length of the field
      See Also:

    • setImplMinLength

      void setImplMinLength(short value)
      Set the minimum length of the field.
      Parameters:
      value - the new value of the 'Impl Min Length' attribute.
      See Also:

    • getInstanceName

      String getInstanceName()
      Returns an override for the referenced field's name.
      Returns:
      an override for the referenced field's name
      See Also:

    • setInstanceName

      void setInstanceName(String value)
      Set an override for the referenced field's name.
      Parameters:
      value - the new value of the 'Instance Name' attribute.
      See Also:

    • getLengthId

      BigInteger getLengthId()
      Returns an ID of the associated Length field.
      Returns:
      an ID of the associated Length field
      See Also:

    • setLengthId

      void setLengthId(BigInteger value)
      Set an ID of the associated Length field.
      Parameters:
      value - the new value of the 'Length Id' attribute.
      See Also:

    • getMaxInclusive

      String getMaxInclusive()
      Returns an inclusive upper bound of a valid value range.
      Returns:
      an inclusive upper bound of a valid value range
      See Also:

    • setMaxInclusive

      void setMaxInclusive(String value)
      Set an inclusive upper bound of a valid value range.
      Parameters:
      value - the new value of the 'Max Inclusive' attribute.
      See Also:

    • getMinInclusive

      String getMinInclusive()
      Returns an inclusive lower bound of a valid value range.
      Returns:
      an inclusive lower bound of a valid value range
      See Also:

    • setMinInclusive

      void setMinInclusive(String value)
      Set an inclusive lower bound of a valid value range.
      Parameters:
      value - the new value of the 'Min Inclusive' attribute.
      See Also:

    • getPresence

      Presence getPresence()
      Returns an override for the referenced field's presence. The default value is "optional". The literals are from the enumeration Presence.
      Returns:
      an override for the referenced field's presence
      See Also:

    • setPresence

      void setPresence(Presence value)
      Set an override for the referenced field's presence.
      Parameters:
      value - the new value of the 'Presence' attribute.
      See Also:

    • getRendering

      String getRendering()
      Returns an override for the field's rendering.
      Returns:
      an override for the field's rendering
      See Also:

    • setRendering

      void setRendering(String value)
      Set an override for the field's rendering.
      Parameters:
      value - the new value of the 'Rendering' attribute.
      See Also:

    • getScenario

      String getScenario()
      Returns a scenario of the referenced field. The default value is "base".
      Returns:
      a scenario of the referenced field
      See Also:

    • setScenario

      void setScenario(String value)
      Set a scenario of the referenced field.
      Parameters:
      value - the new value of the 'Scenario' attribute.
      See Also:

    • getValue

      String getValue()
      Returns a default or constant value of the field.
      Returns:
      a default or constant value of the field
      See Also:

    • setValue

      void setValue(String value)
      Set a default or constant value of the field.
      Parameters:
      value - the new value of the 'Value' attribute.
      See Also: