PROCEDURE Error_InvalidDocClass(iClassID PLS_INTEGER);

Вызывает ошибку «Класс документа не найден».

PROCEDURE Error_InvalidCollClass(iClassID PLS_INTEGER);

Вызывает ошибку «Класс коллектива не найден».

PROCEDURE Error_InvalidPDocFileKind(iFileKindID PLS_INTEGER);

Вызывает ошибку «Вид файла персонального документа не найден».

PROCEDURE Error_InvalidPCFileKind(iFileKindID PLS_INTEGER);

Вызывает ошибку «Вид файла человека/коллектива не найден».

PROCEDURE Error_NoDocInstance(iRegionID PLS_INTEGER, iDIID PLS_INTEGER);

Вызывает ошибку «Экземпляр документа не найден».

PROCEDURE Error_NoDocInstanceReq(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает ошибку «Реквизит документа не найден».

PROCEDURE Error_NoPDocFile(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает ошибку «Файл персонального документа не существует».

PROCEDURE Error_NoPCFile(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает ошибку «Файл человека/коллектива не существует».

PROCEDURE Error_PCDoesDotExist(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает ошибку «Человек/коллектив не существует».

PROCEDURE Error_NotACollInstance(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает ошибку «Запись ... не является экземпляром коллектива».

PROCEDURE Error_NotAPerson(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает ошибку «Запись ... не является экземпляром человека».

PROCEDURE Error_NoMainPersonIdentity(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает ошибку «Основной ДУЛ человека не задан».

PROCEDURE Error_PDocIsNotIdentity(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER);

Вызывает ошибку «Документ не является документом, удостоверяющим личность».

PROCEDURE Error_MultipleDocClassInstance(iDocClassID PLS_INTEGER);

Вызывает exception «Нельзя создавать более одного экземпляра документа данного класса».

PROCEDURE Error_NoDocReqWithAttrib(iDocClassID PLS_INTEGER, iAttribID PLS_INTEGER);

Вызывает ошибку «В документе ... отсутствуют реквизиты с атрибутом...».

PROCEDURE Error_TooManyDocReqsWithAttrib(iDocClassID PLS_INTEGER, iAttribID PLS_INTEGER);

Вызывает ошибку «В документе ... имеется несколько реквизитов с атрибутом...».

PROCEDURE Error_NoDocReqValue(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER);

Вызывает ошибку «Значение реквизита экземпляра персонального документа не найдено».

PROCEDURE Error_TooManyDocReqValues(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER);

Вызывает ошибку «Несколько значений реквизита экземпляра персонального документа».

PROCEDURE Error_NoPCReqValue(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER);

Вызывает ошибку «Отсутствует значение реквизита у человека/коллектива».

PROCEDURE Error_TooManyPCReqValues(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER);

Вызывает ошибку «Слишком много значений реквизита у человека/коллектива».

PROCEDURE Error_NoPCDocInstance(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iDocClassID PLS_INTEGER);

Вызывает ошибку «Отсутствует экземпляр документа у человека/коллектива».

PROCEDURE Error_TooManyPCDocInstances(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iDocClassID PLS_INTEGER);

Вызывает ошибку «Слишком много экземпляров документа у человека/коллектива».

PROCEDURE Error_ReqsFromDifferentDocs(iReqClassIDs uszn.TIntegerList);

Вызывает ошибку «Реквизиты ... принадлежат разным документам».

PROCEDURE Error_NotADocument(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является документом».

PROCEDURE Error_NotAStorage(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является ни документом, ни таблицей».

PROCEDURE Error_NotATable(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является таблицей».

PROCEDURE Error_NotAReq(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является реквизитом».

PROCEDURE Error_NotATableReq(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является табличным реквизитом».

PROCEDURE Error_NotALookupReq(iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является lookup-реквизитом».

PROCEDURE Error_NotAChildReqClass(iOwnerClassID PLS_INTEGER, iClassID PLS_INTEGER);

Вызывает ошибку «Элемент структуры персонального документа не является дочерним элементом...».

PROCEDURE Error_StorageWithoutReqs(iClassID PLS_INTEGER);

Вызывает ошибку «Документ или таблица не содержит реквизитов».

PROCEDURE CheckPDocClassOwnerValid(iOwnerClassID PLS_INTEGER, iClassID PLS_INTEGER);

Проверяет, что указанный элемент структуры документа является дочерним у заданного владельца. Если нет, то возникает exception.

FUNCTION GetUserGroupPCPrivs(iUserGroupID PLS_INTEGER, iIsPermission PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает привилегии группы пользователей на работу с данными людей/коллективов.
Параметры:

• iUserGroupID - ID группы пользователей;
  
• iIsPermission - какой вид привилегий требуется получить: 0 - запрещение, 1 - разрешение.
  

Возвращает набор указанных привилегий в виде битовой маски. Если привилегии отсутствуют, возвращает 0.

PROCEDURE SetUserGroupPCPrivs(iUserGroupID PLS_INTEGER, iPermittedPrivs PLS_INTEGER, iRestrictedPrivs PLS_INTEGER);

Устанавливает привилегии группы пользователей на работу с данными людей/коллективов.
Параметры:

• iUserGroupID - ID группы пользователей;
  
• iPermittedPrivs - набор разрешений в виде битовой маски;
  
• iRestrictedPrivs - набор запрещений в виде битовой маски.

FUNCTION GetPCUserPrivs(sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;

Возвращает привилегии указанного пользователя на работу с данными людей/коллективов в виде битовой маски.

PROCEDURE CheckPCPrivs(iPrivs PLS_INTEGER, sOperation VARCHAR2 := NULL);

Проверяет, что у текущего пользователя есть все указанные привилегии на работу с данными людей/коллективов.
Параметры:

• iPrivs - сумма битовых флагов проверяемых привилегий.

FUNCTION GetUserGroupPDocPrivs(iUserGroupID PLS_INTEGER, iPDocClassID PLS_INTEGER, iPrivSubjectID PLS_INTEGER, iIsPermission PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает привилегии группы пользователей на экземпляры документов указанного класса.
Параметры:

• iUserGroupID - ID группы пользователей;
  
• iPDocClassID - ID класса персонального документа;
  
• iPrivSubjectID - ID субъекта предоставления привилегий;
  
• iIsPermission - какой вид привилегий требуется получить: 0 - запрещение, 1 - разрешение.
  

Возвращает набор указанных привилегий в виде битовой маски. Если привилегии отсутствуют, возвращает 0.

PROCEDURE SetUserGroupPDocPrivs(iUserGroupID PLS_INTEGER, iPDocClassID PLS_INTEGER, iPrivSubjectID PLS_INTEGER, iIsPermission PLS_INTEGER, iPrivileges PLS_INTEGER);

Устанавливает привилегии группы пользователей на экземпляры документов указанного класса.
Параметры:

• iUserGroupID - ID группы пользователей;
  
• iPDocClassID - ID класса персонального документа;
  
• iPrivSubjectID - ID субъекта предоставления привилегий;
  
• iIsPermission - какой вид привилегий требуется получить: 0 - запрещение, 1 - разрешение.
  
• iPrivileges - набор привилегий в виде битовой маски.

FUNCTION GetMinPDocClassUserPrivs(iPDocClassID PLS_INTEGER, sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;

Возвращает набор минимальных привилегий указанного пользователя на экземпляры документов заданного класса в виде битовой маски.

FUNCTION GetMaxPDocClassUserPrivs(iPDocClassID PLS_INTEGER, sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;

Возвращает максимальные привилегии указанного пользователя на экземпляры документов заданного класса в виде битовой маски.

FUNCTION GetDocInstanceUserPrivs(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;

Возвращает привилегии указанного пользователя на экземпляр документа в виде битовой маски.

PROCEDURE CheckMinPDocClassPrivs(iPDocClassID PLS_INTEGER, iPrivs PLS_INTEGER, sOperation VARCHAR2 := NULL);

Проверяет, есть ли право у текущего пользователя на выполнение операций с любыми документами заданного класса.
Параметры:

• iPDocClassID - ID класса документа;
  
• iPrivs - набор привилегий в виде битовой маски; если хоть какой-нибудь привилегии нет, возникает exception;
  
• sOperation - наименование выполняемой операции для отображения в сообщении об ошибке.

PROCEDURE CheckMaxPDocClassPrivs(iPDocClassID PLS_INTEGER, iPrivs PLS_INTEGER, sOperation VARCHAR2 := NULL);

Проверяет, есть ли право у текущего пользователя на выполнение операций хоть с какими-нибудь документами заданного
класса.
Параметры:

• iPDocClassID - ID класса документа;
  
• iPrivs - набор привилегий в виде битовой маски; если хоть какой-нибудь привилегии нет, возникает exception;
  
• sOperation - наименование выполняемой операции для отображения в сообщении об ошибке.

PROCEDURE CheckDocInstancePrivs(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iPrivs PLS_INTEGER, sOperation VARCHAR2 := NULL);

Проверяет, есть ли право у текущего пользователя на выполнение операций с экземпляром документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iPrivs - набор привилегий в виде битовой маски; если хоть какой-нибудь привилегии нет, возникает exception;
  
• sOperation - наименование выполняемой операции для отображения в сообщении об ошибке.

PROCEDURE CheckDocInstanceReqValuesAvail(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER);

Проверяет доступность значений реквизитов данного экземпляра персонального документа для просмотра. Пока проверяем только право на просмотр наличия и просмотр значений реквизитов экземпляров документов, на которые ссылаются реквизиты типа «Ссылка на экземпляр документа».

PROCEDURE CheckLookupIsNotUsed(iRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iLookupValueID PLS_INTEGER, sEntityName VARCHAR2);

Проверяет, что в персональных документах отсутствуют lookup-реквизиты с указанным значением, помеченные указанным
атрибутом. Если такие реквизиты имеются, вызывает exception со списком классов документов, содержащих реквизит.
Параметры:

• iRegionID - ID района персональных документов;
  
• iAttribID - ID атрибута проверяемых реквизитов;
  
• iLookupValueID - ID значения lookup-реквизита;
  
• sEntityName - наименование сущности (используется в сообщении об ошибке).

PROCEDURE CheckLookupEntityIsNotUsed(iRegionID PLS_INTEGER, iEntityID PLS_INTEGER, iLookupValueID PLS_INTEGER);

Проверяет, что в персональных документах отсутствуют lookup-реквизиты с указанным значением сущности.
Если такие реквизиты имеются, вызывает exception со списком классов документов, содержащих реквизит.
Параметры:

• iRegionID - ID района персональных документов;
  
• iEntityID - ID сущности, используемой при импорте XML-дампов людей/коллективов;
  
• iLookupValueID - ID значения lookup-реквизита;
  
• sLookupName - наименование lookup-реквизита (используется в сообщении об ошибке).

FUNCTION GetPDocTableLevel(iClassID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает уровень вложенности таблицы для указанного реквизита.

FUNCTION GetDocClassName(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает наименование класса документа iID.

FUNCTION GetDocClassAbbrName(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает краткое (или полное, если краткое отсутствует) наименование класса документа iID.

FUNCTION DocInstanceExists(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN PLS_INTEGER;

Проверяет, существует ли экземпляр персонального документа. Возвращает 1, если существует, в противном случае 0.

PROCEDURE CheckDocInstanceExists(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Проверяет существование экземпляра персонального документа; при отсутствии такого экземпляра вызывает exception.

FUNCTION GetDocInstanceClass(iDocInstanceID PLS_INTEGER, iRegionID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN PLS_INTEGER;

Возвращает ID класса экземпляра документа iDocInstanceID. iStrict определяет поведение при отсутствии экземпляра документа.

FUNCTION GetDocInstancePC(iDocInstanceID PLS_INTEGER, iRegionID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN PLS_INTEGER;

Возвращает ID человека/коллектива, являющегося владельцем документа iDocInstanceID. iStrict определяет поведение при отсутствии экземпляра документа.

PROCEDURE GetDocInstanceClassAndPC(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iDocClassID OUT PLS_INTEGER, iPeopleCollID OUT PLS_INTEGER, iStrict PLS_INTEGER := 1);

Возвращает в out-параметрах ID класса экземпляра документа iDocInstanceID, а также ID его владельца. iStrict определяет поведение при отсутствии экземпляра документа.

PROCEDURE GetDocInstanceClassAndOwners(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iDocClassID OUT PLS_INTEGER, iPeopleCollID OUT PLS_INTEGER, sOwnerUser OUT VARCHAR2, rOwnerUserGroupGUID OUT RAW, iStrict PLS_INTEGER := 1);

Возвращает в out-параметрах сведения об экземпляре персонального документа.
Входные параметры:

• iRegionID, iDocInstanceID - ключ экземпляра;
  

Выходные параметры:

• iDocClassID - ID класса документа;
  
• iPeopleCollID - ID человека/коллектива - владельца документа;
  
• sOwnerUser - имя пользователя-владельца;
  
• rOwnerUserGroupGUID - GUID группы-владельца.
  

iStrict определяет поведение при отсутствии экземпляра документа.

FUNCTION GetDocInstanceID(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iDocClassID PLS_INTEGER, iStrictNotFound PLS_INTEGER, iStrictMultiple PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает ID экземпляра персонального документа для указанного человека/коллектива.
Параметры:

• iRegionID, iPCID - ключ человека/коллектива;
  
• iDocClassID - ID класса документа;
  
• iStrictNotFound - определяет поведение при отсутствии экземпляра документа;
  
• iStrictMultiple - определяет поведение при наличии более одного экземпляра документа.

FUNCTION GetDocInstanceIDsByReqValue(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iDocClassID PLS_INTEGER, ssRecValues IN uszn.pkGen.TStrings255) RETURN uszn.TIntegerList;

Возвращает список ID экземпляров документов с заданными значениями реквизитов.
Параметры:

• iRegionID, iPCID - ключ человека/коллектива, у которого ищутся документы;
  
• iDocClassID - ID класса документа;
  
• ssRecValues - список значений поисковых реквизитов; индекс - ID класса, значение - искомое значение.

FUNCTION GetPDocIDsByReqValueForRegion(iRegionID PLS_INTEGER, iDocClassID PLS_INTEGER, ssRecValues IN uszn.pkGen.TStrings255, iOwnerClassID PLS_INTEGER := NULL) RETURN uszn.TIntegerList;

Возвращает список ID экземпляров документов с заданными значениями реквизитов.
Параметры:

• iRegionID - район, в котором ищутся документы;
  
• iDocClassID - ID класса документа;
  
• ssRecValues - список значений поисковых реквизитов; индекс - ID класса, значение - искомое значение;
  
• iOwnerClassID - ID класса владельца (null - все люди и коллективы, 0 - люди, иначе коллективы с таким ID класса).

FUNCTION GetLastDocInstanceID(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iDocClassID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN PLS_INTEGER;

Возвращает максимальный ID экземпляра документа класса iDocClassID для человека/коллектива iPCID. iStrict определяет поведение при отсутствии экземпляра документа.

FUNCTION GetDocNameByReq(iReqClassID PLS_INTEGER) RETURN VARCHAR2;

Возвращает наименование класса документа по его реквизиту iReqClassID.

FUNCTION GetDocReqName(iReqClassID PLS_INTEGER, iIncludeDocName PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает полное наименование реквизита документа. При iIncludeDocName=0 наименование самого документа не включается в строку результата.

FUNCTION GetFullDocReqName(iReqClassID PLS_INTEGER, iIncludeStorageName PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает полное наименование реквизита документа, раскрученное до ближайшего хранилища (таблицы или документа). При iIncludeStorageName=0 наименование самого документа (таблицы) не включается в строку результата.

FUNCTION GetDocReqClassID(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает ID класса реквизита документа. iStrict определяет поведение при отсутствии указанного реквизита.

FUNCTION GetDocReqClassIDByAttrib(iDocClassID PLS_INTEGER, iAttribID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN PLS_INTEGER;

Возвращает class_id реквизита документа, имеющего заданный атрибут.
Параметры:

• iDocClassID - ID класса элемента структуры документов, для которого (у него и среди его дочерних реквизитов) осуществляется поиск;
  
• iAttribID - ID атрибута;
  
• iStrict - определяет поведение при отсутствии такого реквизита и при неоднозначном соответствии.

FUNCTION DocClassHasAttrib(iDocClassID PLS_INTEGER, iAttribID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает, имеет ли указанный элемент структуры документа заданный атрибут.
Параметры:

• iDocClassID - ID класса элемента структуры документов, для которого осуществляется поиск;
  
• iAttribID - ID атрибута;
  
• iStrict - определяет поведение при отсутствии такого элемента структуры.
  

Если атрибут имеется, возвращает 1, иначе 0.

FUNCTION GetPDocUniqueKeyReqIDs(iStorageClassID PLS_INTEGER) RETURN uszn.TIntegerList;

Возвращает список ID реквизитов документа или таблицы документа, использующиеся для его уникальной идентификации
(отмеченные атрибутом PDCA_REQ_UNIQUE_KEY). Если таких реквизитов нет, возвращает пустой список.
Параметры:

• iStorageClassID - ID класса документа или таблицы документа, среди реквизитов которого выполняется поиск.

FUNCTION GetDocClsIDByReq(iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает ID класса документа по его реквизиту iReqClassID. iStrict определяет поведение при отсутствии реквизита заданного класса.

FUNCTION GetDocClsIDByReqs(iReqClassIDs uszn.TIntegerList) RETURN PLS_INTEGER;

Возвращает ID класса документа, к которому принадлежат все реквизиты iReqClassID.

FUNCTION GetPDocTableClsIDForReq(iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает ID класса таблицы, содержащей реквизит iReqClassID. Если реквизит не находится в таблице или отсутствует, поведение определяется параметром iStrict.

FUNCTION GetStorageClassID(iReqClassID PLS_INTEGER, iSkipLevelCount PLS_INTEGER := 0) RETURN PLS_INTEGER;

То же самое, что GetPDocTableClsIDForReq, но для нетабличных реквизитов возвращает ID класса документа.
iSkipLevelCount - количество пропускаемых уровней хранилища, т.е.:

• 0 - возвращается class_id хранилища, содержащего реквизит iReqClassID
  
• 1 - возвращается class_id хранилища, в котором находится хранилище, содержащее реквизит iReqClassID
  
• и т.д.
  

Если хранилища соответствующего уровня нет, возвращает null.

FUNCTION GetPDocTablePrimaryReqClsID(iTableClassID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает class_id первичного реквизита таблицы. iStrict определяет поведение при отсутствии таблицы с таким классом, а также при отсутствии в таблице реквизитов.

FUNCTION GetPDocTableReqIDs(iTableClassID PLS_INTEGER) RETURN uszn.TIntegerList;

Возвращает список ID классов реквизитов указанной таблицы персонального документа.

PROCEDURE CheckCanAddDocInstance(iRegionID PLS_INTEGER, iPeopleCollID PLS_INTEGER, iDocClassID PLS_INTEGER, iCheckUniqueness PLS_INTEGER);

Проверяет, что текущий пользователь имеет право создать персональный документ. При iCheckUniqueness!=0 также проверяет, что документ вводится впервые или допускает повторения для человека/коллектива.

PROCEDURE LockDocInstance(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iNoWait PLS_INTEGER, iLockReqs PLS_INTEGER := 1, iLockFiles PLS_INTEGER := 1);

Блокирует указанный экземпляр персонального документа.
Параметры:

• iRegionID, iPDocID - ключ экземпляра документа, который необходимо заблокировать;
  
• iNoWait - если !=0, то при неудачной попытке блокировки возникает exception;
  
• iLockReqs - блокировать ли реквизиты документа (0/1);
  
• iLockFiles - блокировать ли файлы, связанные с экземпляром документа (0/1).
  

Если экземпляр документа не существует, возникает exception.

PROCEDURE LockPDocReqs(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iWait PLS_INTEGER);

Блокирует реквизиты экземпляра персонального документа. При iWait=0 при неудачной попытке блокировки возникает exception. Если документ не существует, ничего не происходит.

FUNCTION AllocateNewPDocID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает новый свободный ID экземпляра персонального документа.

PROCEDURE AddDocInstance(iRegionID PLS_INTEGER, iID PLS_INTEGER, iPeopleCollID PLS_INTEGER, iDocClassID PLS_INTEGER, iCheckUniqueness PLS_INTEGER);

Создаёт запись экземпляра персонального документа.
Параметры:

• iRegionID, iID - ключ создаваемого экземпляра документа;
  
• iPeopleCollID - ID владельца документа;
  
• iDocClassID - ID класса документа;
  
• iCheckUniqueness - проверять ли отсутствие других экземпляров документов данного класса, если наличие нескольких экземпляров не допускается (0/1).
  

Процедура является «низкоуровневой»: НЕ ВЫЗЫВАЕТ триггеров документов и НЕ СОЗДАЁТ записей в истории документа.

FUNCTION CreateDocInstance(iRegionID PLS_INTEGER, iPeopleCollID PLS_INTEGER, iDocClassID PLS_INTEGER, iCheckUniqueness PLS_INTEGER := 1) RETURN PLS_INTEGER;

Создаёт запись экземпляра персонального документа и возвращает его ID.
Параметры:

• iRegionID - ID района;
  
• iPeopleCollID - ID владельца документа;
  
• iDocClassID - ID класса документа;
  
• iCheckUniqueness - проверять ли отсутствие других экземпляров документов данного класса, если наличие нескольких экземпляров не допускается (0/1).
  

Функция является «низкоуровневой»: НЕ ВЫЗЫВАЕТ триггеров документов и НЕ СОЗДАЁТ записей в истории документа.

PROCEDURE DeletePCRefReqs(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iEntireRows PLS_INTEGER, iForPeopleCollID PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL);

Удаляет реквизиты документов, ссылающиеся на указанного человека.
Параметры:

• iRegionID, iPCID - ключ человека;
  
• iEntireRows - удалять ли строки таблицы документа целиком, если это табличные реквизиты (0/1);
  
• iForPeopleCollID - ID человека/коллектива, среди документов которого производить удаление (null - у всех);
  
• iAudOriginID - ID источника события для аудита;
  
• sAudNotes - примечания для аудита.

PROCEDURE BeforeDocInstanceAdd(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iClassID PLS_INTEGER);

Вызывает событие на добавление нового экземпляра персонального документа.

PROCEDURE AfterDocInstanceAdd(iRegionID PLS_INTEGER, iDIID PLS_INTEGER);

PROCEDURE BeforeDocInstanceChange(iRegionID PLS_INTEGER, iDIID PLS_INTEGER);

Вызывает событие на изменения экземпляра персонального документа.

PROCEDURE AfterDocInstanceChange(iRegionID PLS_INTEGER, iDIID PLS_INTEGER);

PROCEDURE BeforeDocInstanceDelete(iRegionID PLS_INTEGER, iDIID PLS_INTEGER, iDeletingPC PLS_INTEGER := 0);

Вызывает событие на удаление экземпляра персонального документа

• iDeletingPC=1, если удаление документа вызвано удалением его владельца.

PROCEDURE AfterDocInstanceDelete(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iClassID PLS_INTEGER, iDeletingPC PLS_INTEGER := 0);

FUNCTION TransferDocInstanceToPC(iRegionID PLS_INTEGER, iDIID PLS_INTEGER, iNewPCID PLS_INTEGER, iOriginID PLS_INTEGER, iDoCopy PLS_INTEGER, iStrictUniqueness PLS_INTEGER) RETURN PLS_INTEGER;

Переносит или копирует экземпляр документа.
Параметры:

• iRegionID, iDIID - ключ исходного документа;
  
• iNewPCID - ID нового владельца (может совпадать с текущим владельцем);
  
• iOriginID - ID источника операции перемещения;
  
• iDoCopy - Если 0, то переносит документ; если не 0, то копирует;
  
• iStrictUniqueness: Если 0, то всегда создаёт документ, независимо от наличия у нового владельца таких документов; Если 1, то при попытке добавить второй и все последующие экземпляры документа, не позволяющего создания более одного экземпляра, вызывает exception; Если 2, то, если документ не позволяет иметь несколько экземпляров, то удаляет все существующие экземпляры документа, кроме одного, а этот единственный заменяет на скопированный.
  

Возвращает:

• при создании нового экземпляра документа - ID созданного экземпляра документа;
  
• при сохранении существующего экземпляра документа - ID исходного экземпляра документа.

FUNCTION CloneDocInstance(iRegionID PLS_INTEGER, iDIID PLS_INTEGER, iOriginID PLS_INTEGER) RETURN PLS_INTEGER;

Клонирует экземпляр персонального документа. Возвращает ID созданного экземпляра.
Параметры:

• iRegionID, iDIID - ключ клонируемого экземпляра документа;
  
• iOriginID - ID источника операции.
  

Если класс документа не допускает создания нескольких экземпляров, возникает exception.

PROCEDURE ReplacePCRefReqs(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iReqClassID PLS_INTEGER, iOldValue PLS_INTEGER, iNewValue PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL);

Заменяет значения ссылочных реквизитов типа “человек/коллектив” в экземпляре персонального документа.
Параметры:

• iRegionID, iPDocID - ключ экземпляра документа, в котором производится замена;
  
• iReqClassID - ID класса реквизита; если null, замена производится во всех реквизитах-ссылках на человека/коллектив;
  
• iOldValue - старое значение (ID человека/коллектива);
  
• iNewValue - новое значение (ID человека/коллектива);
  
• iAudOriginID - ID источника события для аудита;
  
• sAudNotes - примечания для аудита.
  

Если документ не найден, пользователь не имеет необходимых привилегий, класс реквизита не существует или не является
ссылкой на человека/коллектив или человек с новым ID не существует, возникает exception.

FUNCTION GetPDocFileKindName(iFileKindID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Возвращает наименование вида файла документа по его ID.

PROCEDURE LockPDocFiles(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iWait PLS_INTEGER);

Блокирует файлы, связанные с экземпляром персонального документа. При iWait=0 при неудачной попытке блокировки возникает exception. Если документ не существует, ничего не происходит.

FUNCTION AllocateNewPDocFileID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает новый свободный ID файла персонального документа.

PROCEDURE AddPDocFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPDocID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Обновляет файл персонального документа.
-- Параметры:
--   iRegionID, iID - ключ обновляемого файла персонального документа;
--   iPDocID        - ID экземпляра персонального документа;
--   iFileKindID    - ID вида файла;
--   sDesc          - описание файла;
--   iFileID        - ID файла в таблице файлов (null, если содержимое файла не меняется);
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE UpdatePDocFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPDocID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Удаляет файл персонального документа. Если файл больше нигде не используется, он также удаляется.
-- Параметры:
--   iRegionID, iID - ключ файла персонального документа;
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE DeletePDocFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);

Создаёт файл персонального документа. При создании проверяются привилегии пользователя и ведётся аудит.
Параметры:

• iRegionID, iID - ключ создаваемого файла персонального документа;
  
• iPDocID - ID экземпляра персонального документа;
  
• iFileKindID - ID вида файла;
  
• sDesc - описание файла;
  
• iFileID - ID файла в таблице файлов;
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

PROCEDURE UpdatePDocFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPDocID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Удаляет файл персонального документа. Если файл больше нигде не используется, он также удаляется.
-- Параметры:
--   iRegionID, iID - ключ файла персонального документа;
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE DeletePDocFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
 
/*********************************************************************************************************************
 Коллективы
*********************************************************************************************************************/
 
-- Устанавливает новый порядковый номер для класса коллектива iClassID: если iInsertAfter=0, то перед iNewClassID, иначе - после iNewClassID
PROCEDURE SetNewCollClassOrder(iClassID PLS_INTEGER, iNewClassID PLS_INTEGER, iInsertAfter PLS_INTEGER);
-- Удаляет класс коллектива iClassID из дерева, перенумеровывая остаток классов
PROCEDURE DeleteCollClass(iClassID PLS_INTEGER);
-- Возвращает наименование класса коллектива
FUNCTION  GetCollClassName(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Обновляет файл персонального документа.
Параметры:

• iRegionID, iID - ключ обновляемого файла персонального документа;
  
• iPDocID - ID экземпляра персонального документа;
  
• iFileKindID - ID вида файла;
  
• sDesc - описание файла;
  
• iFileID - ID файла в таблице файлов (null, если содержимое файла не меняется);
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

PROCEDURE DeletePDocFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);

Удаляет файл персонального документа. Если файл больше нигде не используется, он также удаляется.
Параметры:

• iRegionID, iID - ключ файла персонального документа;
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

PROCEDURE SetNewCollClassOrder(iClassID PLS_INTEGER, iNewClassID PLS_INTEGER, iInsertAfter PLS_INTEGER);

Устанавливает новый порядковый номер для класса коллектива iClassID: если iInsertAfter=0, то перед iNewClassID, иначе - после iNewClassID.

PROCEDURE DeleteCollClass(iClassID PLS_INTEGER);

Удаляет класс коллектива iClassID из дерева, перенумеровывая остаток классов.

FUNCTION GetCollClassName(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает наименование класса коллектива.

FUNCTION GetCollClassType(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает ID типа класса коллектива (0-папка, 1-коллектив, 2-роль).

FUNCTION GetCollClassHelpContext(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

Возвращает контекст справки для класса коллектива iID.

FUNCTION GetFullCollClassName(iID PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает полное наименование класса коллектива iID. Для папки и коллектива это будет их наименование; для роли -

• наименование класса коллектива/наименование роли.

PROCEDURE CheckIsPerson(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает exception, если запись r_people_and_colls не существует или не является человеком.

PROCEDURE CheckIsCollInstance(iRegionID PLS_INTEGER, iPCID PLS_INTEGER);

Вызывает exception, если запись r_people_and_colls не существует или не является коллективом.

FUNCTION GetCollInstanceClass(iCollID PLS_INTEGER, iRegionID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN PLS_INTEGER;

Возвращает ID класса экземпляра коллектива iCollID. Если коллектив не существует, поведение определяется iStrict.

FUNCTION GetCollInstanceClsName(iCollID PLS_INTEGER, iRegionID PLS_INTEGER, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает наименование класса экземпляра коллектива iCollID.

FUNCTION IsPDocCompatibleWithColl(iPDocClassID PLS_INTEGER, iCollRoleClassID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает 1, если документ, к которому относится реквизит, совместим с указанным классом коллектива (роли). Если iCollRoleClassID=0, проверяется совместимость с отдельным индивидом. В противном случае возвращает 0.

FUNCTION IsDocReqForPeople(iDocClsID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает 1, если документ, к которому относится реквизит, совместим с отдельным индивидом или ролями в коллективах, в противном случае возвращает 0.

FUNCTION IsDocReqForColl(iDocClsID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает 1, если документ, к которому относится реквизит, совместим с коллективами, в противном случае возвращает 0.

FUNCTION PCExists(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN PLS_INTEGER;

Проверяет, существует ли человек/коллектив. Возвращает 1, если существует, в противном случае 0.

PROCEDURE CheckPCExists(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Проверяет, существует ли человек/коллектив, и если нет, то возникает exception.

FUNCTION IsColl(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict INTEGER := 0) RETURN PLS_INTEGER;

Возвращает 1, если iID - коллектив, иначе 0.

• Если нет такой записи о человеке/коллективе, то при iStrict=0 возвращает null, при =1 вызывает Exception.

FUNCTION AllocateNewPCID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает новый свободный ID человека/коллектива.

PROCEDURE AddManOrColl(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iIsCollInstance PLS_INTEGER, iCollClassID PLS_INTEGER := NULL);

Создаёт запись для человека или коллектива. Если iIsCollInstance=1, то должен быть задан класс коллектива iCollClassID.

PROCEDURE DeletePC(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iCheckLastRole PLS_INTEGER := 1, iDelRefReqs PLS_INTEGER := 1, sNotes VARCHAR2 := NULL);

Удаляет запись человека или коллектива из R_PEOPLE_AND_COLLS, если у него нет назначений и он не получатель какой-либо выплаты. При iCheckLastRole=1 удаляет также все коллективы, где больше не остаётся ролей. Если iDelRefReqs=1, то удаляет также все реквизиты документов, ссылающиеся на человека.

FUNCTION IsCollWithCloseRelations(iRegionID PLS_INTEGER, iCollID PLS_INTEGER, iStrict INTEGER := 0) RETURN PLS_INTEGER;

Возвращает 1, если коллектив iRegionID-iCollID представляет собой коллектив с родственными отношениями.

FUNCTION GetReqLookupList(iReqClassID PLS_INTEGER, iRegionID PLS_INTEGER, iPCID PLS_INTEGER) RETURN uszn.TValueIDObjList;

Выполняет lookup_sql для реквизита и возвращает список VALUE-VOBJ.

FUNCTION GetTopRawValues(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iTopCount PLS_INTEGER := NULL) RETURN uszn.TStringList255;

Возвращает список наиболее часто встречающихся значений реквизита.
Параметры:

• iRegionID - ID района;
  
• iReqClassID - ID класса реквизита;
  
• iTopCount - ограничение на количество возвращаемых значений; bnull - нет ограничений.

PROCEDURE SetMainPersonIdentity(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER, iDocInstanceID PLS_INTEGER);

Задаёт основной документ, удостоверяющий личность человека. При изменении текущего значения выполняется пересчёт
кеша персональных реквизитов, зависящих от него.
Параметры:

• iRegionID - ID района;
  
• iPersonID - ID человека;
  
• iDocInstanceID - ID экземпляра документа, который должен стать документом, удостоверяющим личность.

FUNCTION GetMainPersonIdentity(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает doc_instance_id основного документа, удостоверяющего личность человека. Если основной ДУЛ не задан, поведение определяется параметром iStrict.

FUNCTION GetBirthDate(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER) RETURN DATE;

Возвращает дату рождения человека iPersonID.

FUNCTION GetDeathDate(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER) RETURN DATE;

Возвращает дату смерти человека iPersonID.

FUNCTION GetSex(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает пол человека iPersonID: 0=муж., 1=жен.

FUNCTION GetCloseDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER) RETURN DATE;

Возвращает дату снятия человека/коллектива iPCID с учёта.

FUNCTION GetPersonalReq(iRegionID PLS_INTEGER, iPeopleID PLS_INTEGER, iReqType PLS_INTEGER) RETURN VARCHAR2;

Возвращает для человека iPeopleID, если iReqType =

• 0: Фамилия
  
• 1: Имя
  
• 2: Отчество
  
• 3: Дата рождения
  
• 4: Пол (0=муж., 1=жен.)
  
• 5: Дата смерти
  
• 6: Гражданство
  
• 7: Место рождения
  
• 8: ID Населённый пункт адреса регистрации
  
• 9: ID Улица адреса регистрации
  

10: Дом адреса регистрации
11: Корпус адреса регистрации
12: Квартира адреса регистрации
13: Дата «С» последнего периода адреса регистрации
14: Дата «По» последнего периода адреса регистрации
15: Собранный адрес регистрации
16: Населённый пункт адреса регистрации (декодированный)
17: Улица адреса регистрации (декодированная)
18: Документ, удостоверяющий личность (внешний ID по справочнику соответствия, вид соответствия PersonalReq_IdentityTypes, ID=66)
19: Серия ДУЛ
20: Номер ДУЛ
21: Наименование документа, удостоверяющего личность
22: Кем выдан документ, удостоверяющий личность
23: Дата выдачи документа, удостоверяющего личность
24: Дата снятия с учёта в органах соцзащиты
25: СНИЛС (с форматированием)
26: СНИЛС (без форматирования).

FUNCTION DescribeManColl(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iMode PLS_INTEGER, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Описывает человека или коллектив на основе их документов.
Для коллектива:

• iMode=0 - полное описание;
  
• iMode=1 - краткое описание.
  

Если функция описания коллектива отсутствует, выводит список членов коллектива (не более трёх).
Для человека:

• iMode=0 - возвращает [Фамилия Имя Отчество + дата рождения + дата смерти]
  
• iMode=1 - возвращает [Фамилия И. О.]
  
• iMode=2 - возвращает [Фамилия Имя Отчество]
  
• iMode=3 - возвращает [Ключ + (Фамилия Имя Отчество + дата рождения + дата смерти)]
  

При отсутствии человека/коллектива поведение определяется параметром iStrict.

FUNCTION GetShortCollMemberList(iRegionID PLS_INTEGER, iCollID PLS_INTEGER, iRoleClassID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает краткий список членов коллектива без учёта периодов пребывания. Если в составе коллектива больше 3
человек, возвращает ФИО первых трёх и текст “и др.”.
Параметры:

• iRegionID, iCollID - ключ коллектива;
  
• iRoleClassID - ID класса возвращаемой роли; null - возвращаются все роли;
  
• iStrict - определяет поведение при отсутствии такого коллектива.

FUNCTION ReqValueDecode(iRegionID PLS_INTEGER, iPeopleCollID PLS_INTEGER, iReqClassID PLS_INTEGER, sValue VARCHAR2, iStrict PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает декодированное значение реквизита ссылочного типа на основе его списка выбора.
Для пустого значения возвращает null (без проверок на существование класса реквизита).
Значения нессылочного типа возвращает без изменения.
Параметры:

• iRegionID, iPeopleCollID - ключ владельца документа;
  
• iReqClassID - ID класса реквизита;
  
• sValue - значение реквизита;
  
• iStrict - определяет поведение при возникновении любых ошибок.

FUNCTION ReqValueDecode(iRegionID PLS_INTEGER, iReqID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Возвращает декодированное значение реквизита ссылочного типа на основе его списка выбора по его ключу.
Параметры:

• iRegionID, iReqID - ключ реквизита;
  
• iStrict - определяет поведение при возникновении любых ошибок.

PROCEDURE SetRawDocReqValue(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1);

Записывает значение нетабличного реквизита персонального документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iReqClassID - ID класса реквизита;
  
• sValue - значение реквизита (null, если реквизит удаляется);
  
• iCheckValueValidity - проверять ли корректность сохраняемого значения (0/1).

PROCEDURE SetRawDocReqValueEx(PDocChange IN OUT NOCOPY TPDocDataChange, iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1);

Аналогична pkPerson.SetRawDocReqValue, но с автоматическим учётом изменений.

FUNCTION SetRawDocEnReqValue(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1) RETURN PLS_INTEGER;

Записывают значение табличного реквизита персонального документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iReqClassID - ID класса реквизита;
  
• iOwnerID - ID записи первичного реквизита вышестоящей таблицы (null для таблиц верхнего уровня);
  
• iOrderNum - порядковый номер строки таблицы;
  
• sValue - значение реквизита (null, если реквизит удаляется);
  
• iCheckValueValidity - проверять ли корректность сохраняемого значения (0/1).
  

Функции возвращают ID созданного/обновлённого/удалённого реквизита.
Следует учитывать, что автоматическая перенумерация строк при удалении пореквизитно всей строки не производится,
следовательно, в нумерации по order_num при этом появятся “дырки”.

PROCEDURE SetRawDocEnReqValue(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1);

FUNCTION SetRawDocEnReqValueEx(PDocChange IN OUT NOCOPY TPDocDataChange, iRowAction PLS_INTEGER, iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1) RETURN PLS_INTEGER;

Аналогичны pkPerson.SetRawDocEnReqValue, но с автоматическим учётом изменений.
Дополнительные параметры:

• PDocChange - информация об изменениях в реквизитах документа;
  
• iRowAction - действие, выполняемое над строкой таблицы: 1 - добавление, 2 - изменение, 3 - удаление.

PROCEDURE SetRawDocEnReqValueEx(PDocChange IN OUT NOCOPY TPDocDataChange, iRowAction PLS_INTEGER, iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iReqClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, sValue VARCHAR2, iCheckValueValidity PLS_INTEGER := 1);

FUNCTION DeletePDocTableTrailingRows(iOwnerID PLS_INTEGER, iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER) RETURN PLS_INTEGER;

Удаляет все строки таблицы документа с номером свыше iOrderNum. iReqClassID может быть как классом табличного реквизита, так и классом самой таблицы или контейнера, содержащего реквизиты данной таблицы. Функция возвращает количество удалённых реквизитов.

PROCEDURE DeletePDocTableTrailingRows(iOwnerID PLS_INTEGER, iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER);

FUNCTION GetPDocTableRowCount(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iTableClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iStartOrderNum PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает количество строк в таблице экземпляра персонального документа
Параметры:

• iRegionID, iPDocID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы;
  
• iOwnerID - ID первичного реквизита вышестоящей таблицы (null для таблиц верхнего уровня);
  
• iStartOrderNum - минимальный порядковый номер строки, начиная с которого выполняется подсчёт.

PROCEDURE DeleteDocInstance(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);

Удаляет экземпляр документа.
Параметры:

• iRegionID, iPDocID - ключ удаляемого документа;
  
• iOriginID - ID источника операции удаления;
  
• sNotes - примечания к операции удаления.

PROCEDURE SetDocInstanceOwners(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, sOwnerUser VARCHAR2, rOwnerUserGroupGUID RAW, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL, iStrict PLS_INTEGER := 0);

Выполняет замену пользователя-владельца и группы-владельца экземпляра персонального документа.
Параметры:

• iRegionID, iPDocID - ключ удаляемого документа;
  
• sOwnerUser - новый пользователь-владелец;
  
• rOwnerUserGroupGUID - новая группа-владелец;
  
• iOriginID - ID источника операции удаления;
  
• sNotes - примечания к операции удаления;
  
• iStrict - определяет поведение при отсутствии экземпляра документа.

FUNCTION GetRawDocReqValue(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает значение реквизита iReqClassID для документа iDocInstanceID. Если возникли проблемы, поведение определяется параметром iStrict.

FUNCTION GetRawDocReqValueByAttrib(iRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает значение реквизита для документа iDocInstanceID по его атрибуту. Если возникли проблемы, поведение определяется параметром iStrict.

FUNCTION GetRawDocReqValuesConcatCLOB(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN CLOB;

Возвращает сконкатенированные значения реквизита из всех строк таблицы.

FUNCTION GetRawDocReqValuesConcat(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

То же самое, но с ограничением максимальной суммарной длины результата до 4000 символов.

PROCEDURE SetRawDocReqValuesConcatCLOB(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, cValue IN CLOB);

Сохраняет сконкатенированные значения реквизита из всех строк таблицы.

PROCEDURE SetRawDocReqValuesConcat(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, sValue VARCHAR2);

FUNCTION GetDocReqValue(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает декодированное значение реквизита iReqClassID для документа iDocInstanceID. Если возникли проблемы при получении значения или при его декодировании, поведение определяется параметром iStrict.

FUNCTION GetDocReqValueByAttrib(iRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN VARCHAR2;

То же, для реквизита с атрибутом iAttribID.

FUNCTION GetDocReqValueDate(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN DATE;

Возвращают типизированные значения реквизитов iReqClassID для документов iDocInstanceID. Если возникли проблемы, поведение определяется параметром iStrict. Если значение реквизита получено, но не может быть без ошибки приведено к указанному типу, возвращает null.

FUNCTION GetDocReqValueInt(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN PLS_INTEGER;

FUNCTION GetDocReqValueNumber(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iStrict PLS_INTEGER := 0) RETURN NUMBER;

FUNCTION GetRawDocReqValues(iRegionID PLS_INTEGER, iDIID PLS_INTEGER, iiReqClassIDs IN uszn.TIntegerList, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, iInitMissingValues PLS_INTEGER := 0) RETURN uszn.pkGen.TStrings255;

Возвращает список значений реквизитов документа.
Параметры:

• iRegionID, iDIID - ключ документа;
  
• iiReqClassIDs - список ID классов реквизитов;
  
• iOrderNum - порядковый номер строки документа (0 для скалярных реквизитов);
  
• iOwnerID - ID записи первичного реквизита строки родительской таблицы (null для скалярных реквизитов и таблиц первого уровня);
  
• iInitMissingValues - инициализировать ли отсутствующие реквизиты значением null (0/1).
  

В возвращаемом результате индекс - ID класса реквизита, значение - его значение.

FUNCTION GetDocReqValueID(iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL) RETURN PLS_INTEGER;

Возвращает ID значения реквизита iReqClassID для документа iDocInstanceID человека/коллектива (если значения реквизита нет, возвращает null).

FUNCTION GetPDocTablePrimaryReqID(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iTableClassID PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL) RETURN PLS_INTEGER;

Возвращает ID первичного реквизита строки таблицы персонального документа.
Параметры:

• iRegionID, iPDocID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы;
  
• iOrderNum - порядковый номер строки, для которой требуется найти ID;
  
• iOwnerID - ID первичного реквизита вышестоящей таблицы (null для таблиц верхнего уровня).
  

Если реквизит не найден, возвращает null.

FUNCTION GetEnReqCount(iOwnerID PLS_INTEGER, iRegionID PLS_INTEGER, iReqClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает максимальный ORDER_NUM таблицы, содержащей реквизит класса iReqClassID.

FUNCTION GetPDocHTMLContent(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iShowNestedTables PLS_INTEGER := 1, iStrict PLS_INTEGER := 0, iShowToggleIcon PLS_INTEGER := 1) RETURN CLOB;

Возвращает текст документа в виде HTML на основе значений его реквизитов.

FUNCTION ListDocReqValuesScalar(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iStrict PLS_INTEGER, iMode PLS_INTEGER) RETURN VARCHAR2;

Возвращает список значений скалярных реквизитов экземпляра документа.
Параметры:

• iRegionID, iPDocID - ключ экземпляра документа;
  
• iStrict - определяет поведение при отсутствии документа;
  
• iMode - режим вывода списка: 0 - значения реквизитов без их наименований; 1 - значения реквизитов с краткими наименованиями реквизитов; 2 - значения реквизитов с полными наименованиями реквизитов.

FUNCTION ListUniqueDocKeyReqs(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iStrict PLS_INTEGER, iMode PLS_INTEGER) RETURN VARCHAR2;

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

• iRegionID, iPDocID - ключ экземпляра документа;
  
• iStrict - определяет поведение при отсутствии документа;
  
• iMode - режим вывода списка: 0 - значения реквизитов без их наименований; 1 - значения реквизитов с краткими наименованиями реквизитов; 2 - значения реквизитов с полными наименованиями реквизитов.
  

Если таких реквизитов нет, возвращает пустое значение.

FUNCTION DescribeDocInstance(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iStrict PLS_INTEGER, iMode PLS_INTEGER, iClassNameMode PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает стандартное описание экземпляра документа.

• iStrict - если 1, требует существования экземпляра документа
  
• iMode - режим вывода описания: 0 - значения реквизитов без их наименований 1 - значения реквизитов с краткими наименованиями реквизитов 2 - значения реквизитов с полными наименованиями реквизитов
  
• iClassNameMode - режим вывода наименования класса документа: 0 - не выводить 1 - предварять описание содержимого кратким наименованием класса, а само описание заключить в скобки 2 - предварять описание содержимого полным наименованием класса, а само описание заключить в скобки.

FUNCTION GetRawPCReqValue(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0, iCheckMultiple PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает недекодированное значение скалярного реквизита iReqClassID для человека/коллектива iPCID.
Если реквизит отсутствует, поведение определяется параметром iStrict.
Если таких реквизитов несколько:

• при iCheckMultiple=0 возвращается null;
  
• при iCheckMultiple=1 генерируется exception.

FUNCTION GetPCReqValue(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0, iCheckMultiple PLS_INTEGER := 1) RETURN VARCHAR2;

Возвращает декодированное значение скалярного реквизита iReqClassID для человека/коллектива iPCID.
Если реквизит отсутствует или не может быть успешно декодирован, поведение определяется параметром iStrict.
Если таких реквизитов несколько:

• при iCheckMultiple=0 возвращается null;
  
• при iCheckMultiple=1 генерируется exception.

FUNCTION GetPCReqValueDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0, iCheckMultiple PLS_INTEGER := 1) RETURN DATE;

Возвращают типизированные значения скалярного реквизита iReqClassID для человека/коллектива iPCID.
Если реквизит отсутствует, поведение определяется параметром iStrict.
Если таких реквизитов несколько:

• при iCheckMultiple=0 возвращается null;
  
• при iCheckMultiple=1 генерируется exception.
  

Если значение реквизита получено, но не может быть без ошибок приведено к требуемому типу, возвращают null.

FUNCTION GetPCReqValueInt(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0, iCheckMultiple PLS_INTEGER := 1) RETURN PLS_INTEGER;

FUNCTION GetPCReqValueNumber(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iStrict PLS_INTEGER := 0, iCheckMultiple PLS_INTEGER := 1) RETURN NUMBER;

FUNCTION GetRawPCReqValueOnDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClsID PLS_INTEGER, iDateFromClsID PLS_INTEGER, iDateToClsID PLS_INTEGER, dDate DATE, iCheckMultiple PLS_INTEGER := 0) RETURN VARCHAR2;

Возвращает недекодированное значение реквизита iReqClsID для человека/коллектива iPCID.
Реквизит должен быть либо скалярный, либо находящийся в таблице верхнего уровня.
Проверяется, чтобы это значение реквизита было на заданную дату:

• iDateFromClsID и iDateToClsID - class_id реквизитов с датой «С» и «По» соответственно;
  
• если класс реквизита даты «По» не указан, он не проверяется;
  
• отсутствие в документе даты «По» трактуется как отсутствие ограничения на дату «По».
  

Если подходящий реквизит не найден, то возвращается null.
Если имеется несколько реквизитов на заданную дату:

• при iCheckMultiple=0 возвращается последний по дате подходящий реквизит;
  
• при iCheckMultiple=1 генерируется exception.

FUNCTION GetRawPCReqValueWithinPeriod(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClsID PLS_INTEGER, iDateFromClsID PLS_INTEGER, iDateToClsID PLS_INTEGER, dDateFrom DATE, dDateTo DATE, iCheckMultiple PLS_INTEGER := 0) RETURN VARCHAR2;

То же, но проверяет наличие реквизита в указанном периоде.

FUNCTION GetPCDocReqRowKeyList(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iStorageClassID PLS_INTEGER, iDIIDMode PLS_INTEGER := 0) RETURN uszn.TPDocReqRowKeyList;

Возвращает список строк хранилища (документа или таблицы) для указанного человека/коллектива.
Параметры:

• iRegionID, iPCID - ключ человека/коллектива;
  
• iStorageClassID - ID класса документа или таблицы, чьи данные возвращаются.
  
• iDIIDMode - определяет поведение при наличии нескольких экземпляров документа: 0 - возвращает данные всех имеющихся экземпляров документа; 1 - возвращает данные с минимальным ID экземпляра документа; 2 - возвращает данные с максимальным ID экземпляра документа.
  

Если указанный класс хранилища отсутствует, генерирует exception.

PROCEDURE RenumberPDocTableRows(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, RowsInfo TPDocReorderInfoList);

Перенумеровывает заданные строки таблицы экземпляра персонального документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• RowsInfo - информация о перенумеровываемых строках.

PROCEDURE RenumberPDocTableRows(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iTableClassID PLS_INTEGER, iOwnerID PLS_INTEGER);

Перенумеровывает строки таблицы экземпляра персонального документа, добиваясь нумерации с 1 по N, где N - текущее
количество строк в таблице.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы;
  
• iOwnerID - ID записи первичного реквизита строки вышестоящей таблицы (null для таблиц верхнего уровня).

PROCEDURE RenumberAllPDocTableRows(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iTableClassID PLS_INTEGER);

Перенумеровывает строки таблицы экземпляра персонального документа, добиваясь нумерации с 1 по N, где N - текущее
количество строк в таблице. Для вложенных таблиц перенумерация выполняется для всех строк вышестоящих таблиц.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы.

PROCEDURE RenumberPDocTables(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER);

Перенумеровывает строки всех таблиц экземпляра персонального документа, добиваясь нумерации с 1 по N, где N - текущее количество строк в таблице.

PROCEDURE InsertEmptyPDocTableRows(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iTableClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iInsertPos PLS_INTEGER, iRowCount PLS_INTEGER);

Добавляет пустые строки в таблицу персонального документа, сдвигая существующие на необходимую величину.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы персонального документа;
  
• iOwnerID - ID записи первичного реквизита вышестоящей таблицы (null для таблиц верхнего уровня);
  
• iInsertPos - порядковый номер первой добавляемой строки;
  
• iRowCount - количество добавляемых строк.

PROCEDURE DeletePDocTableRows(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iTableClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, iRowCount PLS_INTEGER, iRenumberRows PLS_INTEGER);

Удаляет строки из таблицы персонального документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы персонального документа;
  
• iOwnerID - ID записи первичного реквизита вышестоящей таблицы (null для таблиц верхнего уровня);
  
• iOrderNum - порядковый номер первой удаляемой строки;
  
• iRowCount - количество удаляемых строк;
  
• iRenumberRows - перенумеровывать ли строки после удаления (0/1).

PROCEDURE DeleteDocReq(iRegionID PLS_INTEGER, iID PLS_INTEGER, iEntireRow PLS_INTEGER, iRenumberRows PLS_INTEGER);

Удаляет указанный реквизит персонального документа. Если это элемент таблицы, и iEntireRow!=0, то удаляется вся строчка таблицы. Для таблиц при iRenumberRows!=0 вызывается перенумерация строк. Процедура является «низкоуровневой»: НЕ ВЫЗЫВАЕТ триггеров документов и НЕ СОЗДАЁТ записей в истории документа.

PROCEDURE ClonePDocTableRow(iRegionID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iTableClassID PLS_INTEGER, iOwnerID PLS_INTEGER, iOrderNum PLS_INTEGER, iDestOwnerID PLS_INTEGER, iDestOrderNum PLS_INTEGER, iCascade PLS_INTEGER);

Клонирует строку таблицы персонального документа.
Параметры:

• iRegionID, iDocInstanceID - ключ экземпляра документа;
  
• iTableClassID - ID класса таблицы, строка которой клонируется;
  
• iOwnerID - ID реквизита вышестоящей таблицы для вложенных таблиц, null для таблиц верхнего уровня;
  
• iOrderNum - порядковый номер клонируемой строки;
  
• iDestOwnerID - ID реквизита вышестоящей таблицы, в которую клонируются строки; null для таблиц верхнего уровня;
  
• iDestOrderNum - порядковый номер строки-клона;
  
• iCascade - клонировать ли каскадно вложенные таблицы (0/1).
  

При клонировании не должно быть строки с порядковым номером, совпадающим с порядковым номером строки-клона, в

• противном случае возникает exception.

FUNCTION GetPCFileKindName(iFileKindID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Возвращает наименование вида файла человека/коллектива по его ID.

PROCEDURE LockPCFiles(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iWait PLS_INTEGER);

Блокирует файлы, связанные с человеком/коллективом. При iWait=0 при неудачной попытке блокировки возникает exception. Если человек/коллектив не существует, ничего не происходит.

FUNCTION AllocateNewPCFileID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает новый свободный ID файла человека/коллектива.

PROCEDURE AddPCFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPCID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Обновляет файл человека/коллектива.
-- Параметры:
--   iRegionID, iID - ключ создаваемого файла человека/коллектива;
--   iPCID          - ID человека/коллектива;
--   iFileKindID    - ID вида файла;
--   sDesc          - описание файла;
--   iFileID        - ID файла в таблице файлов (null, если содержимое файла не меняется);
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE UpdatePCFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPCID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Удаляет файл человека/коллектива. Если файл больше нигде не используется, он также удаляется.
-- Параметры:
--   iRegionID, iID - ключ файла персонального документа;
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE DeletePCFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);

Создаёт файл человека/коллектива. При создании проверяются привилегии пользователя и ведётся аудит.
Параметры:

• iRegionID, iID - ключ создаваемого файла человека/коллектива;
  
• iPCID - ID человека/коллектива;
  
• iFileKindID - ID вида файла;
  
• sDesc - описание файла;
  
• iFileID - ID файла в таблице файлов;
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

PROCEDURE UpdatePCFile(
    iRegionID PLS_INTEGER, iID PLS_INTEGER, iPCID PLS_INTEGER, iFileKindID PLS_INTEGER, sDesc VARCHAR2,
    iFileID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
-- Удаляет файл человека/коллектива. Если файл больше нигде не используется, он также удаляется.
-- Параметры:
--   iRegionID, iID - ключ файла персонального документа;
--   iOriginID      - ID источника события для аудита;
--   sNotes         - примечания для аудита.
PROCEDURE DeletePCFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);
 
/*********************************************************************************************************************
 Агрегатные функции
*********************************************************************************************************************/
 
-- Возвращает минимальное значение реквизита iReqClassID типа Date для человека/коллектива iPCID в регионе iRegionID.
-- Если нет ни одного реквизита с ID=iReqClassID, возвращает dDefault
FUNCTION  GetMinPCReqValueDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, dDefault DATE := NULL) RETURN DATE;

Обновляет файл человека/коллектива.
Параметры:

• iRegionID, iID - ключ создаваемого файла человека/коллектива;
  
• iPCID - ID человека/коллектива;
  
• iFileKindID - ID вида файла;
  
• sDesc - описание файла;
  
• iFileID - ID файла в таблице файлов (null, если содержимое файла не меняется);
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

PROCEDURE DeletePCFile(iRegionID PLS_INTEGER, iID PLS_INTEGER, iOriginID PLS_INTEGER, sNotes VARCHAR2 := NULL);

Удаляет файл человека/коллектива. Если файл больше нигде не используется, он также удаляется.
Параметры:

• iRegionID, iID - ключ файла персонального документа;
  
• iOriginID - ID источника события для аудита;
  
• sNotes - примечания для аудита.

FUNCTION GetMinPCReqValueDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, dDefault DATE := NULL) RETURN DATE;

Возвращает минимальное значение реквизита iReqClassID типа Date для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает dDefault.

FUNCTION GetMaxPCReqValueDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, dDefault DATE := NULL) RETURN DATE;

Возвращает максимальное значение реквизита iReqClassID типа Date для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает dDefault.

FUNCTION GetMinPCReqValueNumber(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, nDefault NUMBER := NULL) RETURN NUMBER;

Возвращает минимальное значение реквизита iReqClassID типа Number для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает nDefault.

FUNCTION GetMaxPCReqValueNumber(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, nDefault NUMBER := NULL) RETURN NUMBER;

Возвращает максимальное значение реквизита iReqClassID типа Number для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает nDefault.

FUNCTION GetMinPCReqValueInt(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iDefault PLS_INTEGER := NULL) RETURN PLS_INTEGER;

Возвращает минимальное значение реквизита iReqClassID типа Pls_Integer для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает iDefault.

FUNCTION GetMaxPCReqValueInt(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iReqClassID PLS_INTEGER, iDefault PLS_INTEGER := NULL) RETURN PLS_INTEGER;

Возвращает максимальное значение реквизита iReqClassID типа Pls_Integer для человека/коллектива iPCID в регионе iRegionID. Если нет ни одного реквизита с ID=iReqClassID, возвращает iDefault.

PROCEDURE ClearPDocElementsCache;

Очищает кеш элементов структуры персональных документов.

PROCEDURE UpdatePCReqCache(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iStrict PLS_INTEGER, iComputeMembershipPeriods PLS_INTEGER, iComputePCAddresses PLS_INTEGER);

Принудительно обновляет кеш персональных реквизитов человека/коллектива.
Параметры:

• iRegionID, iPCID - ключ человека/коллектива;
  
• iComputeMembershipPeriods - пересчитывать ли периоды нахождения в коллективах после изменения (0/1);
  
• iComputePCAddresses - пересчитывать ли адреса человека/коллектива после изменения (0/1);
  
• iStrict - определяет поведение при возникновении проблем.

PROCEDURE UpdatePCReqCache_Identity(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER, iStrict PLS_INTEGER, iComputeMembershipPeriods PLS_INTEGER, iComputePCAddresses PLS_INTEGER);

Обновляет кеш реквизитов человека по ДУЛ.
Параметры:

• iRegionID, iPersonID - ключ человека;
  
• iComputeMembershipPeriods - пересчитывать ли периоды нахождения человека в коллективах после изменения (0/1);
  
• iComputePCAddresses - пересчитывать ли адреса человека после изменения (0/1);
  
• iStrict - определяет поведение при возникновении проблем.

PROCEDURE UpdatePCReqCache_DeathDate(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER, iStrict PLS_INTEGER, iComputeMembershipPeriods PLS_INTEGER, iComputePCAddresses PLS_INTEGER);

Обновляет кеш реквизитов человека по дате смерти.
Параметры:

• iRegionID, iPersonID - ключ человека;
  
• iComputeMembershipPeriods - пересчитывать ли периоды нахождения человека в коллективах после изменения (0/1);
  
• iComputePCAddresses - пересчитывать ли адреса человека после изменения (0/1);
  
• iStrict - определяет поведение при возникновении проблем.

PROCEDURE UpdatePCReqCache_CloseDate(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, iStrict PLS_INTEGER, iComputeMembershipPeriods PLS_INTEGER, iComputePCAddresses PLS_INTEGER);

Обновляет кеш реквизитов человека/коллектива по дате снятия с учёта.
Параметры:

• iRegionID, iPCID - ключ человека/коллектива;
  
• iComputeMembershipPeriods - пересчитывать ли периоды нахождения в коллективах после изменения (0/1);
  
• iComputePCAddresses - пересчитывать ли адреса человека/коллектива после изменения (0/1);
  
• iStrict - определяет поведение при возникновении проблем.

PROCEDURE UpdatePCReqCache_SNILS(iRegionID PLS_INTEGER, iPersonID PLS_INTEGER, iStrict PLS_INTEGER);

Обновляет кеш реквизитов человека/коллектива по СНИЛС.
Параметры:

• iRegionID, iPersonID - ключ человека;
  
• iStrict - определяет поведение при возникновении проблем.

PROCEDURE PDocReqChanged(PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sOldValue VARCHAR2, sNewValue VARCHAR2);

Фиксирует изменение значения скалярного реквизита персонального реквизита.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iReqClassID - ID класса реквизита;
  
• sOldValue - старое значение реквизита;
  
• sNewValue - новое значение реквизита.
  

Если реквизит не существует, не принадлежит данному документу или не является скалярным, возникает exception.

PROCEDURE PDocTableRowChanged(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iTableClassID PLS_INTEGER,
    iAction PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
PRAGMA restrict_references (PDocTableRowChanged, WNDS, WNPS, RNPS);
-- Фиксирует изменение значения табличного реквизита персонального реквизита.
-- Параметры:
--   PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
--   iReqClassID    - ID класса реквизита;
--   sOldValue      - старое значение реквизита;
--   sNewValue      - новое значение реквизита.
--   iRowAction     - действие, выполняемое над строкой таблицы: 1 - добавление, 2 - изменение, 3 - удаление;
--   iOrderNum      - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
--   iOwnerID       - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
--   iID            - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
-- Если действие над строкой - 1 (добавление), старое значение реквизита игнорируется (заменяется на null).
-- Если действие над строкой - 3 (удаление), новое значение реквизита игнорируется (заменяется на null).
-- Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
-- документу, возникает exception.
PROCEDURE PDocTableReqChanged(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sOldValue VARCHAR2, sNewValue VARCHAR2,
    iRowAction PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);

Фиксирует наличие изменений в строке таблицы персонального реквизита.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iRegionID - ID района, в котором находится экземпляр документа;
  
• iTableClassID - ID класса таблицы;
  
• iAction - действие, выполняемое над строкой таблицы: 1 - добавление, 2 - изменение, 3 - удаление;
  
• iOrderNum - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
  
• iOwnerID - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
  
• iID - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
  

Если таблица не существует или не принадлежит данному документу, возникает exception.

PROCEDURE PDocTableReqChanged(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sOldValue VARCHAR2, sNewValue VARCHAR2,
    iRowAction PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
PRAGMA restrict_references (PDocTableReqChanged, WNDS);
-- Фиксирует добавление значения реквизита в добавленную строку таблицы персонального документа.
-- Параметры:
--   PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
--   iReqClassID    - ID класса реквизита;
--   sReqValue      - значение реквизита;
--   iOrderNum      - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
--   iOwnerID       - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
--   iID            - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
-- Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
-- документу, возникает exception.
PROCEDURE PDocTableAddedRowReq(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sReqValue VARCHAR2,
    iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
-- Фиксирует удаление значения реквизита из удалённой строки таблицы персонального документа.
-- Параметры:
--   PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
--   iReqClassID    - ID класса реквизита;

Фиксирует изменение значения табличного реквизита персонального реквизита.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iReqClassID - ID класса реквизита;
  
• sOldValue - старое значение реквизита;
  
• sNewValue - новое значение реквизита.
  
• iRowAction - действие, выполняемое над строкой таблицы: 1 - добавление, 2 - изменение, 3 - удаление;
  
• iOrderNum - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
  
• iOwnerID - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
  
• iID - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
  

Если действие над строкой - 1 (добавление), старое значение реквизита игнорируется (заменяется на null).
Если действие над строкой - 3 (удаление), новое значение реквизита игнорируется (заменяется на null).
Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
документу, возникает exception.

PROCEDURE PDocTableAddedRowReq(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sReqValue VARCHAR2,
    iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
-- Фиксирует удаление значения реквизита из удалённой строки таблицы персонального документа.
-- Параметры:
--   PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
--   iReqClassID    - ID класса реквизита;
--   sReqValue      - значение реквизита;
--   iOrderNum      - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
--   iOwnerID       - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
--   iID            - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
-- Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
-- документу, возникает exception.
PROCEDURE PDocTableDeletedRowReq(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sReqValue VARCHAR2,
    iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
-- Фиксирует добавление строки таблицы персонального документа вместе со всеми её реквизитами и дочерними таблицами.
-- Параметры:
--   PDocDataChange     - структура со сведениями об изменениях в реквизитах документа;
--   iTableClassID      - ID класса таблицы;
--   iRegionID, iPDocID - ключ экземпляра документа;

Фиксирует добавление значения реквизита в добавленную строку таблицы персонального документа.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iReqClassID - ID класса реквизита;
  
• sReqValue - значение реквизита;
  
• iOrderNum - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
  
• iOwnerID - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
  
• iID - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
  

Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
документу, возникает exception.

PROCEDURE PDocTableDeletedRowReq(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iReqClassID PLS_INTEGER, sReqValue VARCHAR2,
    iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL, iID PLS_INTEGER := NULL);
-- Фиксирует добавление строки таблицы персонального документа вместе со всеми её реквизитами и дочерними таблицами.
-- Параметры:
--   PDocDataChange     - структура со сведениями об изменениях в реквизитах документа;
--   iTableClassID      - ID класса таблицы;
--   iRegionID, iPDocID - ключ экземпляра документа;
--   iOrderNum          - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
--   iOwnerID           - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня.
-- Если таблица не существует или не принадлежит данному документу, возникает exception.
PROCEDURE PDocTableRowAdded(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iTableClassID PLS_INTEGER,
    iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL);
-- Удаляет строку таблицы документа, автоматически добавляя данные аудита в структуру.
-- Параметры:
--   PDocDataChange    - структура со сведениями об изменениях в реквизитах документа;
--   iRegionID, iReqID - ключ любого реквизита строки таблицы документа.
-- При этом перенумерации оставшихся строк таблицы документа не выполняется.
-- Если реквизит не существует, ничего не происходит.
-- При удалении проверяются необходимые привилегии пользователя, если их недостаточно, возникает exception.

Фиксирует удаление значения реквизита из удалённой строки таблицы персонального документа.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iReqClassID - ID класса реквизита;
  
• sReqValue - значение реквизита;
  
• iOrderNum - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
  
• iOwnerID - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня;
  
• iID - ID первичного реквизита изменённой строки; если null, аудит вложенных таблиц невозможен.
  

Если реквизит не существует или не принадлежит таблице, или же таблица не существует или не принадлежит данному
документу, возникает exception.

PROCEDURE PDocTableRowAdded(
    PDocDataChange IN OUT NOCOPY TPDocDataChange, iTableClassID PLS_INTEGER,
    iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, iOrderNum PLS_INTEGER, iOwnerID PLS_INTEGER := NULL);
-- Удаляет строку таблицы документа, автоматически добавляя данные аудита в структуру.
-- Параметры:
--   PDocDataChange    - структура со сведениями об изменениях в реквизитах документа;
--   iRegionID, iReqID - ключ любого реквизита строки таблицы документа.
-- При этом перенумерации оставшихся строк таблицы документа не выполняется.
-- Если реквизит не существует, ничего не происходит.
-- При удалении проверяются необходимые привилегии пользователя, если их недостаточно, возникает exception.
PROCEDURE DeletePDocTableRowEx(PDocDataChange IN OUT NOCOPY TPDocDataChange, iRegionID PLS_INTEGER, iReqID PLS_INTEGER);
-- Сохраняет в БД изменения в персональном документе. Список изменений берётся во временных таблицах.
-- Параметры:
--   iRegionID, iPDocID - ключ персонального документа;
--   PDocChange         - сведения о внесённых изменениях (заполняются процедурой);
-- Если документ не существует или пользователь не имеет прав на его изменение, возникает exception.
PROCEDURE SavePDocChanges(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, PDocChange OUT TPDocDataChange);
-- Возвращает текст для записи аудита изменений в реквизитах персонального документа.
-- Параметры:
--   PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
--   iMaxLen        - максимальная длина описания в символах; если длина превышена, текст описания усекается.

Фиксирует добавление строки таблицы персонального документа вместе со всеми её реквизитами и дочерними таблицами.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iTableClassID - ID класса таблицы;
  
• iRegionID, iPDocID - ключ экземпляра документа;
  
• iOrderNum - порядковый номер строки (для вложенных таблиц - в пределах строки вышестоящей таблицы);
  
• iOwnerID - ID первичного реквизита строки вышестоящей таблицы; null для таблиц первого уровня.
  

Если таблица не существует или не принадлежит данному документу, возникает exception.

PROCEDURE DeletePDocTableRowEx(PDocDataChange IN OUT NOCOPY TPDocDataChange, iRegionID PLS_INTEGER, iReqID PLS_INTEGER);

Удаляет строку таблицы документа, автоматически добавляя данные аудита в структуру.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iRegionID, iReqID - ключ любого реквизита строки таблицы документа.
  

При этом перенумерации оставшихся строк таблицы документа не выполняется.
Если реквизит не существует, ничего не происходит.
При удалении проверяются необходимые привилегии пользователя, если их недостаточно, возникает exception.

PROCEDURE SavePDocChanges(iRegionID PLS_INTEGER, iPDocID PLS_INTEGER, PDocChange OUT TPDocDataChange);

Сохраняет в БД изменения в персональном документе. Список изменений берётся во временных таблицах.
Параметры:

• iRegionID, iPDocID - ключ персонального документа;
  
• PDocChange - сведения о внесённых изменениях (заполняются процедурой);
  

Если документ не существует или пользователь не имеет прав на его изменение, возникает exception.

FUNCTION GetAuditText(PDocDataChange TPDocDataChange, iMaxLen PLS_INTEGER) RETURN VARCHAR2;

Возвращает текст для записи аудита изменений в реквизитах персонального документа.
Параметры:

• PDocDataChange - структура со сведениями об изменениях в реквизитах документа;
  
• iMaxLen - максимальная длина описания в символах; если длина превышена, текст описания усекается.

PROCEDURE GetCategoriesPresence(iRegionID PLS_INTEGER, iPCID PLS_INTEGER, dDate DATE, PresenceList IN OUT uszn.pkParse.TRgnIDPresenceList);

Заполняет перечисленные в PresenceList категории информацией об их наличии на дату dDate у человека/коллектива

• Дата dDate должна быть указана!

PROCEDURE GetDocReqValues(iRegionID PLS_INTEGER, iClassID PLS_INTEGER, iDocInstanceID PLS_INTEGER, iOrderNum PLS_INTEGER := 0, iOwnerID PLS_INTEGER := NULL, InfoList IN OUT uszn.pkParse.TPDocReqInfoList, DocReqList IN OUT uszn.pkParse.TPDocValueList);

Загружает значения реквизитов указанного персонального документа или строчки таблицы в DocReqList.
Если загружаются скалярные реквизиты документа, то:

• iClassID - class_id документа, iOrderNum=0, iOwnerID=null;
  

Если загружаются реквизиты из строчки таблицы, то:

• iClassID - class_id таблицы, iOrderNum и iOwnerID - соответствующие параметры строчки
  

Загружаются только те классы реквизитов, которые перечислены в InfoList;

• Если в InfoList присутствуют реквизиты вложенной таблицы, то загружается несколько значений (при их наличии).