Package ru.i_novus.ms.rdm.api.service

Interface DraftService

public interface DraftService
Черновик справочника: Сервис.

  • Method Summary

    Modifier and Type Method Description
    void addAttributeValidation​(java.lang.Integer draftId, java.lang.String attribute, AttributeValidation attributeValidation)
    Добавление настраиваемой проверки атрибута.
    Draft create​(java.lang.Integer refBookId, FileModel fileModel)
    Создание черновика из файла.
    Draft create​(CreateDraftRequest request)
    Создание черновика по запросу.
    void createAttribute​(java.lang.Integer draftId, CreateAttributeRequest request)
    Добавление атрибута справочника.
    Draft createFromVersion​(java.lang.Integer versionId)
    Создание черновика на основе версии справочника.
    void deleteAllData​(java.lang.Integer draftId, DeleteAllDataRequest request)
    Удаление всех записей черновика.
    void deleteAttribute​(java.lang.Integer draftId, DeleteAttributeRequest request)
    Удаление атрибута справочника.
    void deleteAttributeValidation​(java.lang.Integer draftId, java.lang.String attribute, AttributeValidationType type)
    Удаление настраиваемой проверки атрибута.
    void deleteData​(java.lang.Integer draftId, DeleteDataRequest request)
    Удаление записей черновика.
    Draft findDraft​(java.lang.String refBookCode)
    Получение черновика по коду справочника.
    java.util.List<AttributeValidation> getAttributeValidations​(java.lang.Integer draftId, java.lang.String attribute)
    Получение настраиваемых проверок атрибута (или атрибутов).
    Draft getDraft​(java.lang.Integer draftId)
    Получение черновика по идентификатору.
    ExportFile getDraftFile​(java.lang.Integer draftId, FileType fileType)
    Выгрузка черновика в файл.
    java.lang.Boolean hasData​(java.lang.Integer draftId)
    Проверка на наличие записей в черновике.
    void remove​(java.lang.Integer draftId)
    Удаление черновика.
    org.springframework.data.domain.Page<RefBookRowValue> search​(java.lang.Integer draftId, SearchDataCriteria criteria)
    Получение записей черновика по параметрам критерия.
    void updateAttribute​(java.lang.Integer draftId, UpdateAttributeRequest request)
    Изменение атрибута справочника.
    void updateAttributeValidations​(java.lang.Integer draftId, AttributeValidationRequest request)
    Обновление настраиваемых проверок атрибута.
    void updateData​(java.lang.Integer draftId, UpdateDataRequest request)
    Добавление или изменение записей черновика.
    void updateFromFile​(java.lang.Integer draftId, UpdateFromFileRequest request)
    Обновление черновика из файла.

  • Method Details

    • create

      Draft create​(CreateDraftRequest request)
      Создание черновика по запросу.
      Parameters:
      request - запрос
      Returns:
      Созданный черновик

    • createFromVersion

      Draft createFromVersion​(java.lang.Integer versionId)
      Создание черновика на основе версии справочника.

      Если версия является черновиком, то возвращается этот черновик.

      Parameters:
      versionId - идентификатор версии
      Returns:
      Созданный черновик с актуальными записями из версии или существующий черновик

    • create

      Draft create​(java.lang.Integer refBookId, FileModel fileModel)
      Создание черновика из файла.
      Parameters:
      refBookId - идентификатор справочника
      fileModel - модель файла
      Returns:
      Созданный черновик со структурой и данными из файла

    • updateData

      void updateData​(java.lang.Integer draftId, UpdateDataRequest request)
      Добавление или изменение записей черновика.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • deleteData

      void deleteData​(java.lang.Integer draftId, DeleteDataRequest request)
      Удаление записей черновика.

      Записи для удаления определяются либо по первичному ключу, либо по системному идентификатору.

      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • deleteAllData

      void deleteAllData​(java.lang.Integer draftId, DeleteAllDataRequest request)
      Удаление всех записей черновика.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • updateFromFile

      void updateFromFile​(java.lang.Integer draftId, UpdateFromFileRequest request)
      Обновление черновика из файла.

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

      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • search

      org.springframework.data.domain.Page<RefBookRowValue> search​(java.lang.Integer draftId, SearchDataCriteria criteria)
      Получение записей черновика по параметрам критерия.
      Parameters:
      draftId - идентификатор черновика
      criteria - критерий поиска
      Returns:
      Страница записей черновика

    • hasData

      java.lang.Boolean hasData​(java.lang.Integer draftId)
      Проверка на наличие записей в черновике.
      Parameters:
      draftId - идентификатор черновика
      Returns:
      Результат проверки

    • remove

      void remove​(java.lang.Integer draftId)
      Удаление черновика.
      Parameters:
      draftId - идентификатор черновика

    • getDraft

      Draft getDraft​(java.lang.Integer draftId)
      Получение черновика по идентификатору.
      Parameters:
      draftId - идентификатор черновика
      Returns:
      Черновик

    • findDraft

      Draft findDraft​(java.lang.String refBookCode)
      Получение черновика по коду справочника.
      Parameters:
      refBookCode - код справочника
      Returns:
      Черновик

    • createAttribute

      void createAttribute​(java.lang.Integer draftId, CreateAttributeRequest request)
      Добавление атрибута справочника.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • updateAttribute

      void updateAttribute​(java.lang.Integer draftId, UpdateAttributeRequest request)
      Изменение атрибута справочника.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • deleteAttribute

      void deleteAttribute​(java.lang.Integer draftId, DeleteAttributeRequest request)
      Удаление атрибута справочника.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • addAttributeValidation

      void addAttributeValidation​(java.lang.Integer draftId, java.lang.String attribute, AttributeValidation attributeValidation)
      Добавление настраиваемой проверки атрибута.
      Parameters:
      draftId - идентификатор черновика
      attribute - код атрибута
      attributeValidation - проверка атрибута

    • deleteAttributeValidation

      void deleteAttributeValidation​(java.lang.Integer draftId, java.lang.String attribute, AttributeValidationType type)
      Удаление настраиваемой проверки атрибута.
      Parameters:
      draftId - идентификатор черновика
      attribute - код атрибута
      type - тип проверки атрибута

    • getAttributeValidations

      java.util.List<AttributeValidation> getAttributeValidations​(java.lang.Integer draftId, java.lang.String attribute)
      Получение настраиваемых проверок атрибута (или атрибутов).
      Parameters:
      draftId - идентификатор черновика
      attribute - код атрибута, может быть null
      Returns:
      Список настраиваемых проверок

    • updateAttributeValidations

      void updateAttributeValidations​(java.lang.Integer draftId, AttributeValidationRequest request)
      Обновление настраиваемых проверок атрибута.
      Parameters:
      draftId - идентификатор черновика
      request - запрос

    • getDraftFile

      ExportFile getDraftFile​(java.lang.Integer draftId, FileType fileType)
      Выгрузка черновика в файл.
      Parameters:
      draftId - идентификатор черновика
      fileType - тип файла
      Returns:
      Файл черновика справочника