kz.arta.synergy.server.api.rest.map
Class PointersService

java.lang.Object
  kz.arta.synergy.server.api.rest.map.PointersService

public class PointersService
extends java.lang.Object

Created by IntelliJ IDEA. User: topa Date: 13.02.14 Time: 12:20 To change this template use File | Settings | File Templates.

Constructor Summary

PointersService()

Method Summary

java.lang.String	createPointer() Метод создает/изменяет показатель URL rest/api/pointers/save Method GET Метод предназначен для создания/изменения показателей типов: базовый, расчитываемый, внешний.
java.lang.String	deletePointer(java.lang.String pointerID) Метод удаляет показатель URL rest/api/pointers/delete Method GET
java.lang.String	getHost()
java.lang.String	getLocale()
java.lang.String	search(java.lang.String search, int type, boolean loadFullInfo, int partNumber, int countInPart) Метод возвращает список показателей, с возможностью поиска URL rest/api/pointers/delete Method GET

Methods inherited from class java.lang.Object

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

Constructor Detail

PointersService

public PointersService()

Method Detail

createPointer

public java.lang.String createPointer()

Метод создает/изменяет показатель

URL rest/api/pointers/save
Method GET

Метод предназначен для создания/изменения показателей типов: базовый, расчитываемый, внешний. Тип создаваемого показателя зависит от параметра type, набор параметров зависит от типа показателя. Ниже перечислены все возможные параметры для каждого типа.
Обязательные для передачи параметры отмечены *

Базовый
pointerID идентификатор показателя, необходимо передавать для обновления существующего показателя. Для создания нового - передавать параметр не нужно.
type* тип показателя, значение должно быть 2
name* название показателя
code код показателя
measure* единица измерения значений показателя
update_type* Тип обновления значений показателя. Может принимать значения:

• 1 - ежедневно
• 2 - по дням недели
• 3 - по дням месяца
• 4 - ежеквартально

update_days значение (одно или несколько) данного параметра необходимо передать, только если update_type=2 или update_type=3. Для update_type=2 - это должны быть номера дней недели от 1 до 7, для дней месяца - номера дней месяца от 1 до 31
resUserID* идентификатор пользователя, ответственного за ввод значения показателя
default_value значение показателя по-умолчанию
dict_code код справочника (необходимо в том случае если значения показателя должны выбираться из справочника, а не вводиться вручную)
min_value минимальное возможное значение показателя (число либо код другого показателя)
max_value максимальное возможное значение показателя (число либо код другого показателя)

Внешний
pointerID идентификатор показателя, необходимо передавать для обновления существующего показателя. Для создания нового - передавать параметр не нужно.
type* тип показателя, значение должно быть 4
name* название показателя
code код показателя
measure* единица измерения значений показателя
min_value минимальное возможное значение показателя (число либо код другого показателя)
max_value максимальное возможное значение показателя (число либо код другого показателя)

Расчитываемый
pointerID идентификатор показателя, необходимо передавать для обновления существующего показателя. Для создания нового - передавать параметр не нужно.
type* тип показателя, значение должно быть 1
name* название показателя
code код показателя
measure* единица измерения значений показателя
formula* формула расчета показателя

Returns:

deletePointer

public java.lang.String deletePointer(java.lang.String pointerID)

Метод удаляет показатель

URL rest/api/pointers/delete
Method GET

Parameters:

pointerID - идентификатор показателя

Returns:

search

public java.lang.String search(java.lang.String search,
                               int type,
                               boolean loadFullInfo,
                               int partNumber,
                               int countInPart)

Метод возвращает список показателей, с возможностью поиска

URL rest/api/pointers/delete
Method GET

Parameters:

search - поисковая строка (может отсутствовать для получения всего списка)

type - тип показателей: 2 - базовый, 4 - внешний, 1- расчитываемый (может отсутствовать для получения полного списка)

loadFullInfo - необходимо передать значение данного параметра true, чтобы метод вернул все поля показателей. Иначе возвращаются только поля общие для показателей всех типов: идентификатор, название, код, единица измерения

partNumber - номер страницы возвращаемых результатов (отсчет с 0)

countInPart - количество результатов в одной странице

Returns:

json следующего формата

     
{
     
    "pages_count": общее количество страниц, соответствующее данным параметрам поиска
     
    "list": список показателей, для каждого показателя возвращаются данные согласно PointerWrapper#getPointerJson
     
}
 

See Also:

PointerWrapper.getPointerJson(arta.synergy.web.common.client.data.pointers.Pointer)

getHost

public java.lang.String getHost()

getLocale

public java.lang.String getLocale()