kz.arta.synergy.server.api.rest.filecabinet
Class DepartmetnsService

java.lang.Object
  kz.arta.synergy.server.api.rest.filecabinet.DepartmetnsService

public class DepartmetnsService
extends java.lang.Object

Created by IntelliJ IDEA.
User: topa
Date: 23.08.13
Time: 18:30
Содержит методы для управления департаментами - создание/изменение, удаление, получение информации о департаменте
Корневым подразделением орг структуры является депертамент, создаваемый по умолчанию, он имеет идентификатор "1".

Constructor Summary

DepartmetnsService()

Method Summary

java.lang.String	deleteDepartment(java.lang.String departmentID, java.lang.String locale) Метод удаляет подразделение URL rest/api/departments/delete Method GET
java.lang.String	getDepartment(java.lang.String departmentID, java.lang.String locale) Метод возвращает информацию о подразделении подразделение URL rest/api/departments/get Method GET
java.lang.String	getDepartmentCards(java.lang.String departmentID, java.lang.String locale) Возвращает список дополнительных карточек для данного подразделения URL rest/api/departments/get_cards Method GET Для заполнения полей карточки надо использовать метод APIFormsService#save
java.lang.String	getDepartmentsAsList(java.lang.String locale, java.lang.Integer partNumber, java.lang.Integer countInPart) Метод возвращает список подразделений (без учета структуры) URL rest/api/departments/list Method GET * @return Список департаментов, описание полей департамента смотрите в методе FileCabinetWrapper#getDepartmentasJson
java.lang.String	getDepartmentsByFieldValue(java.lang.String formUUID, java.lang.String fieldName, java.lang.String value, java.lang.String locale) Находит подразделения по значению поля дополнительной карточки и возвращает список их идентификаторов URL rest/api/departments/get_by_field_value Method GET Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы).
java.lang.String	saveDepartment(java.lang.String nameRu, java.lang.String nameKz, java.lang.String nameEn, java.lang.String positionNameRu, java.lang.String positionNameKz, java.lang.String positionNameEn, java.lang.String pointersCode, java.lang.String departmentID, java.lang.String parentDepartmentID, int number, java.lang.String locale) Метод создает/изменяет подразделение орг структуры URL rest/api/departments/save Method POST

Methods inherited from class java.lang.Object

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

Constructor Detail

DepartmetnsService

public DepartmetnsService()

Method Detail

saveDepartment

public java.lang.String saveDepartment(java.lang.String nameRu,
                                       java.lang.String nameKz,
                                       java.lang.String nameEn,
                                       java.lang.String positionNameRu,
                                       java.lang.String positionNameKz,
                                       java.lang.String positionNameEn,
                                       java.lang.String pointersCode,
                                       java.lang.String departmentID,
                                       java.lang.String parentDepartmentID,
                                       int number,
                                       java.lang.String locale)

Метод создает/изменяет подразделение орг структуры

URL rest/api/departments/save
Method POST

Parameters:

nameRu - Название подразделения на русском языке, FormParam

nameKz - Название подразделения на казахском языке, FormParam

nameEn - Название подразделения на английском языке, FormParam

positionNameRu - Название должности руководителя на русском языке, FormParam

positionNameKz - Название должности руководителя на казахском языке, FormParam

positionNameEn - Название должности руководителя на английском языке, FormParam

pointersCode - код показателя, FormParam

number - порядковый номер подразделения

departmentID - UUID подразделения (для создания нового подразделения необходимо передать null), FormParam

parentDepartmentID - UUID родительского подразделения, FormParam

locale - локаль (по-умолчанию ru), QueryParam

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке. В случае успешного выполнения так же возвращается departmentID созданного/измененного подразделения.

deleteDepartment

public java.lang.String deleteDepartment(java.lang.String departmentID,
                                         java.lang.String locale)

Метод удаляет подразделение

URL rest/api/departments/delete
Method GET

Parameters:

departmentID - UUID подразделения, которое надо удалить (QueryParam)

locale - локаль пользователя, выполняющего действие (по-умолчанию ru) (QueryParam)

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка), errorMessage - сообщение об ошибке/успешном выполнении

getDepartment

public java.lang.String getDepartment(java.lang.String departmentID,
                                      java.lang.String locale)

Метод возвращает информацию о подразделении подразделение

URL rest/api/departments/get
Method GET

Parameters:

departmentID - UUID подразделения, QueryParam

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

Returns:

json, описание полей см в FileCabinetWrapper#getDepartmentasJson

See Also:

FileCabinetWrapper.getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)

getDepartmentsAsList

public java.lang.String getDepartmentsAsList(java.lang.String locale,
                                             java.lang.Integer partNumber,
                                             java.lang.Integer countInPart)

Метод возвращает список подразделений (без учета структуры)

URL rest/api/departments/list
Method GET
* @return Список департаментов, описание полей департамента смотрите в методе FileCabinetWrapper#getDepartmentasJson

See Also:

FileCabinetWrapper.getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)

getDepartmentCards

public java.lang.String getDepartmentCards(java.lang.String departmentID,
                                           java.lang.String locale)

Возвращает список дополнительных карточек для данного подразделения

URL rest/api/departments/get_cards
Method GET
Для заполнения полей карточки надо использовать метод APIFormsService#save

Parameters:

departmentID - UUID подразделения

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

Returns:

список json объектов с информацией о карточке подразделения, для каждой карточки присутствуют поля:
form-uuid uuid формы
name название карточки
editable true - есть право наредактирование, иначе - false
data-uuid uuid данных по данной карточке
mandatory true - карточкая обязательна для заполнения, иначе - false

See Also:

kz.arta.synergy.server.api.rest.asforms.APIFormsService#save(String, String, String)

getDepartmentsByFieldValue

public java.lang.String getDepartmentsByFieldValue(java.lang.String formUUID,
                                                   java.lang.String fieldName,
                                                   java.lang.String value,
                                                   java.lang.String locale)

Находит подразделения по значению поля дополнительной карточки и возвращает список их идентификаторов

URL rest/api/departments/get_by_field_value
Method GET

Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы). В дополнительной карточке подразделения может храниться идентификатор соответствующего подразделения в сторонней системе, этот метод позволит найти идентификатор подразделения в нашей системе по его идентификатору из сторонней системы

Parameters:

formUUID - uuid формы, по полю которой необходимо произвести поиск

fieldName - название поля, по которому необходимо произвести поиск

value - значение поля

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

Returns:

список, состоящий из идентификаторов подразделений