Flexberry ORM 8.0.0-beta01
Класс ICSSoft.STORMNET.FunctionalLanguage.FunctionDef

Определение функции. Подробнее...

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

Открытые члены

 FunctionDef (int ID, ObjectType returnType, string objStringedView, string objCaption, string userViewFormat)
 конструктор. Подробнее...
 
 FunctionDef (int ID, ObjectType returnType, string objStringedView, string objCaption, string userViewFormat, params FunctionParameterDef[] parameters)
 конструктор. Подробнее...
 
 FunctionDef (int ID, ObjectType returnType, string objStringedView, string objCaption, string userViewFormat, bool FreeQuery, params FunctionParameterDef[] parameters)
 конструктор. Подробнее...
 
- Открытые члены унаследованные от ICSSoft.STORMNET.FunctionalLanguage.TypedObject
 TypedObject ()
 конструктор. Подробнее...
 
 TypedObject (ObjectType objType, string objStringedView, string objCaption)
 конструктор. Подробнее...
 
- Открытые члены унаследованные от ICSSoft.STORMNET.FunctionalLanguage.ViewedObject
 ViewedObject ()
 конструктор. Подробнее...
 
 ViewedObject (string objStringedView, string Caption)
 конструктор. Подробнее...
 
- Открытые члены унаследованные от 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)
 Поискать незаполенные поля и возвращать заголовки свойств по представлению. Подробнее...
 

Свойства

int ID [get, set]
 Целочисленный ключ определения функции. Подробнее...
 
bool FreeQuery [get]
 Влияет на генерацию SQL-запроса. Если true, то добавляются все поля. Подробнее...
 
ObjectType ReturnType [get]
 Тип возвращаемого значения. Подробнее...
 
DetailArrayOfFunctionalParameterDef Parameters [get]
 Параметры функции. Подробнее...
 
string UserViewFormat [get]
 формат отображения пользователю (используется на форме задания ограничений). Подробнее...
 
FunctionalLanguageDef Language [get, set]
 Язык ограничений, в рамках которого существует данное определение функции (язык включает все определения как детейлы). Подробнее...
 
- Свойства унаследованные от ICSSoft.STORMNET.FunctionalLanguage.TypedObject
virtual ObjectType Type [get, set]
 ObjectType-тип. Подробнее...
 
- Свойства унаследованные от ICSSoft.STORMNET.FunctionalLanguage.ViewedObject
virtual string StringedView [get, set]
 Строковое представление. Подробнее...
 
virtual string Caption [get, set]
 Заголовок. Подробнее...
 
- Свойства унаследованные от ICSSoft.STORMNET.DataObject
bool IsReadOnly [get]
 Проверка что объект залочен. Подробнее...
 
Collections.NameObjectCollection?? DynamicProperties [get, set]
 Динамические свойства объекта. Подробнее...
 
object __PrototypeKey [get]
 Ключ прототипа. Подробнее...
 
bool Prototyped [get]
 Прототипизированный ли объект. Подробнее...
 
virtual object __PrimaryKey [get, set]
 Установка/получение первичного ключа. Подробнее...
 

Дополнительные унаследованные члены

- Открытые атрибуты унаследованные от ICSSoft.STORMNET.DataObject
bool PrimaryKeyIsUnique
 Первичный ключ является уникальным. Подробнее...
 
- Статические открытые данные унаследованные от ICSSoft.STORMNET.DataObject
static GetPresentationValueDelegate GetPresentationValueDelegate
 Делегат для получения презентационного значения объекта. Если не прописан или возвращает null, то будет использована стандартная логика получения этого значения. Подробнее...
 
- Защищенные члены унаследованные от ICSSoft.STORMNET.DataObject
virtual string GetDefaultPresentationValue ()
 Функция для получения презентационного значения для объекта по умолчанию. Презентационное значение используется в случаях, когда необходимо каким-либо образом с максимальной степенью адекватности отобразить объект, а средства настройки этого отображения недоступны. Подробнее...
 
void CheckReadOnly ()
 Процедура проверки объекта на заблокированность. Подробнее...
 
- Защищенные данные унаследованные от ICSSoft.STORMNET.DataObject
bool IsDataCopy
 является ли объект копией. Подробнее...
 
bool bInGetInitializedProperties = false
 Выполняется метод получения проинициализированных свойств public string[] GetInitializedProperties(bool WithMasters). Подробнее...
 

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

Определение функции.

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

◆ FunctionDef() [1/3]

ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.FunctionDef ( int  ID,
ObjectType  returnType,
string  objStringedView,
string  objCaption,
string  userViewFormat 
)
inline

конструктор.

Аргументы
ID
returnType
objStringedView
objCaption
objImagedView
userViewFormat

◆ FunctionDef() [2/3]

ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.FunctionDef ( int  ID,
ObjectType  returnType,
string  objStringedView,
string  objCaption,
string  userViewFormat,
params FunctionParameterDef[]  parameters 
)
inline

конструктор.

Аргументы
ID
returnType
objStringedView
objCaption
objImagedView
userViewFormat
parameters

◆ FunctionDef() [3/3]

ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.FunctionDef ( int  ID,
ObjectType  returnType,
string  objStringedView,
string  objCaption,
string  userViewFormat,
bool  FreeQuery,
params FunctionParameterDef[]  parameters 
)
inline

конструктор.

Аргументы
ID
returnType
objStringedView
objCaption
objImagedView
userViewFormat
FreeQuery
parameters

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

◆ FreeQuery

bool ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.FreeQuery
get

Влияет на генерацию SQL-запроса. Если true, то добавляются все поля.

◆ ID

int ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.ID
getset

Целочисленный ключ определения функции.

◆ Language

FunctionalLanguageDef ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.Language
getset

Язык ограничений, в рамках которого существует данное определение функции (язык включает все определения как детейлы).

◆ Parameters

DetailArrayOfFunctionalParameterDef ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.Parameters
get

Параметры функции.

◆ ReturnType

ObjectType ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.ReturnType
get

Тип возвращаемого значения.

◆ UserViewFormat

string ICSSoft.STORMNET.FunctionalLanguage.FunctionDef.UserViewFormat
get

формат отображения пользователю (используется на форме задания ограничений).