Package com.orchestranetworks.schema

# Interface SchemaDocumentationContext

public interface SchemaDocumentationContext
This class provides the context used for computing the label and description associated with a node in a data model.

See Also:
  - UI Developer Guide

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Locale`
  `getLocale()`
  Returns the current locale, never `null`.
  `Repository`
  `getRepository()`
  Returns the EBX® repository.
  `SchemaNode`
  `getSchemaNode()`
  Returns the node to which this context is attached.
  `Session`
  `getSession()`
  Returns the current session or `null`.
  `UserMessage`
  `getStaticDescription()`
  Returns the description that is statically defined in the data model.
  `UserMessage`
  `getStaticLabel()`
  Returns the label that is statically defined in the data model.

- ## Method Details

  - ### getSchemaNode

    SchemaNode getSchemaNode()
    Returns the node to which this context is attached.

  - ### getRepository

    Repository getRepository()
    Returns the EBX® repository.

  - ### getLocale

    Locale getLocale()
    Returns the current locale, never `null`.

  - ### getSession

    Session getSession()
    Returns the current session or `null`. Returns `null` if the method `SchemaNode.getLabel(java.util.Locale)` or `SchemaNode.getDescription(java.util.Locale)` is being invoked.

  - ### getStaticLabel

    UserMessage getStaticLabel()
    Returns the label that is statically defined in the data model.

  - ### getStaticDescription

    UserMessage getStaticDescription()
    Returns the description that is statically defined in the data model.