DepartmetnsService (CommonRestServices API)

java.lang.Object
- kz.arta.synergy.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

Constructors
Constructor and Description

DepartmetnsService()

Constructors
Constructor and Description
`DepartmetnsService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 formCode, java.lang.String fieldName, java.lang.String value, java.lang.String locale)` ВНИМАНИЕ!
`java.lang.String`	`getDepartmentsContent(java.lang.String departmentID, boolean onlyPosition, boolean onlyDepartments, java.lang.String locale)` Метод используется для получения информации о департаменте (подразделения и должности) Тип: GET URL: rest/api/departments/content
`java.lang.String`	`getUserID()`
`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
`Response`	`searchDepartments(java.util.List<java.lang.String> codes, java.util.List<java.lang.String> names, int recordsCount, int startRecord, java.lang.String codeSearchTypeP, java.lang.String nameSearchTypeP, java.lang.String deleted, java.lang.String locale)` Метод поиска подразделений URL: /rest/api/departments/search Тип: GET Метод принимает следующие параметры: `name` - название подразделения (необяз.), может быть передано несколько значений `pointer_code` - код показателя (необяз.), может быть передано несколько значений `recordsCount` - количество результатов, которые необходимо вернуть (по умолчанию 30).

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 - локаль, 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 - локаль (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 - локаль, 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)
  - getDepartmentsContent
```
public java.lang.String getDepartmentsContent(java.lang.String departmentID,
                                              boolean onlyPosition,
                                              boolean onlyDepartments,
                                              java.lang.String locale)
```
    Метод используется для получения информации о департаменте (подразделения и должности)
    Тип: GET
    URL: rest/api/departments/content
    Parameters:
    
    departmentID - идентификатор департамента
    
    onlyPosition - true - отображение должностей только одного департамента (по умолчанию false)
    
    onlyDepartments - true - отображение подотделов только одного департамента (по умолчанию false)
    
    locale - локаль
    
    Returns:
    Пример возвращаемого массива:
    [ { "departments": [ { "departmentID": "7b097e72-e303-487f-83a1-cb76397abd57", "departmentName": "Департамент технологий", "hasChildDepartments" : false, "pointerCode" : "code", "departmentHead": { "headID": "f9b0b304-c856-4bcf-8615-e13cded16a14", "headName": "Иванов И.И." } }, { "departmentID": "8ii056e72-e563-667f-14j7-cb31867qwe66", "departmentName": "Департамент развития", "hasChildDepartments" : true, "departmentHead": { "headID": "179bda2e-6d55-4ed5-b1be-890ffad280ba", "headName": "Петров П.П." } } ], "positions": [ { "positionID": "dc890ecf-e340-4ada-b7e6-d6541486a599", "positionName": "Маркетолог", "code": "shifr2", "pointerCode": "code2", "employees": [ { "employeeID": "f40b665c-f1f4-40b3-bdc5-291911def539", "employeeName": "Попов П.В." }, { "employeeID": "22cc3118-3bcd-4543-98b4-a30982ba5c2a", "employeeName": "Сидоров С.В." }, { "employeeID": "414acd59-aaf8-4202-8c00-b39e1fe73bbc", "employeeName": "Орлов О.О." } ] }, { "positionID": "2d9a641d-178c-4b05-b2f4-a231958718fd", "positionName": "Финансовый аналитик", "code": "shifr1", "pointerCode": "code1", "employees": [ { "employeeID": "c4ddd6b1-ade2-4ee2-ace5-aaec6a81d02a", "employeeName": "Мартынов М.М." }, { "employeeID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "employeeName": "Быков Г.Г." } ] }, { "positionID": "22a48f88-199a-4398-8eb6-15ba8ef35deb", "positionName": "Юрист", "code": "shifr3", "pointerCode": "code3", "employees": [ { "employeeID": "a2ba229b-366f-4d9c-b8bd-31742a7a519a", "employeeName": "Мусина А.М." }, { "employeeID": "a5b67a57-bcba-4513-bc2d-089400457a53", "employeeName": "Дарбаева Г.Г." }, { "employeeID": "ca936f83-3d4e-4c09-b393-9e548d18bc04", "employeeName": "Жакин Н.Б." }, { "employeeID": "ff666f77-7ii8-5b09-o565-2f555v33qq11", "employeeName": "Васильев Г.В." } ] } ] } ]
    departments - массив подотделов данного департамента:
    departmentID - UUID подразделения
    departmentName - название подотдела на языке локали, переданной в параметре locale
    hasChildDepartments - есть ли дочерние департаменты
    pointerCode - код для показателей департамента
    departmentHead - руководитель подотдела:
    headID - UUID руководителя
    headName - Ф.И.О. руководителя в формате "Фамилия И.О."
    positions - массив должностей данного департамента:
    positionID - UUID должности
    positionName - название должности на языке локали, переданной в параметре locale
    pointerCode - код для показателей должности
    code - шифр должности
    type - тип должности
    employees - массив сотрудников на данной должности:
    employeeID - UUID сотрудника
    employeeName - Ф.И.О. сотрудника в формате "Фамилия И.О."
  - 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 - локаль пользователя
    
    Returns:
    
    список json объектов с информацией о карточке подразделения, для каждой карточки присутствуют поля:
    form-uuid uuid формы
    formCode - код формы
    name название карточки
    editable true - есть право наредактирование, иначе - false
    data-uuid uuid данных по данной карточке
    mandatory true - карточкая обязательна для заполнения, иначе - false
    
    See Also:
    
    APIFormsService.save(String, String, String, String, String, String)
  - getDepartmentsByFieldValue
```
public java.lang.String getDepartmentsByFieldValue(java.lang.String formUUID,
                                                   java.lang.String formCode,
                                                   java.lang.String fieldName,
                                                   java.lang.String value,
                                                   java.lang.String locale)
```
    ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный
    
    Находит подразделения по значению поля дополнительной карточки и возвращает список их идентификаторов
    
    URL rest/api/departments/get_by_field_value
    Method GET
    
    Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы). В дополнительной карточке подразделения может храниться идентификатор соответствующего подразделения в сторонней системе, этот метод позволит найти идентификатор подразделения в нашей системе по его идентификатору из сторонней системы
    
    Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).
    
    Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.
    
    Parameters:
    
    formUUID - uuid формы, по полю которой необходимо произвести поиск
    
    formCode - code формы, по полю которой необходимо произвести поиск
    
    fieldName - название поля, по которому необходимо произвести поиск
    
    value - значение поля
    
    locale - локаль пользователя
    
    Returns:
    
    список, состоящий из идентификаторов подразделений
  - getUserID
```
public java.lang.String getUserID()
```
  - searchDepartments
```
public Response searchDepartments(java.util.List<java.lang.String> codes,
                                  java.util.List<java.lang.String> names,
                                  int recordsCount,
                                  int startRecord,
                                  java.lang.String codeSearchTypeP,
                                  java.lang.String nameSearchTypeP,
                                  java.lang.String deleted,
                                  java.lang.String locale)
```
    Метод поиска подразделений
    
    URL: /rest/api/departments/search
    
    Тип: GET
    
    Метод принимает следующие параметры:
    - name - название подразделения (необяз.), может быть передано несколько значений
    - pointer_code - код показателя (необяз.), может быть передано несколько значений
    - recordsCount - количество результатов, которые необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100
    - startRecord - номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)
    - searchTypeN - тип сравнения для параметра name (по умолчанию partial). Может принимать следующие значения:
      
      exact - точное совпадение поискового запроса и значения поля
      
      partial - вхождение поискового запроса в значение поля
    - searchTypePC - тип сравнения для параметра pointer_code (по умолчанию exact). Может принимать следующие значения:
      
      exact - точное совпадение поискового запроса и значения поля
      
      partial - вхождение поискового запроса в значение поля
    - deleted - включать ли в результат поиска удаленные департаменты. Допустимые значения: true или false
    - locale - локаль пользователя. Данный параметр учитывается при поиске по названию должности
    В случае успешного выполнения метод возвращает массив строк, являющихся идентификаторами подразделений.
    
    Пример запроса:
    /rest/api/departments/search?pointer_code=dep1&pointer_code=dep3
    Пример возвращаемого ответа:
    [ "rgg66d1-ad54-5462-aef5-aggrr55fd02a", "vgikwj4c6-88gh-ef44-3ffe-oepjfee5d6" ]
    При указании одновременно разных параметров результат запроса будет связан логическим И.
    
    Пример запроса: /rest/api/departments/search?pointer_code=dep5&name=Департамент5
    
    А при указании одновременно одинаковых параметров, результат будет производится по логическому ИЛИ.
    
    Пример запроса: /rest/api/departments/search?pointer_code=code1&pointer_code=code2
    
    В случае если по переданным входным параметрам ничего не найдено, сервер возвращает пустой массив.

Class DepartmetnsService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DepartmetnsService

Method Detail

saveDepartment

deleteDepartment

getDepartment

getDepartmentsAsList

getDepartmentsContent

getDepartmentCards

getDepartmentsByFieldValue

getUserID

searchDepartments