FormPlayerService (CommonRestServices API)

java.lang.Object
- kz.arta.synergy.api.rest.asforms.FormPlayerService

```
public class FormPlayerService
extends java.lang.Object
```
Created by exile Date: 18.02.16 Time: 10:02 апи для получения значений для компонентов формы js проигрывателя форм

Constructor Summary

Constructors
Constructor and Description

FormPlayerService()

Constructors
Constructor and Description
`FormPlayerService()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`documentAttribute(java.lang.String dataUUID, java.lang.String field, java.lang.String locale)` получение значения поля ркк документа URL rest/api/formPlayer/documentAttribute Method GET
`java.lang.String`	`formatDate(java.lang.String format, java.lang.String date, java.lang.String locale)` получение форматированного локализованного значения даты URL rest/api/formPlayer/formatDate Method GET
`java.lang.String`	`formatDocLink(java.lang.String documentID, java.lang.String format, java.lang.String locale)` получение значения компонента ссылка на документа URL rest/api/formPlayer/documentLink Method GET
`Response`	`getAsfDataUUID(java.lang.String documentID)` получение идентификатора данных по форме URL rest/api/formPlayer/getAsfDataUUID Method GET
`Response`	`getCompletionForm(java.lang.String completionFormID)` получения описания формы завершения URL rest/api/formPlayer/getCompletionForm Method GET
`Response`	`getCustomComponent(java.lang.String code)` получение информации о пользовательском компоненте
`Response`	`getDocumentBases(java.lang.String dataUUID, java.lang.String locale)` получение списка оснований документа URL rest/api/formPlayer/getDocumentBases Method GET
`Response`	`getDocumentId(java.lang.String dataUUID, java.lang.String locale)` получение идентификатора документа по идентификатору данных по форме URL rest/api/formPlayer/documentIdentifier Method GET
`Response`	`getDocumentMeaningContent(java.lang.String asfDataUUID, java.lang.String documentId)` получение значений полей значащих содержимых
`Response`	`getDocumentMeaningContents(java.lang.String[] documentId)` получение значений полей значащих содержимых
`Response`	`getSignHeaders(java.lang.String headersString, int type, java.lang.String locale)` получение локализованных заголовков списка подписей URL rest/api/formPlayer/getSignHeaders Method GET Возвращает отсортированный массив заголовков имеющий ту же структуру code - код поля name наименование number номер field поле en наименование колонки на английском kz наименование колонки на казахском ru наименование колонки на русском если в процессе получения списка заголовков списка подписей произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
`java.lang.String`	`getUserID()`
`Response`	`listFiles(java.lang.String parentID, boolean getOnlyFolders, boolean showHomeFolder, java.util.List<java.lang.String> mimeType, java.lang.String locale)` Метод возвращает список файлов в папке с идентификатором parentID URL rest/api/formPlayer/listFiles Method GET
`Response`	`listResolutions(java.lang.String dataUUID, java.lang.String locale)` получение списка резолюций документа URL rest/api/formPlayer/getResolutions Method GET
`Response`	`listSigns(java.lang.String dataUUID, int type, java.lang.String locale)` получение списка подписей документа URL rest/api/formPlayer/getSigns Method GET
`Response`	`log(java.lang.String error, java.lang.String formId, java.lang.String asfDataId)` серверное логгирование ошибок проигрывателя форм URL rest/api/formPlayer/log Method POST
`Response`	`processHistory(java.lang.String dataUUID, java.lang.String locale)` получение хода исполнения документа URL rest/api/formPlayer/getProcessExecution Method GET
`static java.util.List<SignListHeaderConfigDTO>`	`sortColumns(java.util.List<SignListHeaderConfigDTO> rows)`
`java.lang.String`	`translate(java.lang.String value, java.lang.String locale)` перевод сообщения в нужную локаль
`Response`	`translateMultiple(java.util.List<java.lang.String> value, java.lang.String locale)` перевод сообщения в нужную локаль

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FormPlayerService
```
public FormPlayerService()
```
- Method Detail
  - formatDate
```
public java.lang.String formatDate(java.lang.String format,
                                   java.lang.String date,
                                   java.lang.String locale)
```
    получение форматированного локализованного значения даты
    
    URL rest/api/formPlayer/formatDate
    Method GET
    
    Parameters:
    
    format - формат даты (смотрите формат даты для поля дата в конфигураторе)
    
    date - дата в формате yyyy-MM-dd HH:mm:ss
    
    locale - локаль
    
    Returns:
    
    форматированное значение даты
  - documentAttribute
```
public java.lang.String documentAttribute(java.lang.String dataUUID,
                                          java.lang.String field,
                                          java.lang.String locale)
```
    получение значения поля ркк документа
    URL rest/api/formPlayer/documentAttribute
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    field - поле ркк ("number", "subject", "createDate", "author", "reg_date", "doc_type", "registry")
    
    locale - локаль
    
    Returns:
    
    значение поля или пустую строку
  - getDocumentId
```
public Response getDocumentId(java.lang.String dataUUID,
                              java.lang.String locale)
```
    получение идентификатора документа по идентификатору данных по форме
    URL rest/api/formPlayer/documentIdentifier
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    locale - локаль
    
    Returns:
    
    идентификатор документа если данные по форме не найдены то возвращает http status 500 INTERNAL_SERVER_ERROR
  - getAsfDataUUID
```
public Response getAsfDataUUID(java.lang.String documentID)
```
    получение идентификатора данных по форме
    URL rest/api/formPlayer/getAsfDataUUID
    Method GET
    
    Parameters:
    
    documentID - идентификатор документа
    
    Returns:
    
    идентификатор данных по форме если данные по форме не найдены то возвращает http status 500 INTERNAL_SERVER_ERROR
  - formatDocLink
```
public java.lang.String formatDocLink(java.lang.String documentID,
                                      java.lang.String format,
                                      java.lang.String locale)
```
    получение значения компонента ссылка на документа
    URL rest/api/formPlayer/documentLink
    Method GET
    
    Parameters:
    
    documentID - идентификатор документа
    
    format - формат (смотрите настройку формата для поля ссылка на документ в конфигураторе)
    
    locale - локаль
    
    Returns:
    
    значение документа или исходный формат
  - getDocumentBases
```
public Response getDocumentBases(java.lang.String dataUUID,
                                 java.lang.String locale)
```
    получение списка оснований документа
    URL rest/api/formPlayer/getDocumentBases
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    Returns:
    
    список оснований
    {
    documentID : идентификатор документа,
    docID : идентификатор ркк документа,
    regDate : дата регистрации в формате dd-MM-yyyy HH:mm:ss,
    number : номер документа,
    subject : краткое содержание
    }
    
    если в процессе получения оснований произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - processHistory
```
public Response processHistory(java.lang.String dataUUID,
                               java.lang.String locale)
```
    получение хода исполнения документа
    URL rest/api/formPlayer/getProcessExecution
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    locale - локаль
    
    Returns:
    
    возвращает массив объектов со следующей структурой
    {
    procInstID - идентификатор процесса
    processId - идентификатор типа процесса
    name - наименование
    userName - имя исполнителя
    authorName - имя автора
    started - время в миллисекундах даты начала
    finished - время в миллисекундах даты завершения
    finishedUser - завершил
    comment - комментарий
    deleted - время в миллисекундах даты удаления
    subProcesses - массив подпроцессов с той же структурой }
    
    если в процессе получения хода исполнения произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - listResolutions
```
public Response listResolutions(java.lang.String dataUUID,
                                java.lang.String locale)
```
    получение списка резолюций документа
    URL rest/api/formPlayer/getResolutions
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    locale - локаль
    
    Returns:
    
    возвращает массив объектов со следующей структурой
    
    projectID - идентификатор проекта резолюции
    authorID - идентификатор автор
    authorName - имя автора
    items - массив пунктов резолюции
    
    item:
    name - имя пункта
    user - имя главноего исполнителя
    userRow - имена исполнителей через запятую
    finishDate - время в миллисекундах даты завершения
    
    если в процессе получения списка резолюций произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - listSigns
```
public Response listSigns(java.lang.String dataUUID,
                          int type,
                          java.lang.String locale)
```
    получение списка подписей документа
    URL rest/api/formPlayer/getSigns
    Method GET
    
    Parameters:
    
    dataUUID - идентификатор данных по форме
    
    type - тип получаемых данных, -1 = подписи, 0 - согласования, 1 - утверждения, 2 - ознакомления
    
    locale - локаль
    
    Returns:
    
    возвращает массив объектов со следующей структурой
    
    comment коммент
    currentName - текущее имя
    currentPosition - текущая должность
    date - дата подписания
    name - имя пользователя (зависит от настройки что отображать в подписи)
    position - должность (зависит от настройки что отображать в подписи)
    result - результат
    routeItemElementTypeID - тип процесса
    signType - тип подписи
    signedName - имя на момент подписи
    signedPosition - должность на момент подписи
    typeSign - эцп обычная
    
    если в процессе получения списка подписей произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - getSignHeaders
```
public Response getSignHeaders(java.lang.String headersString,
                               int type,
                               java.lang.String locale)
```
    получение локализованных заголовков списка подписей
    URL rest/api/formPlayer/getSignHeaders
    Method GET
    Возвращает отсортированный массив заголовков имеющий ту же структуру
    
    code - код поля
    name наименование
    number номер
    field поле
    en наименование колонки на английском
    kz наименование колонки на казахском
    ru наименование колонки на русском
    
    если в процессе получения списка заголовков списка подписей произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
    
    Parameters:
    
    headersString - сериализованый список заголовков
    number номер
    field поле
    en наименование колонки на английском
    kz наименование колонки на казахском
    ru наименование колонки на русском
    
    type - тип списка -1 = подписи, 0 - согласования, 1 - утверждения, 2 - ознакомления
    
    locale - локаль
  - sortColumns
```
public static java.util.List<SignListHeaderConfigDTO> sortColumns(java.util.List<SignListHeaderConfigDTO> rows)
```
  - log
```
public Response log(java.lang.String error,
                    java.lang.String formId,
                    java.lang.String asfDataId)
```
    серверное логгирование ошибок проигрывателя форм
    URL rest/api/formPlayer/log
    Method POST
    
    Parameters:
    
    error - ошибка
    
    formId - идентификатор формы
    
    asfDataId - идентификатор данных по форме
    
    если в процессе получения списка заголовков списка подписей произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - listFiles
```
public Response listFiles(java.lang.String parentID,
                          boolean getOnlyFolders,
                          boolean showHomeFolder,
                          java.util.List<java.lang.String> mimeType,
                          java.lang.String locale)
```
    Метод возвращает список файлов в папке с идентификатором parentID
    
    URL rest/api/formPlayer/listFiles
    Method GET
    
    Parameters:
    
    parentID - - идентификатор папки
    
    getOnlyFolders - - только папки
    
    showHomeFolder - - отображать домашнюю директорию пользователя
    
    mimeType - - Миме типы возвращаемых файлов,
    
    locale - - локаль пользователя
    
    Returns:
    
    json со списком файлов:
    ai_type - аи тип
    icon - иконка
    id - идентификатор
    identifier - идентификатор
    is_folder - является папкой
    mime - миме тип
    modified - изменен дата в формате yyyy-MM-dd HH:mm:ss
    name - наименование
    notEmpty - пустая ли папка если папка
    path - путь
    right - права
    size - размер в байтах
    userID - идентификатор пользователя изменившего файл
    userName имя пользователя
    
    если в процессе получения списка файлов произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR
  - translate
```
public java.lang.String translate(java.lang.String value,
                                  java.lang.String locale)
```
    перевод сообщения в нужную локаль
    
    Parameters:
    
    value - сообщение
    
    locale - локаль
    
    Returns:
    
    перевод
  - translateMultiple
```
public Response translateMultiple(java.util.List<java.lang.String> value,
                                  java.lang.String locale)
```
    перевод сообщения в нужную локаль
    
    Parameters:
    
    value - сообщение
    
    locale - локаль
    
    Returns:
    
    {value1: translatedValue1, value2: translatedValue2,}
  - getDocumentMeaningContent
```
public Response getDocumentMeaningContent(java.lang.String asfDataUUID,
                                          java.lang.String documentId)
```
    получение значений полей значащих содержимых
    
    Parameters:
    
    documentId - идентификатор документа (обязателен если не указан asfDataUUID)
    
    asfDataUUID - идентификатор данных по форме (обязателен если не указан documentId)
    
    Returns:
    
    значение
  - getDocumentMeaningContents
```
public Response getDocumentMeaningContents(java.lang.String[] documentId)
```
    получение значений полей значащих содержимых
    
    Parameters:
    
    documentId - идентификатор документа, можно указывать несколько например documentId=documentId1&documentId=documentId2
    
    Returns:
    
    значение
  - getUserID
```
public java.lang.String getUserID()
```
  - getCustomComponent
```
public Response getCustomComponent(java.lang.String code)
```
    получение информации о пользовательском компоненте
    
    Parameters:
    
    code - код компонента
    
    Returns:
    
    компонент
  - getCompletionForm
```
public Response getCompletionForm(java.lang.String completionFormID)
```
    получения описания формы завершения
    
    URL rest/api/formPlayer/getCompletionForm
    Method GET
    
    Parameters:
    
    completionFormID - - UUID формы завершения.
    
    Returns:
    
    json со списком файлов:
    СompletionFormType-Тип
    СompletionFormInfo [
    -button_name - Название кнопки для создания результата завершения работы
    -registryID
    -registryCode
    -formCode
    -formID
    -registered- Только зарегистрированные: true/false
    -child - Только дочерние: true/false
    ]
    CompletionFormID - Код
    СompletionFormName - Название
    is_result_free - Требует подтверждения результата: true/false

Class FormPlayerService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FormPlayerService

Method Detail

formatDate

documentAttribute

getDocumentId

getAsfDataUUID

formatDocLink

getDocumentBases

processHistory

listResolutions

listSigns

getSignHeaders

sortColumns

log

listFiles

translate

translateMultiple

getDocumentMeaningContent

getDocumentMeaningContents

getUserID

getCustomComponent

getCompletionForm