Annotation Interface Document


@Retention(RUNTIME) @Target(TYPE) public @interface Document
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
     
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
     
     
    int
     
     
    Former names of this document (previous name() or tableName() values), so the schema upgrader can rename the existing tables — the document table and its tabular-section tables, keeping their data — instead of creating fresh empty ones.
    Stable DB table name.
    Human-facing display label, distinct from the URL-safe name() identity.
  • Element Details

    • name

      String name
    • title

      String title
      Human-facing display label, distinct from the URL-safe name() identity. Use it for localized or multi-word titles (e.g. "Заказы поставщикам") while keeping name ASCII and space-free so routes stay clean. Surfaces in the UI metadata and is used for nav items, list/detail headings and tab titles. When empty, falls back to name().
      Default:
      ""
    • tableName

      String tableName
      Stable DB table name. When empty, derived from name().
      Default:
      ""
    • previousNames

      String[] previousNames
      Former names of this document (previous name() or tableName() values), so the schema upgrader can rename the existing tables — the document table and its tabular-section tables, keeping their data — instead of creating fresh empty ones. Each value is tried both through the naming strategy and verbatim as a table name. Keep at least the most recent former name until every deployment has migrated.
      Default:
      {}
    • numberLength

      int numberLength
      Default:
      11
    • autoNumber

      boolean autoNumber
      Default:
      true
    • numberPrefix

      String numberPrefix
      Default:
      ""
    • context

      String context
      Default:
      ""