Interface ModuleContextBinding


  • public interface ModuleContextBinding
    Returns information on a requirement bound in a module.
    See Also:
    ModuleContext
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      URI getAbout()
      Returns the URI of the underlying requirement bound in a module.
      int getBookOrder()
      Returns the order of the underlying requirement in the list of requirements displayed in the module.
      int getDepth()
      Returns the depth information of the underlying requirement, which determines the number of recursive parents.
      String getFormat()
      Returns the format of the underlying requirement, which can be either Text or Diagram.
      String getIdentifier()
      Returns the identifier of the underlying requirement.
      String getSection()
      Returns the section information of the underlying requirement, e.g.
      String getTitle()
      Returns the title of the underlying requirement.
      boolean isHeading()
      Determines whether the underlying requirement is displayed as a heading.
    • Method Detail

      • getAbout

        URI getAbout()
        Returns the URI of the underlying requirement bound in a module.
        Returns:
        the URI of the underlying requirement bound in a module.
      • getIdentifier

        String getIdentifier()
        Returns the identifier of the underlying requirement.
        Returns:
        the identifier of the underlying requirement.
        See Also:
        Requirement.getIdentifier()
      • getTitle

        String getTitle()
        Returns the title of the underlying requirement.
        Returns:
        the title of the underlying requirement.
        See Also:
        Requirement.getTitle()
      • isHeading

        boolean isHeading()
        Determines whether the underlying requirement is displayed as a heading.
        Returns:
        true if the underlying requirement is displayed as a heading, false otherwise.
      • getFormat

        String getFormat()
        Returns the format of the underlying requirement, which can be either Text or Diagram.
        Returns:
        the format of the underlying requirement, which can be either Text or Diagram.
      • getSection

        String getSection()
        Returns the section information of the underlying requirement, e.g. 1.3.4.
        Returns:
        the section information of the underlying requirement, e.g. 1.3.4.
      • getBookOrder

        int getBookOrder()
        Returns the order of the underlying requirement in the list of requirements displayed in the module.
        Returns:
        the order of the underlying requirement in the list of requirements displayed in the module.
      • getDepth

        int getDepth()
        Returns the depth information of the underlying requirement, which determines the number of recursive parents.
        Returns:
        the depth information of the underlying requirement, which determines the number of recursive parents.