NsgEnum class
- Inheritance
-
- Object
- NsgDataItem
- NsgEnum
Constructors
- NsgEnum.new({int value = 0, required String name})
Properties
- additionalDataField → String
-
Имя поля для хранения значений дополнительных полейrride
no setterinherited
- allowExtend → bool
-
no setterinherited
- apiDeleteItems → String
-
Get API path for delete Items
no setterinherited
- apiPostItems → String
-
Get API path for posting Items
no setterinherited
- apiRequestItems → String
-
Get API path for request Items
no setterinherited
- createOnServer → bool
-
Признак того: что для создания элемента должно производится на серверной стороне
У объекта на сервере будет вызван метод Create
no setterinherited
- defaultController → NsgBaseController?
-
Контроллер ранных, который будет использоваться по-умолчанию для подбора значений в полях ввода
Может быть перекрыт. Рекомендуется использовать механизм Get.find
no setterinherited
- defaultEditPage → String?
-
Форма элемента для редактирования объектов по умолчанию
Используется в NsgInput, если не задана явно
no setterinherited
- defaultListPage → String?
-
Форма списка для подбора объектов по умолчанию
Используется в NsgInput, если не задана явно
no setterinherited
- docState ↔ NsgDataItemDocState
-
getter/setter pairinherited
- extensionTypeField → String
-
Имя поля, содержащего реальный тип данных
no setterinherited
- fieldList → NsgFieldList
-
Возвращает список полей объекта.
Внимание! это единый список для всех объектов данного типа
no setterinherited
- fieldValues → NsgFieldValues
-
Значения полей объекта
Так как поля обшие, значения храняться в отдельном объекте для экономии памяти
Хранятся только значения, отличные от значений по умолчанию
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id ↔ String
-
Возвращает уникальный идентификатор владельца
getter/setter pairinherited
- isDistributed → bool
-
Это распределенный объект
no setterinherited
- isEmpty → bool
-
Проверяет является ли объект пустым
Внимание! Проверка осуществляется только по значению ключевого поля
Объект будет считалься пустым, если это значение не задано или является нулевым Guid
no setterinherited
- isModified ↔ bool
-
getter/setter pairinherited
- isNotEmpty → bool
-
Проверяет что объект не пустой
Подробности см. в описании свойства isEmpty
no setterinherited
- isReadFromServer ↔ bool
-
Объект прочитан с серверной базы данных
getter/setter pairinherited
- lastChangeTime → DateTime
-
Время последнего изменения объекта
no setterinherited
- lastChangeTimeLocal ↔ DateTime
-
Дата последнего локального изменения
getter/setter pairinherited
- lastChangeTimeServer ↔ DateTime
-
Дата последнего изменения на сервере
getter/setter pairinherited
-
loadReferenceDefault
↔ List<
String> ? -
getter/setter pairinherited
- loadTime ↔ int
-
Время загрузки элемента с сервера. Используется для сравнения элементов: а также,
для удаления устаревших элементов из кэша
getter/setter pairinherited
- name → String
-
final
- ownerId ↔ String
-
Возвращает идентификатор владельца
Используется для привязки строк к табличной части
getter/setter pairinherited
- paramList → NsgParamList
-
Список дополнительных параметров
no setterinherited
- periodFieldName → String
-
Имя поля для фильтрации в контроллере по периоду
Используется, например, в NsgListPage
Если не задано, то считается, что фильтрация по периоду запрещена
no setterinherited
- primaryKeyField ↔ String
-
Возвращает значение ключегого поля (обычно Guid)
getter/setter pairinherited
- remoteProvider ↔ NsgDataProvider
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchFieldList
→ List<
String> -
Список полей, по которым производится текстовый поиск при вводе строки поиска пользователем в фильтре
По умолчанию, поиск идет по всем полям, за исключением нетипизированных ссылок, дат и перечислений
Также из поиска исключено ключевое поле (там практически всегда Guid)
no setterinherited
- state ↔ NsgDataItemState
-
Текущее состояние редактирования объекта (новый, сохранен и т.п.)
getter/setter pairinherited
- storageType ↔ NsgDataStorageType
-
getter/setter pairinherited
- syncStatus ↔ SyncStatus
-
getter/setter pairinherited
- typeName → String
-
no setterinherited
- value → int
-
final
Methods
-
addField(
NsgDataField field, {bool primaryKey = false, String? presentation}) → void -
Добавление ногого поля в объект
Вызывается при инициализации
inherited
-
clone(
{bool cloneAsCopy = false, List< String> ? excludeFields}) → NsgDataItem -
Create new object with same filelds values
cloneAsCopy - после копирования подменить id объектов и вызвать метод заполнения после копирования
inherited
-
copyFieldValues(
NsgDataItem oldItem, {bool cloneAsCopy = false, List< String> ? excludeFields, List<String> ? includeFields, Map<String, String> ? translateMap, bool copyEmptyFields = true, bool onlyMapFields = false}) → void -
Copy fields values from oldItem to this.
inherited
-
copyRecordFill(
) → void -
Заполнение полей объекта при создании копии
inherited
-
equal(
NsgDataItem other) → bool -
inherited
-
fromJson(
Map< String, dynamic> json) → void -
inherited
-
getAll(
) → List< NsgEnum> -
getAllReferenceFields(
) → List< String> -
Возвращает список всех полей ссылочных типов
inherited
-
getById(
{bool autoAuthorize = true, String tag = '', List< String> ? loadReference, String function = '', String method = 'GET', bool addCount = true, dynamic postData, bool autoRepeate = false, int autoRepeateCount = 1000, FutureOr<bool> retryIf(Exception)?, FutureOr<void> onRetry(Exception)?, NsgCancelToken? cancelToken}) → Future -
Прочитать объект из БД по его идентификатору
Можно использовать для обновления объекта из БД или для его дочитывания
inherited
-
getField(
String name) → NsgDataField -
Получить поле объекта по его имени
inherited
-
getFieldByFullPath(
String fullPath) → NsgDataField? -
inherited
-
getFieldValue(
String name, {bool allowNullValue = false}) → dynamic -
Получить значение поля объекта по имени поля
Если значение не присваивалось, то будет возвращено значение по умолчению, если
allowNullValue == false или null, если allowNullValue == true
inherited
-
getFieldValueByFullPath(
String fullPath) → dynamic -
Получить значение поля объекта в том числе, можно обращаться к полям вложенных объектов через точку
Например. playerId.clubId.name
Возвращает значение поля, если оно существует, если нет - возвращает null
В случае, если в чепочке полей не последнее поле будет отличаться от типа NsgDataReferenceField, будет возвращен null
inherited
-
getNewObject(
) → NsgDataItem -
Создание нового экземпляра объекта данного типа
Метод необходим из-за отсутствии рефлексии и невозможности создания объекта по его типу
inherited
-
getReferent<
T extends NsgDataItem?> (String name) → T -
В случае ссылочного поля позвращает объект, на который ссылается данное поле
inherited
-
getReferentAsync<
T extends NsgDataItem> (String name, {bool useCache = true}) → Future< T> -
В случае ссылочного поля позвращает объект, на который ссылается данное поле. Если поле не прочитано из БД, читает его асинхронно
inherited
-
getReferentOrNull<
T extends NsgDataItem?> (String name) → T? -
В случае ссылочного поля позвращает объект, на который ссылается данное поле
Допускает возврат null, если ссылка не задана
inherited
-
initialize(
) → void -
Инициализация объекта. Создание всех полей. Выполняется один раз при запуске программы при построении всех объектов
override
-
isEqual(
NsgDataItem other, {List< String> ? excludeFields}) → bool -
Сравнивает равенство значений всех полей текущего с other
Используется, например, при проверке изменился лит объект в процессе редактирования.
Для этого, перед началом редактирования, можно сделать копию объекта с помощью метода Clone
inherited
-
isFieldRequired(
String fieldName) → bool -
Проверка является ли поле с именем fieldName обязательным к заполнению пользователем
inherited
-
isReferenceField(
String name) → bool -
Приверка является ли поле ссылкой на другой объект (ссылочный тип)
inherited
-
newRecord(
) → void -
Новая запись в БД
По факту: создает новый Guid ключевому полю
Если ключевое поле заполнено не нулевым Guid, будет сгенерирована ошибка
inherited
-
newRecordFill(
) → void -
Заполнение полей объекта при создании нового
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
post(
) → Future -
Сохранение объекта в БД
В случае успеха, поля текущего объекта будут заполнены полями объекта из БД
inherited
-
postItems(
List< NsgDataItem> itemsToPost, {bool showProgress = false}) → Future -
Сохранение объектов в БД
В случае успеха, поля объектов будут заполнены полями объектов из БД
inherited
-
removeItem(
) → Future -
inherited
-
select<
T extends NsgDataItem> (NsgDataRequestParams filter, {int autoRepeateCount = 3, List< String> ? loadReference, NsgCancelToken? cancelToken, NsgDataStorageType storageType = NsgDataStorageType.server}) → Future<List< T> > -
Получить все объекты из БД, удовлетворящие условию
inherited
-
selectFromDb<
T extends NsgDataItem> ({int autoRepeateCount = 3, List< String> ? referenceList, NsgCancelToken? cancelToken}) → Future<T> -
Прочитать элемент из базы данных
Чтение идет по ID
inherited
-
setFieldEmpty(
String name) → void -
Пометить поле пустым, т.е. что оно не загружалось из БД
inherited
-
setFieldValue(
String name, dynamic value) → void -
Установить значение поля
inherited
-
toJson(
{List< String> excludeFields = const []}) → Map<String, dynamic> -
Запись полей объекта в JSON
inherited
-
toString(
) → String -
A string representation of this object.
override
-
validateFieldValues(
{NsgBaseController? controller}) → NsgValidateResult -
Метод проверки правильности запорлненности всех полей объекта перед его сохранением
Если не перекрыт, проверяет заполненнойсть полей, помеченных как обязательные.
Поле считается пустым, если его значение равно значению по умолчанию для этого поля
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
String name) → dynamic -
inherited
-
operator []=(
String name, dynamic value) → void -
inherited