Документация iSZN
pkInstance.sql
Ошибки
Error_NoSettingValue
PROCEDURE Error_NoSettingValue(iID PLS_INTEGER);
Описание
Вызывает exception “Значение настройки не задано” по ID настройки.
Параметры:
- iID - ключ настройки.
Error_NoSettingValue
Описание
Вызывает exception “Значение настройки не задано” по её техническому наименованию.
Параметры:
- sName - техническое наименование настройки.
Error_InvalidSettingValue
PROCEDURE Error_InvalidSettingValue(iID PLS_INTEGER, sValue VARCHAR2);
Описание
Вызывает exception “Некорректное значение настройки” по ID настройки.
Параметры:
- iID - ключ настройки;
- sValue - значение настройки.
Error_InvalidSettingValue
Описание
Вызывает exception “Некорректное значение настройки” по её техническому наименованию.
Параметры:
- sName - техническое наименование настройки;
- sValue - значение настройки.
Error_NoRegionalSettingValue
PROCEDURE Error_NoRegionalSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER);
Описание
Вызывает exception “Значение региональной настройки не задано” по ключу региональной настройки.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения.
Error_NoRegionalSettingValue
PROCEDURE Error_NoRegionalSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER);
Описание
Вызывает exception “Значение региональной настройки не задано” по её техническому наименованию.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Error_InvalidRgnSettingValue
PROCEDURE Error_InvalidRgnSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Вызывает exception “Некорректное значение региональной настройки” по ключу настройки.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Error_InvalidRgnSettingValue
PROCEDURE Error_InvalidRgnSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Вызывает exception “Некорректное значение региональной настройки” по её району и техническому
наименованию.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Error_NoInstRgnSettingValue
PROCEDURE Error_NoInstRgnSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER);
Описание
Вызывает exception “Значение региональной настройки экземпляра Системы не задано” по ключу настройки.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения.
Error_NoInstRgnSettingValue
PROCEDURE Error_NoInstRgnSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER);
Описание
Вызывает exception “Значение региональной настройки экземпляра Системы не задано” по её району и техническому
наименованию.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Error_InvalidInstRgnSettingVal
PROCEDURE Error_InvalidInstRgnSettingVal(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Вызывает exception “Некорректное значение региональной настройки экземпляра Системы” по ключу настройки.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Error_InvalidInstRgnSettingVal
PROCEDURE Error_InvalidInstRgnSettingVal(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Вызывает exception “Некорректное значение региональной настройки экземпляра Системы” по её району и техническому
наименованию.
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения.
Проверки
CheckRegionIsAvailable
PROCEDURE CheckRegionIsAvailable(iID PLS_INTEGER);
Описание
Вызывает exception, если текущий пользователь не имеет права создавать записи в районе iID.
Работа с настройками
GetSettingName
FUNCTION GetSettingName(iID PLS_INTEGER, iNameKind PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование настройки по её ID.
Параметры:
- iID - ID настройки;
- iNameKind - вид наименования: 1 - техническое; 2 - отображаемое;
- iStrict - определяет поведение при отсутствии настройки.
GetSettingDispName
FUNCTION GetSettingDispName(sName VARCHAR2, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое наименование настройки по её техническому наименованию (без учёта регистра).
Параметры:
- sName - техническое наименование настройки;
- iStrict - определяет поведение при отсутствии настройки.
LoadInstanceSetting
FUNCTION LoadInstanceSetting(iID PLS_INTEGER) RETURN TInstanceSettingRec;
Описание
Возвращает запись данных настройки по её ID. Если такая настройка не существует, возникает exception.
LoadInstanceSetting
Описание
Возвращает запись данных настройки по её техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetSettingID
FUNCTION GetSettingID(sName VARCHAR2) RETURN PLS_INTEGER;
Описание
Возвращает ID настройки экземпляра по её техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetSettingValue
FUNCTION GetSettingValue(iID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает значение настройки экземпляра по её ID. Если значение настройки не задано, возвращает значение по умолчанию. Если такая настройка не существует, возникает exception.
GetSettingValue
Описание
Возвращает значение настройки экземпляра по её техническому наименованию (без учёта регистра). Если значение настройки не задано, возвращает значение по умолчанию. Если такая настройка не существует, возникает exception.
SetSettingValue
PROCEDURE SetSettingValue(iID PLS_INTEGER, sValue VARCHAR2, iCheckReadOnly PLS_INTEGER := 1);
Описание
Производит запись значения настройки экземпляра её ID. При iCheckReadOnly!=0 при попытке сохранить значение readonly-настройки возникает exception. Если такая настройка не существует, возникает exception.
SetSettingValue
PROCEDURE SetSettingValue(sName VARCHAR2, sValue VARCHAR2, iCheckReadOnly PLS_INTEGER := 1);
Описание
Производит запись значения настройки экземпляра её техническому наименованию (без учёта регистра). При iCheckReadOnly!=0 при попытке сохранить значение readonly-настройки возникает exception. Если такая настройка не существует, возникает exception.
Работа с региональными настройками
GetRegionalSettingName
FUNCTION GetRegionalSettingName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iNameKind PLS_INTEGER, iDisplayMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование региональной настройки по её ID.
Параметры:
- iRegionID, iID - ключ настройки;
- iNameKind - вид наименования: 1 - техническое; 2 - отображаемое;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey;
- iStrict - определяет поведение при отсутствии настройки.
GetRegionalSettingDispName
FUNCTION GetRegionalSettingDispName(iRegionID PLS_INTEGER, sName VARCHAR2, iDisplayMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое наименование региональной настройки по её техническому наименованию (без учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey;
- iStrict - определяет поведение при отсутствии настройки.
LoadRegionalSetting
FUNCTION LoadRegionalSetting(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN TRegionalSettingRec;
Описание
Возвращает запись данных настройки по её ключу. Если такая настройка не существует, возникает exception.
LoadRegionalSetting
FUNCTION LoadRegionalSetting(iRegionID PLS_INTEGER, sName VARCHAR2) RETURN TRegionalSettingRec;
Описание
Возвращает запись данных настройки по её техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetRegionalSettingKey
FUNCTION GetRegionalSettingKey(iRegionID PLS_INTEGER, sName VARCHAR2) RETURN uszn.TRgnKey;
Описание
Возвращает ключ региональной настройки экземпляра по ID её района м техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetRegionalSettingValue
FUNCTION GetRegionalSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sDefaultValue VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает значение региональной настройки экземпляра по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки;
- sDefaultValue - значение, возвращаемое в случае, если значение настройки не задано для указанного района.
Если такая настройка не существует, возникает exception.
GetRegionalSettingValue
FUNCTION GetRegionalSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sDefaultValue VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает значение региональной настройки экземпляра по ID её района м техническому наименованию (без учёта
регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки;
- sDefaultValue - значение, возвращаемое в случае, если значение настройки не задано для указанного района.
Если такая настройка не существует, возникает exception.
GetRegionalSettingValueStr
FUNCTION GetRegionalSettingValueStr(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое значение региональной настройки экземпляра по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки.
Если такая настройка не существует, возникает exception.
GetRegionalSettingValueStr
FUNCTION GetRegionalSettingValueStr(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое значение региональной настройки экземпляра по ID её района м техническому наименованию (без
учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки.
Если такая настройка не существует, возникает exception.
SetRegionalSettingValue
PROCEDURE SetRegionalSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Производит запись значения региональной настройки экземпляра по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки;
- sValue - значение настройки.
Если такая настройка не существует, возникает exception.
SetRegionalSettingValue
PROCEDURE SetRegionalSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Производит запись значения региональной настройки экземпляра по ID её района м техническому наименованию (без
учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки;
- sValue - значение настройки.
Если такая настройка не существует, возникает exception.
Работа с региональными настройками, специфичными для экземпляра Системы
GetInstanceRgnSettingName
FUNCTION GetInstanceRgnSettingName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iNameKind PLS_INTEGER, iDisplayMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование региональной настройки, специфичной для экземпляра Системы, по её ID.
Параметры:
- iRegionID, iID - ключ настройки;
- iNameKind - вид наименования: 1 - техническое; 2 - отображаемое;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey;
- iStrict - определяет поведение при отсутствии настройки.
GetInstanceRgnSettingDispName
FUNCTION GetInstanceRgnSettingDispName(iRegionID PLS_INTEGER, sName VARCHAR2, iDisplayMode PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое наименование региональной настройки, специфичной для экземпляра Системы, по её техническому
наименованию (без учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование instance-specific настройки;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey;
- iStrict - определяет поведение при отсутствии настройки.
LoadInstanceRgnSetting
FUNCTION LoadInstanceRgnSetting(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN TInstanceRgnSettingRec;
Описание
Возвращает запись данных региональной настройки, специфичной для экземпляра Системы, по её ключу. Если такая настройка не существует, возникает exception.
LoadInstanceRgnSetting
FUNCTION LoadInstanceRgnSetting(iRegionID PLS_INTEGER, sName VARCHAR2) RETURN TInstanceRgnSettingRec;
Описание
Возвращает запись данных региональной настройки, специфичной для экземпляра Системы, по её техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetInstanceRgnSettingKey
FUNCTION GetInstanceRgnSettingKey(iRegionID PLS_INTEGER, sName VARCHAR2) RETURN uszn.TRgnKey;
Описание
Возвращает ключ региональной настройки, специфичной для экземпляра Системы, по ID её района м техническому наименованию (без учёта регистра). Если такая настройка не существует, возникает exception.
GetInstanceRgnSettingValue
FUNCTION GetInstanceRgnSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sDefaultValue VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает значение региональной настройки экземпляра, специфичной для экземпляра Системы, по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки;
- sDefaultValue - значение, возвращаемое в случае, если значение настройки не задано для указанного района и его вышестоящих районов.
Если такая настройка не существует, возникает exception.
GetInstanceRgnSettingValue
FUNCTION GetInstanceRgnSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sDefaultValue VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает значение региональной настройки экземпляра, специфичной для экземпляра Системы, по ID её района м
техническому наименованию (без учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки;
- sDefaultValue - значение, возвращаемое в случае, если значение настройки не задано для указанного района и его вышестоящих районов.
Если такая настройка не существует, возникает exception.
GetInstanceRgnSettingValueStr
FUNCTION GetInstanceRgnSettingValueStr(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое значение региональной настройки экземпляра, специфичной для экземпляра Системы, по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки.
Если такая настройка не существует, возникает exception.
GetInstanceRgnSettingValueStr
FUNCTION GetInstanceRgnSettingValueStr(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает отображаемое значение региональной настройки экземпляра, специфичной для экземпляра Системы, по ID её
района м техническому наименованию (без учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки.
Если такая настройка не существует, возникает exception.
SetInstanceRgnSettingValue
PROCEDURE SetInstanceRgnSettingValue(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Производит запись значения региональной настройки экземпляра, специфичной для экземпляра Системы, по её ключу.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района значения настройки;
- sValue - значение настройки.
Если такая настройка не существует, возникает exception.
SetInstanceRgnSettingValue
PROCEDURE SetInstanceRgnSettingValue(iRegionID PLS_INTEGER, sName VARCHAR2, iValueRegionID PLS_INTEGER, sValue VARCHAR2);
Описание
Производит запись значения региональной настройки экземпляра, специфичной для экземпляра Системы, по ID её района м
техническому наименованию (без учёта регистра).
Параметры:
- iRegionID - ID района настройки;
- sName - техническое наименование настройки;
- iValueRegionID - ID района значения настройки;
- sValue - значение настройки.
Если такая настройка не существует, возникает exception.
Декодирование ссылочных свойств
TranslateLookupValue
FUNCTION TranslateLookupValue(sLookupQuery VARCHAR2, iValueRegionID PLS_INTEGER, sValue VARCHAR2, iDecode PLS_INTEGER, sDefault VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает lookup-значение по ключу (iDecode<>0) или наоборот (iDecode=0). Если подходящего значения не найдено или возникла ошибка, возвращает sDefault.
TranslatePickListValue
FUNCTION TranslatePickListValue(sPickList VARCHAR2, sValue VARCHAR2, iDecode PLS_INTEGER, sDefault VARCHAR2 := NULL) RETURN VARCHAR2;
Описание
Возвращает picklist-значение по ключу (iDecode<>0) или наоборот (iDecode=0). Если подходящего значения не найдено или возникла ошибка, возвращает sDefault.
Работа с данными лицензии
UpdateLicenseInfo
Описание
Обновляет информацию о лицензии на основании кода лицензии.
UpdateLicensedOptions
Описание
Обновляет список лицензированных опций в r_product_options на основании списка опций sOptionList; список опций передаётся в виде id1:license_count1,id2:license_count2... список должен быть отсортирован по id.
GetSiteCode
Описание
Возвращает код сервера.
GetLicenseCode
Описание
Возвращает код лицензии.
GetLicenseExpirenessCode
FUNCTION GetLicenseExpirenessCode RETURN PLS_INTEGER;
Описание
Возвращает 0, если срок действия текущей лицензии не истёк. Если срок действия лицензии истёк, возвращает код вида лицензии. Если код лицензии ошибочен, возникает Exception.
GetCustomerName
Описание
Возвращает наименование клиента (null, если оно не определено).
GetCustomerID
FUNCTION GetCustomerID RETURN PLS_INTEGER;
Описание
Возвращает ID клиента (null, если оно не определено).
GetLicenseKind
FUNCTION GetLicenseKind RETURN PLS_INTEGER;
Описание
Возвращает вид установленной серверной лицензии (null, если не определён).
GetServerName
Описание
Возвращает имя текущего сервера.
GetCurrentSnapshotRevision
FUNCTION GetCurrentSnapshotRevision RETURN PLS_INTEGER;
Описание
Возвращает текущую версию среды.
IsOptionAvailable
FUNCTION IsOptionAvailable(iOptionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает доступность указанной опции (0/1). Если вид лицензии - ILicenseKind_Development, доступны все опции.
CheckOptionAvailable
PROCEDURE CheckOptionAvailable(iOptionID PLS_INTEGER);
Описание
Проверяет доступность опции и вызывает exception, если опция недоступна.
GetActualInstanceRgnValueRgnID
FUNCTION GetActualInstanceRgnValueRgnID(iRegionID PLS_INTEGER, iID PLS_INTEGER, iValueRegionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Ищет запись значения настройки экземпляра, специфичной для экземпляра Системы, в заданном районе или одном из
вышестоящих районов.
Параметры:
- iRegionID, iID - ключ настройки;
- iValueRegionID - ID района, для которого осуществляется поиск значения.
Возвращает ID района фактически найденной записи или null, если такого нет.