PROCEDURE Error_OutMessageLocked(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает exception “Исходящее сообщение ... заблокировано”.

PROCEDURE Error_NoOutgoingMessage(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает exception “Исходящее сообщение ... не найдено”.

PROCEDURE Error_NoOutMessageCall(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает exception “Запись отправки исходящего сообщения ... не найдена”.

PROCEDURE Error_NoOutMsgCallProcessing(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Вызывает exception “Запись обработки отправленного исходящего сообщения ... не найдена”.

PROCEDURE Error_OutMsgIsNotDelivered(iRegionID PLS_INTEGER, iCallID PLS_INTEGER);

Вызывает exception “Исходящее сообщение ... не было доставлено”.

PROCEDURE Error_ResponseHasNoData(iRegionID PLS_INTEGER, iCallID PLS_INTEGER);

Вызывает exception “Ответ не содержит данных”.

PROCEDURE CheckOutMsgServicePriv(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iPriv PLS_INTEGER);

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

• iRegionID, iMessageID - ключ исходящего сообщения;
  
• iPriv - сумма битовых флагов проверяемых привилегий.
  

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

FUNCTION GetMaxFailedOutMsgCallCount RETURN PLS_INTEGER;

Возвращает максимальное количество сбоев при отправке исходящего сообщения, после которого его отправка прекращается.

FUNCTION GetFailedOutMsgCallTimeout(iFailCount PLS_INTEGER) RETURN PLS_INTEGER;

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

FUNCTION GetOutMsgTimeoutSecs(iOperationRegionID PLS_INTEGER, iOperationID PLS_INTEGER, iIsFirstCall PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

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

• iOperationRegionID, iOperationID - ключ операции;
  
• iIsFirstCall - первая ли это отправка сообщения (1) или повторная (0);
  
• iStrict - определяет поведение, если операция не существует, значение атрибута не задано или ошибочно.

PROCEDURE GetDefaultParticipantKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER, iParticipantRgnID OUT PLS_INTEGER, iParticipantID OUT PLS_INTEGER);

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

• iRegionID - ID района, для которого необходимо получить значение настройки;
  
• iStrict - определяет поведение при отсутствии значения настройки.
  

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

• iParticipantRgnID, iParticipantID - ключ участника взаимодействия или null.

FUNCTION GetDefaultParticipantSlurpKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает Slurp-ключ участника взаимодействия по умолчанию.
Значение берётся из региональных настроек экземпляра Системы.
Параметры:

• iRegionID - ID района, для которого необходимо получить значение настройки;
  
• iStrict - определяет поведение при отсутствии значения настройки.

FUNCTION AllocateNewOutMessageID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Возвращает новый ID записи исходящего сообщения в заданном районе.

FUNCTION AllocateNewOutMsgCallID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

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

FUNCTION AllocateNewOutMsgCallProcID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

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

FUNCTION CreateMessageDataRFile(iRegionID PLS_INTEGER, bData BLOB, iIsResponse PLS_INTEGER, sMediaType VARCHAR2, iCompressionMethod PLS_INTEGER) RETURN PLS_INTEGER;

Создаёт в хранилище файлов запись с данными запроса или ответа.
Параметры:

• iRegionID - ID района;
  
• bData - содержимое файла;
  
• iIsResponse - являются ли эти данные ответом (0/1);
  
• sMediaType - тип содержимого файла;
  
• iCompressionMethod - метод сжатия; константа из числа pkFile.ICompressMethod_xxx; если null, сжатие не используется.
  

Возвращает ID созданной записи или null, если запись не создавалась.

PROCEDURE CheckOutMessageExists(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER);

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.

PROCEDURE LockOutgoingMessage(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER);

Устанавливает эксклюзивную блокировку на исходящее сообщение.
Параметры:

• iRegionID, iMessageID - ключ сообщения.
  

Если сообщение не существует или заблокировано, возникает exception.

FUNCTION GetOutMessagePDocID(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

Если исходящее сообщение не существует, возникает exception.

FUNCTION SchedulePDocRequest(
  iRegionID PLS_INTEGER, iRequestPDocID PLS_INTEGER, iServiceRegionID PLS_INTEGER, iOperationID PLS_INTEGER,
  iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER,
  iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL, iWorkflowRecID PLS_INTEGER := NULL) RETURN PLS_INTEGER;

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

• iRegionID, iRequestPDocID - ключ экземпляра персонального документа;
  
• iServiceRegionID, iOperationID - ключ операции веб-сервиса для отправки сообщения;
  
• iSenderRegionID, iSenderID - ключ отправителя запроса; если null, берётся отправитель по умолчанию из районных настроек экземпляра Системы;
  
• iRecipientRegionID, iRecipientID - ключ получателя запроса;
  
• iAudOriginID - ID источника события для аудита по документу;
  
• sAudNotes - примечания для аудита по документу;
  
• iWorkflowRecID - ID записи сценария обработки; null, если сценарий обработки не используется.
  

Для подготовки данных запроса вызывается соответствующий SQL-сценарий операции сервиса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на экземпляр персонального документа или на сервис,
возникает exception.

FUNCTION ScheduleCustomRequest(
  iRegionID PLS_INTEGER, iServiceRegionID PLS_INTEGER, iOperationID PLS_INTEGER, bMessageData BLOB, sPathParams VARCHAR2,
  iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER,
  iWorkflowRecID PLS_INTEGER := NULL) RETURN PLS_INTEGER;

Создаёт и ставит в очередь на отправку запрос SendRequest с произвольными данными.
Параметры:

• iRegionID - ID района;
  
• iServiceRegionID, iOperationID - ключ операции веб-сервиса для отправки сообщения;
  
• bMessageData - данные запроса; null, если данные запроса не требуются;
  
• sPathParams - параметры, передаваемые в URL сервиса в виде списка name=value;
  
• iSenderRegionID, iSenderID - ключ отправителя запроса; если null, берётся отправитель по умолчанию из районных настроек экземпляра Системы;
  
• iRecipientRegionID, iRecipientID - ключ получателя запроса;
  
• iWorkflowRecID - ID записи сценария обработки; null, если сценарий обработки не используется.
  

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

FUNCTION ScheduleOutMessage(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER, dSendTime DATE) RETURN DATE;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения;
  
• dSendTime - желаемая дата и время отправки сообщения.
  

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

FUNCTION UnscheduleOutMessage(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

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

PROCEDURE RepeatFailedOutMsgCall(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER);

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

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

FUNCTION GetCallToProcessKeys(iiRegionIDs uszn.TIntegerList, iMaxRecordCount PLS_INTEGER) RETURN uszn.TRgnKeyList;

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

• iiRegionIDs - список ID рабочих районов;
  
• iMaxRecordCount - максимальное допустимое количество записей, которое возвращает функция.
  

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

FUNCTION GetOutMsgResultData(iRegionID PLS_INTEGER, iCallID PLS_INTEGER, iStrictHasData PLS_INTEGER) RETURN BLOB;

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

• iRegionID, iCallID - ключ записи об отправке сообщения;
  
• iStrictHasData - определяет поведение при отсутствии данных.
  

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

FUNCTION ProcessOutMsgResult(iRegionID PLS_INTEGER, iCallID PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL) RETURN PLS_INTEGER;

Обрабатывает результат запроса.
Параметры:

• iRegionID, iCallID - ключ записи об отправке запроса;
  
• iAudOriginID - ID источника события для аудита по документу;
  
• sAudNotes - примечания для аудита по документу.
  

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

FUNCTION GetCallState(iRegionID PLS_INTEGER, iCallID PLS_INTEGER) RETURN uszn.pkSMEVCall.TCallState;

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

• iRegionID, iCallID - ключ записи об отправке сообщения.
  

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

FUNCTION GetCallProcessingState(iRegionID PLS_INTEGER, iCallProcessingID PLS_INTEGER) RETURN uszn.pkSMEVCall.TCallProcessingState;

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

• iRegionID, iCallProcessingID - ключ записи об обработке отправленного сообщения.
  

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

FUNCTION GetLastOutMsgCallID(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

Если сообщение ещё ни разу не отправлялось, возвращает null.
Если исходящее сообщение не существует, возникает exception.

FUNCTION GetLastOutMsgSendTime(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

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

FUNCTION GetLastFailedOutMsgCallCount(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;

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

• iRegionID, iOutMessageID - ключ исходящего сообщения.
  

Если сообщение ещё ни разу не отправлялось, возвращает 0.
Если исходящее сообщение не существует, возникает exception.