Класс ICSSoft.STORMNET.DataObject

Базовый абстрактный класс, от которого наследуются все объекты данных STORM.NET Подробнее...

Граф наследования:ICSSoft.STORMNET.DataObject:

Открытые члены
void	SetExistObjectPrimaryKey (object primaryKey)
	Установить первичный ключ в объект данных. Выполняется операция Clear() для объекта, присваивается первичный ключ, SetLoadingState(LoadingState.LightLoaded); SetLoadedProperties("__PrimaryKey"); Подробнее...
virtual string	GetPresentationValue ()
	Функция для получения презентационного значения для объекта. Используется, как минимум, в ярлыках на рабочем столе. Подробнее...
void	LockObject (object key)
	Заблокировать объект Подробнее...
void	UnLockObject (object key)
	Разблокировать объект Подробнее...
DetailArray	GetDetailArray ()
	DataObject ()
	Базовый конструктор по-умолчанию Подробнее...
string[]	GetInitializedProperties ()
	Получить проинициализированные свойства, собственные и мастеровые (загруженные+означенные) Подробнее...
string[]	GetInitializedProperties (bool withMasters)
	Получить проинициализированные свойства (загруженные+означенные). Подробнее...
ObjectStatus	GetStatus ()
	Получение статуса Подробнее...
ObjectStatus	GetStatus (bool recountIfAutoaltered)
	Получение статуса (можно отменить автоматическое вычисление статуса) Подробнее...
LoadingState	GetLoadingState ()
	Получение состояния загрузки Подробнее...
virtual void	SetStatus (ObjectStatus newState)
	Установка статуса Подробнее...
void	SetLoadingState (LoadingState newState)
	Установка состояния загрузки. Подробнее...
string[]	GetLoadedProperties ()
	Получение списка свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
List< string >	GetLoadedPropertiesList ()
	Получение списка свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
void	SetLoadedProperties (params string[] loadedProperties)
	Установить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
void	AddLoadedProperties (params string[] addingLoadedProperties)
	Добавить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
void	AddLoadedProperties (List< string > propertyNamesList)
	Добавить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
bool	CheckLoadedProperty (string propertyName)
	Проверить, установлено ли значение в указанное свойство (требуется в случае, когда состояние загрузки – LightLoaded). Подробнее...
void	CopyToObjectWithoutCache (ref DataObject toObject, bool createDataObjectsCopy, bool primaryKeyCopy)
virtual void	CopyTo (DataObject toObject, bool CreateDataObjectsCopy, bool PrimaryKeyCopy, bool UseParentCaching)
	Создать копию этого объекта данных (не забудьте вызвать InitDataCopy или ClearDataCopy если планируете обновлять объект в БД) Подробнее...
virtual void	CopyTo (DataObject toObject, bool CreateDataObjectsCopy, bool PrimaryKeyCopy, bool UseParentCaching, DataObjectCache DataObjectCache)
	Создать копию этого объекта данных (не забудьте вызвать InitDataCopy или ClearDataCopy если планируете обновлять объект в БД) Подробнее...
virtual void	CopySysProps (DataObject toObject)
	Скопировать только системные свойства ("primaryKey", "prototypeKey", "readKey", "CheckDetail", "state", "DisabledInitDataCopy") Подробнее...
virtual void	ClearPrototyping ()
	Сбросить прототипизацию объекта (очистить все что относится к прототипу) Подробнее...
virtual void	ClearPrototyping (bool withDetails)
	Сбросить прототипизацию объекта (очистить все что относится к прототипу) Подробнее...
virtual void	Prototyping ()
	Прототипизировать Подробнее...
virtual void	Prototyping (bool withDetails)
	Прототипизировать Подробнее...
void	DisableInitDataCopy ()
	Не инициализировать копию данных объекта при зачитке. По-умолчанию инициализируется. Подробнее...
void	EnableInitDataCopy ()
	Включить инициализацию копии данных объекта при зачитке. По-умолчанию инициализируется. Подробнее...
void	InitDataCopy ()
	Проинициализировать копию данных Подробнее...
void	InitDataCopy (DataObjectCache DataObjectCache)
	Проинициализировать копию данных Подробнее...
void	clearDataCopy ()
	Очистить внутреннюю копию данных Подробнее...
void	FullClearDataCopy ()
	Очистка внутренней копии данных в собственном объекте, а также рекурсивно копии мастеровых и детейловых объектов Подробнее...
DataObject	GetDataCopy ()
	Получить внутреннюю копию объекта данных Подробнее...
void	SetDataCopy (DataObject value)
	Установить внутреннюю копию объекта данных Подробнее...
string[]	GetAlteredPropertyNames (bool Recount)
	Возвращает список свойств (атрибутов, мастеров, детейлов), чьи значения изменились по сравнению с внутренней копией Подробнее...
string[]	GetAlteredPropertyNames ()
	Возвращает список свойств (атрибутов, мастеров, детейлов), чьи значения изменились по сравнению с внутренней копией Подробнее...
bool	IsAlteredProperty (string propName)
bool	ContainsAlteredProps ()
	Было ли изменение значений свойств по сравнению с внутренней копией Подробнее...
virtual void	Clear ()
	Очистка объекта данных. Остается означеным только первичный ключ и вычислимые свойства (если такая возможность предусмотрена) Объект получает статусы ObjectStatus.UnAltered,LoadingState.NotLoaded Подробнее...
override string	ToString ()
	Преобразуем объект данных в его строковое представление. При этом включаются все свойства объекта, в том числе динамические; нединамические свойства сортируются по алфавиту. Подробнее...
string	ToString (string[] propNames)
	Преобразуем объект данных в его строковое представление. При этом не включаются динамические свойства, свойства сортируются по алфавиту. Подробнее...
string	ToStringForAudit (View stringView)
	Преобразование к строке только по видимым нединамическим свойствам (используется в аудите). При этом не включаются динамические свойства, свойства не сортируются по алфавиту (пишутся по представлению уже так, как пользователь задал). Подробнее...
virtual string[]	CheckNotNullProperties (Dictionary< Type, bool > detailSkip)
	Найти незаполненные поля. Подробнее...
virtual string[]	CheckNotNullProperties ()
	Поискать незаполенные поля. Подробнее...
virtual string[]	CheckNotNullProperties (View view, bool returnCaptions, Dictionary< Type, bool > detailSkip)
	Найти незаполненные поля и вернуть заголовки свойств по представлению. Подробнее...
virtual string[]	CheckNotNullProperties (View view, bool returnCaptions)
	Поискать незаполенные поля и возвращать заголовки свойств по представлению. Подробнее...

Открытые атрибуты
bool	PrimaryKeyIsUnique
	Первичный ключ является уникальным Подробнее...

Статические открытые данные
static GetPresentationValueDelegate	GetPresentationValueDelegate
	Делегат для получения презентационного значения объекта. Если не прописан или возвращает null, то будет использована стандартная логика получения этого значения Подробнее...

Защищенные члены
virtual string	GetDefaultPresentationValue ()
	Функция для получения презентационного значения для объекта по умолчанию. Презентационное значение используется в случаях, когда необходимо каким-либо образом с максимальной степенью адекватности отобразить объект, а средства настройки этого отображения недоступны. Подробнее...
void	CheckReadOnly ()
	Процедура проверки объекта на заблокированность Подробнее...

Защищенные данные
bool	IsDataCopy
	является ли объект копией Подробнее...
bool	bInGetInitializedProperties = false
	Выполняется метод получения проинициализированных свойств public string[] GetInitializedProperties(bool WithMasters) Подробнее...

Свойства
bool	IsReadOnly [get]
	Проверка что объект залочен Подробнее...
Collections.NameObjectCollection	DynamicProperties [get, set]
	Динамические свойства объекта Подробнее...
object	__PrototypeKey [get]
	Ключ прототипа Подробнее...
bool	Prototyped [get]
	Прототипизированный ли объект Подробнее...
virtual object	__PrimaryKey [get, set]
	Установка/получение первичного ключа Подробнее...

Подробное описание

Базовый абстрактный класс, от которого наследуются все объекты данных STORM.NET

Конструктор(ы)

ICSSoft.STORMNET.DataObject.DataObject ( )

inline

Базовый конструктор по-умолчанию

Методы

void ICSSoft.STORMNET.DataObject.AddLoadedProperties ( params string[]  addingLoadedProperties )

inline

Добавить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded).

Аргументы

addingLoadedProperties

Массив добавляемых свойств.

void ICSSoft.STORMNET.DataObject.AddLoadedProperties ( List< string >  propertyNamesList )

inline

Добавить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded).

Аргументы

propertyNamesList

Массив добавляемых свойств.

bool ICSSoft.STORMNET.DataObject.CheckLoadedProperty ( string  propertyName )

inline

Проверить, установлено ли значение в указанное свойство (требуется в случае, когда состояние загрузки – LightLoaded).

virtual string [] ICSSoft.STORMNET.DataObject.CheckNotNullProperties ( Dictionary< Type, bool >  detailSkip )

inlinevirtual

Найти незаполненные поля.

Аргументы

detailSkip

Не обращать внимания на удаленные детейлы. Если детейла нет в этом словаре или значение для него false, то пропущен не будет. Может быть null.

Возвращает

Заголовки свойств незаполненных полей.

virtual string [] ICSSoft.STORMNET.DataObject.CheckNotNullProperties ( )

inlinevirtual

Поискать незаполенные поля.

Возвращает

Заголовки свойств незаполненных полей.

virtual string [] ICSSoft.STORMNET.DataObject.CheckNotNullProperties ( View  view, bool  returnCaptions, Dictionary< Type, bool >  detailSkip  )

inlinevirtual

Найти незаполненные поля и вернуть заголовки свойств по представлению.

Аргументы

view	Представление объекта.
returnCaptions	Если true, то вернутся заголовки свойств, иначе имена.
detailSkip	Не обращать внимания на удаленные детейлы. Если детейла нет в этом словаре или значение для него false, то пропущен не будет. Может быть null.

Возвращает

Заголовки свойств незаполненных полей.

virtual string [] ICSSoft.STORMNET.DataObject.CheckNotNullProperties ( View  view, bool  returnCaptions  )

inlinevirtual

Поискать незаполенные поля и возвращать заголовки свойств по представлению.

Аргументы

view	Представление объекта.
returnCaptions	Возвращать имена свойств или заголовки.

Возвращает

Заголовки свойств незаполненных полей.

void ICSSoft.STORMNET.DataObject.CheckReadOnly ( )

inlineprotected

Процедура проверки объекта на заблокированность

virtual void ICSSoft.STORMNET.DataObject.Clear ( )

inlinevirtual

Очистка объекта данных. Остается означеным только первичный ключ и вычислимые свойства (если такая возможность предусмотрена) Объект получает статусы ObjectStatus.UnAltered,LoadingState.NotLoaded

void ICSSoft.STORMNET.DataObject.clearDataCopy ( )

inline

Очистить внутреннюю копию данных

virtual void ICSSoft.STORMNET.DataObject.ClearPrototyping ( )

inlinevirtual

Сбросить прототипизацию объекта (очистить все что относится к прототипу)

virtual void ICSSoft.STORMNET.DataObject.ClearPrototyping ( bool  withDetails )

inlinevirtual

Сбросить прототипизацию объекта (очистить все что относится к прототипу)

Аргументы

withDetails

с детейлами или без

bool ICSSoft.STORMNET.DataObject.ContainsAlteredProps ( )

inline

Было ли изменение значений свойств по сравнению с внутренней копией

Возвращает

virtual void ICSSoft.STORMNET.DataObject.CopySysProps ( DataObject  toObject )

inlinevirtual

Скопировать только системные свойства ("primaryKey", "prototypeKey", "readKey", "CheckDetail", "state", "DisabledInitDataCopy")

Аргументы

toObject

virtual void ICSSoft.STORMNET.DataObject.CopyTo ( DataObject  toObject, bool  CreateDataObjectsCopy, bool  PrimaryKeyCopy, bool  UseParentCaching  )

inlinevirtual

Создать копию этого объекта данных (не забудьте вызвать InitDataCopy или ClearDataCopy если планируете обновлять объект в БД)

Аргументы

toObject	куда копировать
CreateDataObjectsCopy	создавать ли копии связанных объектов или ограничиться копированием ссылки
PrimaryKeyCopy	Копировать ли первичные ключи
UseParentCaching	Использовать ли вышеустановленное кеширование

virtual void ICSSoft.STORMNET.DataObject.CopyTo ( DataObject  toObject, bool  CreateDataObjectsCopy, bool  PrimaryKeyCopy, bool  UseParentCaching, DataObjectCache  DataObjectCache  )

inlinevirtual

Создать копию этого объекта данных (не забудьте вызвать InitDataCopy или ClearDataCopy если планируете обновлять объект в БД)

Аргументы

toObject	куда копировать
CreateDataObjectsCopy	создавать ли копии связанных объектов или ограничиться копированием ссылки
PrimaryKeyCopy	Копировать ли первичные ключи
UseParentCaching	Использовать ли вышеустановленное кеширование

void ICSSoft.STORMNET.DataObject.CopyToObjectWithoutCache ( ref DataObject  toObject, bool  createDataObjectsCopy, bool  primaryKeyCopy  )

inline

summary> Копирование объектов без применения кэширования /summary> param name="toObject">Объект, в который копируем (если будет null, то создадим по типу исходного)

param name="createDataObjectsCopy">Запускать ли механизм копирования для мастеров и детейлов или ограничиться только своими свойствами (публичными и приватными)

param name="primaryKeyCopy">Копировать ли первичный ключ

param name="usedDobjs">Список объектов, которые уже скопировали - борьба с зацикливанием

void ICSSoft.STORMNET.DataObject.DisableInitDataCopy ( )

inline

Не инициализировать копию данных объекта при зачитке. По-умолчанию инициализируется.

void ICSSoft.STORMNET.DataObject.EnableInitDataCopy ( )

inline

Включить инициализацию копии данных объекта при зачитке. По-умолчанию инициализируется.

void ICSSoft.STORMNET.DataObject.FullClearDataCopy ( )

inline

Очистка внутренней копии данных в собственном объекте, а также рекурсивно копии мастеровых и детейловых объектов

string [] ICSSoft.STORMNET.DataObject.GetAlteredPropertyNames ( bool  Recount )

inline

Возвращает список свойств (атрибутов, мастеров, детейлов), чьи значения изменились по сравнению с внутренней копией

string [] ICSSoft.STORMNET.DataObject.GetAlteredPropertyNames ( )

inline

Возвращает список свойств (атрибутов, мастеров, детейлов), чьи значения изменились по сравнению с внутренней копией

Возвращает

summary> Проверить, есть ли это свойство в списке изменённых. Выполняется полная проверка каждый раз, поэтому метод не очень производительный. /summary> param name="propName">

Если этого свойства нет в объекте, то не упадёт, а просто скажет что оно не менялось, имейте в виду

returns>

DataObject ICSSoft.STORMNET.DataObject.GetDataCopy ( )

inline

Получить внутреннюю копию объекта данных

virtual string ICSSoft.STORMNET.DataObject.GetDefaultPresentationValue ( )

inlineprotectedvirtual

Функция для получения презентационного значения для объекта по умолчанию. Презентационное значение используется в случаях, когда необходимо каким-либо образом с максимальной степенью адекватности отобразить объект, а средства настройки этого отображения недоступны.

Возвращает

string [] ICSSoft.STORMNET.DataObject.GetInitializedProperties ( )

inline

Получить проинициализированные свойства, собственные и мастеровые (загруженные+означенные)

Возвращает

строковый массив имён свойств

string [] ICSSoft.STORMNET.DataObject.GetInitializedProperties ( bool  withMasters )

inline

Получить проинициализированные свойства (загруженные+означенные).

Аргументы

withMasters

Если True, мастеровые учитываются.

Возвращает

Строковый массив имён свойств.

string [] ICSSoft.STORMNET.DataObject.GetLoadedProperties ( )

inline

Получение списка свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded).

List<string> ICSSoft.STORMNET.DataObject.GetLoadedPropertiesList ( )

inline

Получение списка свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded).

Возвращает

LoadingState ICSSoft.STORMNET.DataObject.GetLoadingState ( )

inline

Получение состояния загрузки

virtual string ICSSoft.STORMNET.DataObject.GetPresentationValue ( )

inlinevirtual

Функция для получения презентационного значения для объекта. Используется, как минимум, в ярлыках на рабочем столе.

Возвращает

ObjectStatus ICSSoft.STORMNET.DataObject.GetStatus ( )

inline

Получение статуса

ObjectStatus ICSSoft.STORMNET.DataObject.GetStatus ( bool  recountIfAutoaltered )

inline

Получение статуса (можно отменить автоматическое вычисление статуса)

Аргументы

recountIfAutoaltered

перевычислять если класс с автоматическим вычислением статуса

Возвращает

void ICSSoft.STORMNET.DataObject.InitDataCopy ( )

inline

Проинициализировать копию данных

void ICSSoft.STORMNET.DataObject.InitDataCopy ( DataObjectCache  DataObjectCache )

inline

Проинициализировать копию данных

void ICSSoft.STORMNET.DataObject.LockObject ( object  key )

inline

Заблокировать объект

Аргументы

key	ключ блокировки объекта

virtual void ICSSoft.STORMNET.DataObject.Prototyping ( )

inlinevirtual

Прототипизировать

virtual void ICSSoft.STORMNET.DataObject.Prototyping ( bool  withDetails )

inlinevirtual

Прототипизировать

Аргументы

withDetails

с детейлами или без

void ICSSoft.STORMNET.DataObject.SetDataCopy ( DataObject  value )

inline

Установить внутреннюю копию объекта данных

Аргументы

value

Устанавливаемый объект как копия существующего

void ICSSoft.STORMNET.DataObject.SetExistObjectPrimaryKey ( object  primaryKey )

inline

Установить первичный ключ в объект данных. Выполняется операция Clear() для объекта, присваивается первичный ключ, SetLoadingState(LoadingState.LightLoaded); SetLoadedProperties("__PrimaryKey");

Аргументы

primaryKey

Первичный ключ

void ICSSoft.STORMNET.DataObject.SetLoadedProperties ( params string[]  loadedProperties )

inline

Установить список свойств, значения в которые установлены (требуется в случае, когда состояние загрузки – LightLoaded).

void ICSSoft.STORMNET.DataObject.SetLoadingState ( LoadingState  newState )

inline

Установка состояния загрузки.

virtual void ICSSoft.STORMNET.DataObject.SetStatus ( ObjectStatus  newState )

inlinevirtual

Установка статуса

override string ICSSoft.STORMNET.DataObject.ToString ( )

inline

Преобразуем объект данных в его строковое представление. При этом включаются все свойства объекта, в том числе динамические; нединамические свойства сортируются по алфавиту.

Возвращает

Сформированное строковое представление объекта данных.

string ICSSoft.STORMNET.DataObject.ToString ( string[]  propNames )

inline

Преобразуем объект данных в его строковое представление. При этом не включаются динамические свойства, свойства сортируются по алфавиту.

Аргументы

propNames

Свойства, значения которых будут включены в строковое представление. Если будет передано null, то в результате не будет отображаться ни одно свойство.

Возвращает

Сформированное строковое представление объекта данных.

string ICSSoft.STORMNET.DataObject.ToStringForAudit ( View  stringView )

inline

Преобразование к строке только по видимым нединамическим свойствам (используется в аудите). При этом не включаются динамические свойства, свойства не сортируются по алфавиту (пишутся по представлению уже так, как пользователь задал).

Аргументы

stringView

Представление, по которому нужно создавать строковое представление (берётся видимость полей и заголовки классов). Если передано null, то будут взяты все загруженные свойства и записаны в алфавитном порядке.

Возвращает

Представление объекта данных в виде строки.

void ICSSoft.STORMNET.DataObject.UnLockObject ( object  key )

inline

Разблокировать объект

Аргументы

key	ключ блокировки объекта

Данные класса

bool ICSSoft.STORMNET.DataObject.bInGetInitializedProperties = false

protected

Выполняется метод получения проинициализированных свойств public string[] GetInitializedProperties(bool WithMasters)

GetPresentationValueDelegate ICSSoft.STORMNET.DataObject.GetPresentationValueDelegate

static

Делегат для получения презентационного значения объекта. Если не прописан или возвращает null, то будет использована стандартная логика получения этого значения

bool ICSSoft.STORMNET.DataObject.IsDataCopy

protected

является ли объект копией

bool ICSSoft.STORMNET.DataObject.PrimaryKeyIsUnique

Первичный ключ является уникальным

Полный список свойств

virtual object ICSSoft.STORMNET.DataObject.__PrimaryKey

getset

Установка/получение первичного ключа

object ICSSoft.STORMNET.DataObject.__PrototypeKey

get

Ключ прототипа

Collections.NameObjectCollection ICSSoft.STORMNET.DataObject.DynamicProperties

getset

Динамические свойства объекта

bool ICSSoft.STORMNET.DataObject.IsReadOnly

get

Проверка что объект залочен

bool ICSSoft.STORMNET.DataObject.Prototyped

get

Прототипизированный ли объект