3.2.Описание бизнес-объекта
У бизнес-объекта отображаются следующие свойства:
- Название объекта латиницей. Это полное системное наименование БО.
- Виза Главного Архитектора. Флаг, показывающий согласован БО или нет. Этот флаг могут менять только пользователи, имеющие права роли «Архитектор». Он может быть не установлен, «Ок» и «Отказано».
- Короткое название латиницей. Это краткое системное наименование БО. Используется при формировании наименований методов, событий и наборов данных, если использование полного наименования приводит к превышению ограничений на длину наименования объектов.
- Название на русском. Русское наименование БО.
- Описание. Отображает для чего предназначен выбранный БО, какие функции выполняет.
- Ограничения, предложения и допущения. Ограничения, налагаемые на БО. Не обязательное к заполнению.
3.3.Описание методов
У метода отображаются следующие свойства:
- Имя метода. Это системное наименование метода.
- Виза Главного Архитектора. Флаг, показывающий согласован метод или нет. Этот флаг могут менять только пользователи, имеющие права роли «Архитектор». Он может быть не установлен, «Ок» и «Отказано».
- Реализовано. Флаг, показывающий, реализован метод или нет. Этот флаг может быть установлен пользователями, имеющими права роли «Разработчик», «Аналитик» и «Архитектор».
- Запрещено к использованию. Флаг, показывающий, может ли метод быть использован. Этот флаг может быть установлен пользователями, имеющими права роли «Аналитик» и «Архитектор».
- Для внутреннего использования. Флаг, показывающий, может ли метод быть использован сторонними разработчиками. Этот флаг может быть установлен пользователями, имеющими права роли «Аналитик» и «Архитектор».
- Краткое описание метода. Краткое описание сути выполняемых методом функций.
- Описание работы метода. Подробное описание функционала метода.
- Входящие параметры. Список входящих параметров и наборов данных (p-таблиц).
- Исходящие параметры. Список исходящие параметров и наборов данных (p-таблиц).
- Возвращаемые значения. Список возможных значений, которые может вернуть метод. По умолчанию свернут. Для просмотра всех значений, которые может возвращать метод нужно нажать кнопку в панели «Возвращаемые значения» под списком параметров.
Описание списка входящих и исходящих параметров
В списке отображены следующие свойства параметров:
- Порядок. Порядковый номер параметра в списке.
- Подобъект. Если у БО есть подчиненный объект (например у БО Person есть подобъект Address), то возможно указание, к какому объекту относиться параметр.
- Имя параметра. Системное наименование параметра.
- Тип данных. Тип данных, которые могут быть представлены параметром.
- Обяз. Признак обязательности параметра.
- Краткое описание. Краткое описание, для чего нужен параметр.
- Полное описание. Полное описание, для чего нужен параметр.
В списке параметры сортируются по порядковому номеру.
Описание списка входящих и исходящих наборов данных
Для наглядности наименование набора данных выделяется жирным шрифтом.
В списке отображены следующие свойства наборов данных:
- Порядок. Порядковый номер наборов данных в списке. В списке наборы данных всегда отображаются после отдельных параметров, по этому, порядковый номер первого набора данных превосходит на единицу порядковый номер последнего отдельного параметра.
- Имя параметра. Системное наименование набора данных.
- Тип данных. Всегда проставлен равным «Набор данных».
- Обяз. Признак обязательности набора данных.
- Краткое описание. Краткое описание, для чего нужен набора данных.
- Полное описание. Полное описание, для чего нужен набора данных.
У каждого набора данных отображается список полей. По умолчанью он свернут, чтобы не перегружать информацией вид. Чтобы развернуть список полей набора данных нужно нажать на «+» в самой левой позиции строки набора данных.
В списке полей набора данных отображены следующие свойства:
- Порядок. Порядковый номер поля в списке.
- Обращение (latin). Системное наименование поля.
- Тип данных. Тип данных, которые могут храниться в поле.
- Обяз. Признак обязательности поля.
- Краткое описание. Краткое описание, для чего нужно поле.
- Полное описание. Полное описание, для чего нужно поле.
У каждого набора данных поля сортируются в соответствии со значением свойства «Порядок».
Описание списка возвращаемых значений
В списке возвращаемых значений отображены следующие свойства:
- Код ошибки. Целочисленное значение.
- Описание. Описание ситуации, когда возникает ошибка с соответствующим кодом.
Для того чтобы скрыть список возвращаемых значений нужно нажать кнопку
Описание списка примеров реализации
В списке примеров реализации отображены следующие свойства:
- Контракт. Название контракта.
- Реализация. Пример конкретной реализации вызова метода.
Для того чтобы скрыть список примеров реализации нужно нажать кнопку
|
