Package com.esprow.oapi.repository

Interface OapiComponentRef

All Superinterfaces:
OapiBaseEntity
All Known Subinterfaces:
OapiGroupRef
public interface OapiComponentRef extends OapiBaseEntity
A reference to a component by its ID and scenario.

The following attributes and references are supported:

  • Method Details

    • getBlockAssignments

      List<OapiBlockAssignment> getBlockAssignments()
      Returns the assignment of fields in group entries.
      Returns:
      the assignment of fields in group entries

    • getRules

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

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

    • getId

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

    • setId

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

    • getInstanceName

      String getInstanceName()
      Returns a name for the second reference to the already referenced component.
      Returns:
      a name for the second reference to the already referenced component
      See Also:

    • setInstanceName

      void setInstanceName(String value)
      Set a name for the second reference to the already referenced component.
      Parameters:
      value - the new value of the 'Instance Name' attribute.
      See Also:

    • getPresence

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

    • setPresence

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

    • getScenario

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

    • setScenario

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