kz.arta.synergy.server.api.rest.registry
Class RegistryService

java.lang.Object
  kz.arta.synergy.server.api.rest.registry.RegistryService

public class RegistryService
extends java.lang.Object

Created by IntelliJ IDEA. User: topa Date: 19.09.13 Time: 9:39 To change this template use File | Settings | File Templates.

Constructor Summary

RegistryService()

Method Summary

java.lang.String	activateRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String summary, java.lang.String locale) Запускает событие "Активация" записи реестра (документа) URL rest/api/registry/activate_doc Method GET
java.lang.String	createRegistryDocument(java.lang.String registryID, java.lang.String locale) Создает новый документ по реестру URL rest/api/registry/create_doc Method GET Пример использования можно посмотреть в классе kz.arta.synergy.rest.api.sample.registry.CreateAndFillDocExample
java.lang.String	deleteRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String locale) Запускает событие "Удаление" записи реестра (документа) URL rest/api/registry/delete_doc Method GET
java.lang.String	modifyRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String summary, java.lang.String locale) Запускает событие "Изменение" записи реестра (документа) URL rest/api/registry/modify_doc Method GET

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistryService

public RegistryService()

Method Detail

createRegistryDocument

public java.lang.String createRegistryDocument(java.lang.String registryID,
                                               java.lang.String locale)

Создает новый документ по реестру

URL rest/api/registry/create_doc
Method GET

Пример использования можно посмотреть в классе kz.arta.synergy.rest.api.sample.registry.CreateAndFillDocExample

Parameters:

registryID - UUID реестра

locale - локаль пользователя (по-умолчанию ru)

Returns:

В случае успешного выполнения возвращает json c полями
errorCode - код выполнения (в случае успешного выполнения - 0)
documentID - uuid созданного документа
dataUUID - uuid созданных данных по форме
asfNodeID - uuid файла по форме в хранилище
В случае не успешного выполнения возвращается json с полями
errorCode - код выполнения (число, отличное от 0)
errorMessage - сообщение об ошибке

activateRegistryDocument

public java.lang.String activateRegistryDocument(java.lang.String documentID,
                                                 java.lang.String dataUUID,
                                                 java.lang.String summary,
                                                 java.lang.String locale)

Запускает событие "Активация" записи реестра (документа)

URL rest/api/registry/activate_doc
Method GET

Parameters:

documentID - идентификатор документа (необязательный)

dataUUID - идентификатор файла по форме (необязательный)

locale - локаль пользователя (по-умолчанию ru)

summary - краткое изложение маршрута

Returns:

В случае успешного выполнения возвращает json c полями
errorCode - код выполнения (в случае успешного выполнения - 0)
documentID - uuid документа
dataUUID - uuid данных по форме
В случае неуспешного выполнения возвращается json с полями
errorCode - код выполнения (число, отличное от 0)
errorMessage - сообщение об ошибке

Запись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.

Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. Для реестра задано событие активации записи и маршрут этого события содержит предварительные или последующие этапы.

modifyRegistryDocument

public java.lang.String modifyRegistryDocument(java.lang.String documentID,
                                               java.lang.String dataUUID,
                                               java.lang.String summary,
                                               java.lang.String locale)

Запускает событие "Изменение" записи реестра (документа)

URL rest/api/registry/modify_doc
Method GET

Parameters:

documentID - идентификатор документа (необязательный)

dataUUID - идентификатор файла по форме (необязательный)

locale - локаль пользователя (по-умолчанию ru)

summary - краткое изложение маршрута

Returns:

В случае успешного выполнения возвращает json c полями
errorCode - код выполнения (в случае успешного выполнения - 0)
documentID - uuid документа
dataUUID - uuid данных по форме
В случае неуспешного выполнения возвращается json с полями
errorCode - код выполнения (число, отличное от 0)
errorMessage - сообщение об ошибке

Запись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.

Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. Для реестра задано событие изменения записи и маршрут этого события содержит предварительные или последующие этапы.

deleteRegistryDocument

public java.lang.String deleteRegistryDocument(java.lang.String documentID,
                                               java.lang.String dataUUID,
                                               java.lang.String locale)

Запускает событие "Удаление" записи реестра (документа)

URL rest/api/registry/delete_doc
Method GET

Parameters:

documentID - идентификатор документа (необязательный)

dataUUID - идентификатор файла по форме (необязательный)

locale - локаль пользователя (по-умолчанию ru)

Returns:

В случае успешного выполнения возвращает json c полями
errorCode - код выполнения (в случае успешного выполнения - 0)
documentID - uuid удаленного документа
dataUUID - uuid удаленных данных по форме
В случае не успешного выполнения возвращается json с полями
errorCode - код выполнения (число, отличное от 0)
errorMessage - сообщение об ошибке

Запись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.

Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. У пользователя нет прав на удаление записей реестра
3. Запись реестра находится в неактивном состоянии (черновик)
4. Для реестра задано событие удаления записи и маршрут этого события содержит предварительные или последующие этапы.