RecordsService (Java)
RecordsService - сервис для работы с абстрактными записями, источником которых может быть любой DAO.
Существует четыре операции, которые можно проделывать над записями:
Методы: query, queryOne
Для поиска записей всегда передается RecordsQuery, который содержит параметры поиска. Помимо самого простого метода для поиска с одним параметром RecordsQuery так же есть варианты с объединенным поиском и запросом атрибутов.
recordsService.queryOne(
RecordsQuery.create()
.withSourceId("emodel/person")
.withLanguage(PredicateService.LANGUAGE_PREDICATE)
.withQuery(Predicates.and(
Predicates.eq("city", "Tomsk"),
Predicates.eq("organization", "Citeck")))
.withConsistency(Consistency.EVENTUAL)
.addSort(new SortBy("_created", true))
.build());
recordsService.query(RecordsQuery.create()
.withSourceId("edi/edi-inbound-main-document")
.withLanguage(PredicateService.LANGUAGE_PREDICATE)
.withQuery(Predicates.and(
Predicates.eq("type", "emodel/type@testip-inboundPackage"),
Predicates.eq("testip:isNeedSendToVim", true),
Predicates.not(
Predicates.eq("testip:isAlreadySentToVim", true)
)
))
.withConsistency(Consistency.EVENTUAL)
.build());
.withLanguage – указываем язык запроса;
.withQuery – сам запрос;
.withConsistency – Consistency (Согласованность). Возможные варианты: EVENTUAL, TRANSACTIONAL, DEFAULT, TRANSACTIONAL_IF_POSSIBLE
.addSort – указываем по какому полю нужна сортировка
.build() – сборка запроса
На выходе:
при query без запроса атрибутов получаем RecsQueryRes<RecordRef>;
при queryOne без запроса атрибутов получаем RecordRef или
null, если запись не найдена;перегрузки с атрибутами возвращают RecordAtts или DTO; для query они находятся в RecsQueryRes.
Методы: getAtt, getAtts
recordsService.getAtt(documentRef, "eint:ediProviderType?str").asText();
documentRef – record, к которому обращаемся
«eint:ediProviderType?str» – параметр, который хотим получить
List<ObjPropertyClass> list = recordsService.getAtt(documentRef, "objProperty[]?json").asList(ObjPropertyClass.class);
RecordAtts recordAtts = recordsService.getAtts(RecordRef.valueOf(nodeRef.toString()),
Collections.singletonMap("assocId", name + "[]?id"));
Существует два уровня абстрации для получения атрибутов:
DTO Class > Attributes
DTO Class - класс, который используется для генерации списка аттрибутов для формирования схемы и запроса атрибутов из DAO. После получения всех данных из DAO идет создание инстансов переданного DTO класса и наполнение его данными с помощью библиотеки jackson. Список аттрибутов формируется либо из названий полей, либо можно добавить аннотацию
AttNameдля указания атрибута вручную.Attributes - аттрибуты записи в чистом виде. Есть варианты с одним атрибутом, списком атрибутов или набором ключ→значение (Map).
Каждый DAO решает сам создавать или редактировать полученную запись. Пустой локальный идентификатор в выбранном источнике означает создание новой записи.
RecordAtts recordAtts = new RecordAtts();
recordAtts.setId(recordRef);
recordAtts.setAtt("testdl:isOutboundPackageSyncNeeded", false);
recordsService.mutate(recordAtts);
Для обновления записи необходимо указывать .setId() записи которой необходимо изменить.
RecordAtts recordAtts = new RecordAtts();
recordAtts.setId(RecordRef.create("emodel", "your-type", ""));
recordAtts.setAtt("name", "Новая запись");
recordsService.mutate(recordAtts);
Здесь setId() задаёт приложение и источник с пустым локальным ID. Замените your-type источником, который поддерживает создание записей в вашей установке. Также можно использовать recordsService.create(sourceId, attributes).
Заполнение аудиторских полей _creator, _created, _modifier, _modified определяется реализацией источника. Управляющие атрибуты DB-слоя, например __disableAudit, и условия их применения не являются общим контрактом Records API.
recordsService.delete(routeTemplate);
RecordRef routeTemplate – record, который необходимо удалить