kz.arta.synergy.api.rest.dictionary

Class DictionaryService

java.lang.Object

kz.arta.synergy.api.rest.dictionary.DictionaryService

public class DictionaryService
extends java.lang.Object

Created by IntelliJ IDEA. User: topa Date: 31.10.13 Time: 14:34 To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
DictionaryService()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addRecord(DictionaryRecord record) Добавляет запись справочника URL rest/api/dictionary/record/add Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": null, "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор записи справочника (в данном методе не используется) columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника
java.lang.String	editRecord(DictionaryRecord record) Изменяет запись справочника URL rest/api/dictionary/record/edit Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор редактируемой записи справочника columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника
Response	editRecords(DictionaryRecord[] records) Изменяет запись справочника URL rest/api/dictionary/record/edit Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор редактируемой записи справочника columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника
java.util.Collection<DictionaryItem>	findDictionaryItems(java.lang.String organizationRecordIdColumnId, java.lang.String orgID)
java.util.Dictionary	getDictionaryByCode(java.lang.String fieldsDictionaryCode, boolean loadItems)
java.lang.String	getDictionaryValues(java.lang.String locale, java.lang.String dictionaryCode) Возвращает информацию о справочнике по его коду: столбцы, значения URL rest/api/dictionary/get_by_code Method GET Метод возвращает json с полями: dictionary_code - код справочника dictionaryID - идентификатор справочника columns - список столбцов справочника items - список значений справочника Для каждого столбца (columns) передается: columnID идентификатор столбца code код столбца Для каждого значения (items) передаются: itemID - идентификатор значения values - список значений каждого столбца.
java.lang.String	getHost()
java.lang.String	getUserID()
java.lang.String	removeRecord(DictionaryRecord record) Удаляет запись справочника URL rest/api/dictionary/record/remove Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", } , где dictCode - код справочника itemID - идентификатор удаляемой записи справочника
java.lang.String	saveItem(DictionaryItem item)
java.lang.String	saveTranslations(java.lang.String id, java.lang.String nameId, java.lang.String mapJS)
Response	updateDictionary(DictionaryDefinitionJson json)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DictionaryService

public DictionaryService()

Method Detail

getDictionaryValues

public java.lang.String getDictionaryValues(java.lang.String locale,
                                            java.lang.String dictionaryCode)

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

URL rest/api/dictionary/get_by_code
Method GET

Метод возвращает json с полями:
dictionary_code - код справочника
dictionaryID - идентификатор справочника
columns - список столбцов справочника
items - список значений справочника

Для каждого столбца (columns) передается:
columnID идентификатор столбца
code код столбца

Для каждого значения (items) передаются:
itemID - идентификатор значения
values - список значений каждого столбца. Для каждого значения передаются:
columnID - идентификатор столбца
value - значение
translation - перевод значения согласно локали пользователя (перевод может отсутствовать. Если перевод присутствует, значит в качестве значения для данного столбца надо брать его, если отсутствует - значение поля value)


Рассмотрим пример справочника форм завершения с кодом work_completion:

 {"dictionary_code" : "work_completion", "dictionaryID": "0b247762-f049-49e7-93e5-fa7c93a779d7", "columns": [
 {
 "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940",
 "code": "form_type"
 },
 {
 "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427",
 "code": "form_type_name"
 },
 {
 "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded",
 "code": "is_result_free"
 },
 {
 "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6",
 "code": "additional_params"
 }
 ], "items": [
 {
 "itemID": "36826cf9-5da9-49bf-9b79-3e3f9c0873a1",
 "values": [
 {
 "value": "child=true",
 "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6"
 },
 {
 "value": "0",
 "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded"
 },
 {
 "value": "2",
 "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
 },
 {
 "value": "Документ",
 "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
 "translation": "Документ"
 }
 ]
 },
 {
 "itemID": "55dad228-2653-47c2-898a-ad263c2e7def",
 "values": [
 {
 "value": "0",
 "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded"
 },
 {
 "value": "0",
 "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
 },
 {
 "value": "Комментарий",
 "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
 "translation": "Комментарий"
 }
 ]
 },
 {
 "itemID": "5a753b31-db44-4e56-b922-fabeb29502ff",
 "values": [
 {
 "value": "1",
 "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940"
 },
 {
 "value": "Файл",
 "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" ,
 "translation": "Файл"
 }
 ]
 }
 ]}
 

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

     ____________________________________________________________________________________________________________________________
     |form_type       |form_type_name         | is_result_free        |additional_params  | Идентификатор значения              |
     |2               |Документ               |0                      |child=true         |36826cf9-5da9-49bf-9b79-3e3f9c0873a1 |
     |0               |Комментарий            |0                      |                   |55dad228-2653-47c2-898a-ad263c2e7def |
     |1               |Файл                   |                       |                   |5a753b31-db44-4e56-b922-fabeb29502ff |
     ____________________________________________________________________________________________________________________________
 

Parameters:

locale - локаль пользователя

dictionaryCode - код справочника

Returns:

json с полями описанными выше

addRecord

public java.lang.String addRecord(DictionaryRecord record)

Добавляет запись справочника

URL rest/api/dictionary/record/add
Method POST

Вызывать метод можно только от имени пользователя с ролью "Методолог"

"Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

 {
 "dictCode": "apitest",
 "itemID": null,
 "columns": [
  {
      "code": "number",
      "value": "42",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  },
  {
      "code": "field_name",
      "value": "Поле с переводами",
      "valueKZ": "казахский",
      "valueRU": "русский",
      "valueEN": "английский"
  },
  {
      "code": "field_desc",
      "value": "Тест переводов",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  }
 ]
 }
 

, где
dictCode - код справочника
itemID - идентификатор записи справочника (в данном методе не используется)
columns - список столбцов справочника, где

    code - код столбца справочника

    value - значение столбца справочника

    valueKZ, valueRU, valueEN - локализованные значения столбца справочника

Parameters:

record - запись справочника в формате JSON

Returns:

JSON с результатом выполнения

editRecord

public java.lang.String editRecord(DictionaryRecord record)

Изменяет запись справочника

URL rest/api/dictionary/record/edit
Method POST

Вызывать метод можно только от имени пользователя с ролью "Методолог"

"Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

 {
 "dictCode": "apitest",
 "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
 "columns": [
  {
      "code": "number",
      "value": "42",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  },
  {
      "code": "field_name",
      "value": "Поле с переводами",
      "valueKZ": "казахский",
      "valueRU": "русский",
      "valueEN": "английский"
  },
  {
      "code": "field_desc",
      "value": "Тест переводов",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  }
 ]
 }
 

, где
dictCode - код справочника
itemID - идентификатор редактируемой записи справочника
columns - список столбцов справочника, где

    code - код столбца справочника

    value - значение столбца справочника

    valueKZ, valueRU, valueEN - локализованные значения столбца справочника

Parameters:

record - запись справочника в формате JSON

Returns:

JSON с результатом выполнения

editRecords

public Response editRecords(DictionaryRecord[] records)

Изменяет запись справочника

URL rest/api/dictionary/record/edit
Method POST

Вызывать метод можно только от имени пользователя с ролью "Методолог"

"Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

 {
 "dictCode": "apitest",
 "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
 "columns": [
  {
      "code": "number",
      "value": "42",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  },
  {
      "code": "field_name",
      "value": "Поле с переводами",
      "valueKZ": "казахский",
      "valueRU": "русский",
      "valueEN": "английский"
  },
  {
      "code": "field_desc",
      "value": "Тест переводов",
      "valueKZ": null,
      "valueRU": null,
      "valueEN": null
  }
 ]
 }
 

, где
dictCode - код справочника
itemID - идентификатор редактируемой записи справочника
columns - список столбцов справочника, где

    code - код столбца справочника

    value - значение столбца справочника

    valueKZ, valueRU, valueEN - локализованные значения столбца справочника

Parameters:

record - запись справочника в формате JSON

Returns:

JSON с результатом выполнения

removeRecord

public java.lang.String removeRecord(DictionaryRecord record)

Удаляет запись справочника

URL rest/api/dictionary/record/remove
Method POST

Вызывать метод можно только от имени пользователя с ролью "Методолог"

"Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате

 {
 "dictCode": "apitest",
 "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283",
 }
 

, где
dictCode - код справочника
itemID - идентификатор удаляемой записи справочника

Parameters:

record - запись справочника в формате JSON

Returns:

JSON с результатом выполнения

getHost

public java.lang.String getHost()

getUserID

public java.lang.String getUserID()

findDictionaryItems

public java.util.Collection<DictionaryItem> findDictionaryItems(java.lang.String organizationRecordIdColumnId,
                                                                java.lang.String orgID)

updateDictionary

public Response updateDictionary(DictionaryDefinitionJson json)

saveItem

public java.lang.String saveItem(DictionaryItem item)

saveTranslations

public java.lang.String saveTranslations(java.lang.String id,
                                         java.lang.String nameId,
                                         java.lang.String mapJS)

getDictionaryByCode

public java.util.Dictionary getDictionaryByCode(java.lang.String fieldsDictionaryCode,
                                                boolean loadItems)