Package com.esprow.oapi.repository

Interface OapiComponent

All Superinterfaces:
OapiBaseEntity
public interface OapiComponent extends OapiBaseEntity
A sequence of fields and nested components: common blocks or repeating groups.

The following attributes and references are supported:

  • Method Details

    • getAllElements

      MixedContent getAllElements()
      Returns a list of all elements present within the container.
      Returns:
      a list of all elements present within the container

    • getComponentRefs

      List<OapiComponentRef> getComponentRefs()
      Returns a list of references to components.
      Returns:
      a list of references to components

    • getGroupRefs

      List<OapiGroupRef> getGroupRefs()
      Returns a list of references to groups.
      Returns:
      a list of references to groups

    • getFieldRefs

      List<OapiFieldRef> getFieldRefs()
      Returns a list of references to fields.
      Returns:
      a list of references to fields

    • 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:

    • getAbbrName

      String getAbbrName()
      Returns an abbreviated name of the component.
      Returns:
      an abbreviated name of the component
      See Also:

    • setAbbrName

      void setAbbrName(String value)
      Set an abbreviated name of the component.
      Parameters:
      value - the new value of the 'Abbr Name' attribute.
      See Also:

    • getCategory

      String getCategory()
      Returns a category of the component.
      Returns:
      a category of the component
      See Also:

    • setCategory

      void setCategory(String value)
      Set a category of the component.
      Parameters:
      value - the new value of the 'Category' attribute.
      See Also:

    • getId

      BigInteger getId()
      Returns a unique numeric identifier.
      Returns:
      a unique numeric identifier
      See Also:

    • setId

      void setId(BigInteger value)
      Set a unique numeric identifier.
      Parameters:
      value - the new value of the 'Id' attribute.
      See Also:

    • getName

      String getName()
      Returns a unique name of the component.
      Returns:
      a unique name of the component
      See Also:

    • setName

      void setName(String value)
      Set a unique name of the component.
      Parameters:
      value - the new value of the 'Name' attribute.
      See Also:

    • getRendering

      String getRendering()
      Returns a hint on how to generate or render an element in a user interface.
      Returns:
      a hint on how to generate or render an element in a user interface
      See Also:

    • setRendering

      void setRendering(String value)
      Set a hint on how to generate or render an element in a user interface.
      Parameters:
      value - the new value of the 'Rendering' attribute.
      See Also:

    • getScenario

      String getScenario()
      Returns a use case of the component. The default value is "base".
      Returns:
      a use case of the component
      See Also:

    • setScenario

      void setScenario(String value)
      Set a use case of the component.
      Parameters:
      value - the new value of the 'Scenario' attribute.
      See Also:

    • getWhich

      Member getWhich()
      Returns the switching mode for the mutually exclusive elements. The literals are from the enumeration Member.
      Returns:
      the switching mode for the mutually exclusive elements
      See Also:

    • setWhich

      void setWhich(Member value)
      Set the switching mode for the mutually exclusive elements.
      Parameters:
      value - the new value of the 'Which' attribute.
      See Also: