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

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

public class MapService
extends java.lang.Object

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

Constructor Summary

MapService()

Method Summary

java.lang.String	addPointersToMap(java.lang.String mapID, java.util.List<java.lang.String> pointerID) Метод добавляет показатели на карту URL rest/api/maps/add_pointers Method POST
java.lang.String	createMap(java.lang.String name, boolean isPublic, java.lang.String parentID, int width, int height) Метод создает карту показателей URL rest/api/maps/create Method POST
java.lang.String	deleteMap(java.lang.String mapID) Метод удаляет карту показателей URL rest/api/maps/delete Method GET
java.lang.String	get(java.lang.String mapID) Метод возвращает информацию о карте показателей URL rest/api/maps/get Method GET
java.lang.String	getHost()
java.lang.String	getLocale()
java.lang.String	list(java.lang.String parentMapID) Метод возвращает список карт URL rest/api/maps/list Method GET
java.lang.String	removePointerFromMap(java.lang.String mapID, java.lang.String pointerID) Метод удаляет показатель с карты URL rest/api/maps/remove_pointer Method GET
java.lang.String	save(java.lang.String name, boolean isPublic, java.lang.String parentID, int width, int height, java.lang.String mapID) Метод изменяет карту показателей URL rest/api/maps/save Method POST

Methods inherited from class java.lang.Object

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

Constructor Detail

MapService

public MapService()

Method Detail

createMap

public java.lang.String createMap(java.lang.String name,
                                  boolean isPublic,
                                  java.lang.String parentID,
                                  int width,
                                  int height)

Метод создает карту показателей

URL rest/api/maps/create
Method POST

Parameters:

name - Название карты

isPublic - true - доступна всем пользователям, иначе - только тем, кому даны права

parentID - идентификатор родительской карты (значение по-умолчанию корневой элемент "Стратегия")

width - ширина карты (значение по-умолчанию MapConstants.DEFAULT_WIDTH)

height - высота карты (значение по-умолчанию MapConstants.DEFAULT_HEIGHT)

Returns:

save

public java.lang.String save(java.lang.String name,
                             boolean isPublic,
                             java.lang.String parentID,
                             int width,
                             int height,
                             java.lang.String mapID)

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

URL rest/api/maps/save
Method POST

Parameters:

name - Название карты

isPublic - true - доступна всем пользователям, иначе - только тем, кому даны права

parentID - идентификатор родительско карты (значение по-умолчанию корневой элемент "Стратегия")

width - ширина карты (значение по-умолчанию MapConstants.DEFAULT_WIDTH)

height - высота карты (значение по-умолчанию MapConstants.DEFAULT_HEIGHT)

mapID - идентификатор карты

Returns:

See Also:

MapConstants.DEFAULT_WIDTH, MapConstants.DEFAULT_HEIGHT

deleteMap

public java.lang.String deleteMap(java.lang.String mapID)

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

URL rest/api/maps/delete
Method GET

Parameters:

mapID - идентификатор карты

Returns:

get

public java.lang.String get(java.lang.String mapID)

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

URL rest/api/maps/get
Method GET

Parameters:

mapID - идентификатор карты

Returns:

информацию о карте, см метод MapWrapper#getMapJson

See Also:

MapWrapper.getMapJson(arta.synergy.web.common.client.data.pointers.maps.Map, String)

list

public java.lang.String list(java.lang.String parentMapID)

Метод возвращает список карт

URL rest/api/maps/list
Method GET

Parameters:

parentMapID - идентификатор родительской карты (значение по-умолчанию корневой элемент карт "Стратегия")

Returns:

информацию о картах как список json объектов, см. метод MapWrapper#getTreeMapJson

See Also:

MapWrapper.getTreeMapJson(arta.synergy.web.common.client.data.pointers.maps.TreeMap, String)

addPointersToMap

public java.lang.String addPointersToMap(java.lang.String mapID,
                                         java.util.List<java.lang.String> pointerID)

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

URL rest/api/maps/add_pointers
Method POST

Parameters:

mapID - идентификатор карты

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

Returns:

removePointerFromMap

public java.lang.String removePointerFromMap(java.lang.String mapID,
                                             java.lang.String pointerID)

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

URL rest/api/maps/remove_pointer
Method GET

Parameters:

mapID - идентификатор карты

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

Returns:

getHost

public java.lang.String getHost()

getLocale

public java.lang.String getLocale()