Документация iSZN

pkSMEV.sql

Ошибки

Error_InvalidSignature

PROCEDURE Error_InvalidSignature;

Описание

Вызывает exception “Ошибочная ЭП сообщения”.

Error_InvalidStatusID

PROCEDURE Error_InvalidStatusID(iID PLS_INTEGER);

Описание

Вызывает exception “Неизвестный ID статуса сообщения”.

Error_InvalidStatus

PROCEDURE Error_InvalidStatus(sStatus VARCHAR2);

Описание

Вызывает exception “Неизвестный ID статуса сообщения”.

Error_NoParticipant

PROCEDURE Error_NoParticipant(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Участник обмена ... не найден”.

Error_NoSigCertificate

PROCEDURE Error_NoSigCertificate(iCertificateID PLS_INTEGER);

Описание

Вызывает exception “Сертификат ЭП не существует”.

Error_NoParticipantSigCert

PROCEDURE Error_NoParticipantSigCert(iParticipantRegionID PLS_INTEGER, iParticipantID PLS_INTEGER);

Описание

Вызывает exception “Для участника взаимодействия не задан сертификат ЭП”.

Error_NoSystemWithCode

PROCEDURE Error_NoSystemWithCode(iRegionID PLS_INTEGER, sSystemCode VARCHAR2);

Описание

Вызывает exception “Система с мнемоникой ... не найдена”.

Error_TooManySystemsWithCode

PROCEDURE Error_TooManySystemsWithCode(iRegionID PLS_INTEGER, sSystemCode VARCHAR2);

Описание

Вызывает exception “Обнаружено более одной Системы с мнемоникой ...”.

Работа с версиями СМЭВ

GetSMEVVerionName

FUNCTION GetSMEVVerionName(iSMEVVersionID PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование версии СМЭВ по её ID.
Параметры:

  • iID - ID версии СМЭВ в справочнике.

Если iID=null, возвращает null,
Если записи с таким ID не существует, возникает exception.

GetSMEVNSURI

FUNCTION GetSMEVNSURI(iSMEVVersionID PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает URI пространства имён для версии СМЭВ.
Параметры:

  • iSMEVVersionID - ID версии СМЭВ в справочнике.

Если iSMEVVersionID=null, возвращает null,
Если записи с таким ID не существует, возникает exception.

GetSMEVSchemaVersion

FUNCTION GetSMEVSchemaVersion(iSMEVVersionID PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает номер версии схемы СМЭВ по ID.
Параметры:

  • iSMEVVersionID - ID версии СМЭВ в справочнике.

Если iSMEVVersionID=null, возвращает null,
Если записи с таким ID не существует, возникает exception.

GetSMEVVersionID

FUNCTION GetSMEVVersionID(sSMEVNSURI VARCHAR2) RETURN PLS_INTEGER;

Описание

Возвращает ID версии СМЭВ по URI пространства имён.
Параметры:

  • sSMEVNSURI - URI пространства имён СМЭВ.

Если sSMEVNSURI=null, возвращает null. Если такого URI не существует, возникает exception.

GetSMEVVerionInfo

PROCEDURE GetSMEVVerionInfo(sSMEVNSURI VARCHAR2, iSMEVVersionID OUT PLS_INTEGER, sSMEVVersion OUT VARCHAR2, sSchemaVersion OUT VARCHAR2);

Описание

Получает версию СМЭВ и версию схемы СМЭВ по URI пространства имён.
Входные параметры:

  • sSMEVNSURI - URI пространства имён СМЭВ;

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

  • iSMEVVersionID - ID версии СМЭВ;
  • sSMEVVersion - номер версии СМЭВ;
  • sSchemaVersion - номер версии схемы СМЭВ.

Если sSMEVNSURI=null, возвращает в выходных параметрах null. Если такого URI не существует, возникает exception.

Работа со статусами сообщений

GetStatusName

FUNCTION GetStatusName(iStatusID PLS_INTEGER, iNameKind PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование статуса сообщения СМЭВ 2.x по его ID.
Параметры:

  • iStatusID - ID статуса;
  • iNameKind - вид наименования: 1 - техническое наименование (ACCEPT, REQUEST и т. д.); 2 - отображаемое наименование.

Если iStatusID пустой, возвращает null.
Если статус с таким ID не существует, возникает exception.

GetStatusID

FUNCTION GetStatusID(sStatus VARCHAR2) RETURN PLS_INTEGER;

Описание

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

  • sStatus - наименование статуса запроса (REQUEST, ACCEPT и т. д.).

Если sStatus пустой, возвращает null.
Если sStatus не распознан, возникает exception.

Конфигурация

GetSMEVSubsystem

FUNCTION GetSMEVSubsystem(iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает контур СМЭВ (константа из числа ISMEV_SUBSYS_xxx).
Значение берётся из настроек Экземпляра Системы.
Параметры:

  • iStrict - определяет поведение при отсутствии значения.

Работа с участниками взаимодействия и ЭП

GetParticipantName

FUNCTION GetParticipantName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER, iDisplayMode PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

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

  • iRegionID, iID - ключ участника межведомственного взаимодействия;
  • iStrict - поведение при отсутствии указанного участника;
  • iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey.

GetParticipantSigCertInfo

PROCEDURE GetParticipantSigCertInfo(
  iParticipantRegionID PLS_INTEGER, iParticipantID PLS_INTEGER, iNeedCert PLS_INTEGER,
  sKeyContainerName OUT VARCHAR2, iGostVersion OUT PLS_INTEGER);
PRAGMA restrict_references(GetParticipantSigCertInfo, RNPS, WNDS, WNPS);
-- Возвращает информацию о системе участника межведомственного взаимодействия.
-- Параметры:
--   iRegionID, iID - ключ участника межведомственного взаимодействия.
-- Если участник не существует, возникает exception.
FUNCTION  GetParticipantSystemInfo(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN TSystemInfo;

Описание

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

  • iParticipantRegionID, iParticipantID - ключ участника межведомственного взаимодействия;
  • iNeedCert - обязательность наличия сертификата ЭП (0/1).

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

  • sKeyContainerName - наименование ключевого контейнера;
  • iGostVersion - идентификатор версии ГОСТ ЭП.

Если участник взаимодействия не существует, возникает exception.
Если для участника взаимодействия не задан сертификат ЭП, при iNeedCert=1 возникает exception.

GetParticipantSystemInfo

FUNCTION GetParticipantSystemInfo(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN TSystemInfo;

Описание

Возвращает информацию о системе участника межведомственного взаимодействия.
Параметры:

  • iRegionID, iID - ключ участника межведомственного взаимодействия.

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

GetParticipantKey

FUNCTION GetParticipantKey(iRegionID PLS_INTEGER, sSystemCode VARCHAR2, iStrictExists PLS_INTEGER, iStrictUnique PLS_INTEGER) RETURN uszn.TRgnKey;

Описание

Возвращает ключ участника взаимодействия по мнемонике системы (СМЭВ 2.x).
Параметры:

  • iRegionID - ID района запроса; поиск производится вверх по иерархии районов;
  • sSystemCode - мнемоника системы;
  • iStrictExists - определяет поведение при отсутствии в справочнике системы с такой мнемоникой;
  • iStrictUnique - определяет поведение при обнаружении в справочнике более одной системы с такой мнемоникой.

GetSigCertificateInfo

PROCEDURE GetSigCertificateInfo(iCertificateID PLS_INTEGER, sKeyContainerName OUT VARCHAR2, iGostVersion OUT PLS_INTEGER);

Описание

Возвращает информацию о сертификате подписи.
Входные параметры:

  • iCertificateID - ID сертификата подписи.

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

  • sKeyContainerName - наименование ключевого контейнера;
  • iGostVersion - идентификатор версии ГОСТ ЭП.

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

Работа со структурами

GetRequestedRegionIDs

FUNCTION GetRequestedRegionIDs(sOKTMOCode VARCHAR2, iSeekUpward PLS_INTEGER, iAllowFolders PLS_INTEGER, sErrorMessage OUT VARCHAR2) RETURN uszn.TIntegerList;

Описание

Возвращает список районов, данные по которым запрошены, на основании кода ОКТМО.
Параметры:

  • sOKTMOCode - код ОКТМО из заголовка сообщения (null, если код ОКТМО в сообщении отсутствовал);
  • iSeekUpward - разрешать ли поиск вверх по иерархии ОКТМО (0/1);
  • iAllowFolders - разрешать ли возвращать районы-папки (0/1);
  • sErrorMessage - сообщение об ошибке; заполняется, если в процессе поиска возникла ошибка.

Возвращает список ID искомых районов iSZN или пустой список в случае ошибки.

CreateReplyMsg

FUNCTION CreateReplyMsg(SrcMessage TMessage, rSrcMessageGUID RAW, sStatus VARCHAR2) RETURN TMessage;

Описание

Готовит служебный блок атрибутов сообщения для ответа.
Параметры:

  • SrcMessage - служебный блок атрибутов входного сообщения;
  • rSrcMessageGUID - GUID исходного сообщения;
  • sStatus - статус ответного сообщения.