Entity — различия между версиями

Текущая версия на 12:05, 26 октября 2015

Класс

Entity

Поддерживает документацию

да

Поддерживает extras

да

Сущность (Entity) представляет собой SQL-таблицу, либо фиктивную таблицу, предназначенную для создания пунктов меню. Каждая сущность относится к одному из модулей. Сущность имеет следующие свойства:

• name — имя. Соответствует имени SQL-таблицы и используется внутри модели для ссылок на данную сущность.
• icon — ссылка на иконку для отображения в меню.
• type — тип сущности. Имеется пять типов:
  • table — обычная таблица
  • collection — коллекция
  • genericCollection — обобщённая коллекция
  • dictionary — справочник
  • metadata — таблица с метаданными (используется только для внутренних таблиц BeanExplorer
• displayName — отображаемое имя. Имя сущности, которое выводится в пользовательском интерфейсе. Может быть дополнительно изменено через локализации.
• order — двузначное число, задающее порядок сущности в меню (чем больше, тем ниже сущность располагается в меню).
• primaryKey — первичный ключ таблицы (для фиктивных сущностей обычно используется _dummy_)

В определение сущности входит схема, операции и представления. Также есть возможность использовать шаблон для сущности.

Пример простой фиктивной сущности в Yaml:

_myMenuItem_:
  type: table
  displayName: Основное меню
  order: '29'
  primaryKey: _dummy_
  queries:
  - Главная таблица:
      type: static
      roles: [Operator,PaymentOperator,ServiceOperator,Reception]
      value: 'myTable.redir'

Пример сущности-справочника с представлением Selection view и без операций:

myDictionary:
  type: table
  displayName: Мой справочник
  primaryKey: CODE
  scheme:
    columns:
    - CODE:
        type: VARCHAR(30)
        primaryKey: true
    - name:
        type: VARCHAR(255)
  queries:
  - '*** Selection view ***':
      code: SELECT CODE AS "Code", name AS "Name" FROM myDictionary