ru.metrika4j.entity
Interface EntityApi<T extends Entity<K>,K>

All Known Subinterfaces:

FilterApi, GoalApi, OperationApi

public interface EntityApi<T extends Entity<K>,K>

Абстрактный API для работы с объектами-сущностями (целями, фильтрами, правами доступа, операциями)

Author:

Artur Suilin

Method Summary

T	createEntity(int counterId, T source) Создает объект-сущность на базе заданного образца (т.е. на вход дается объект-сущность с заполненным полями, Метрика создаёт такой же)
void	deleteEntity(int counterId, K entityId) Удаляет из Метрики объект-сущность
T[]	getEntities(int counterId) Получить все объекты-сущности для заданного счетчика
T	getEntity(int counterId, K entityId) Получить все объекты-сущность с заданным идентификатором для заданного счетчика
T	updateEntity(int counterId, T entity) Изменяет объект-сущность в Метрике, основываясь на заданном образце.

Method Detail

getEntities

T[] getEntities(int counterId)

Получить все объекты-сущности для заданного счетчика

getEntity

T getEntity(int counterId,
            K entityId)

Получить все объекты-сущность с заданным идентификатором для заданного счетчика

createEntity

T createEntity(int counterId,
               T source)

Создает объект-сущность на базе заданного образца (т.е. на вход дается объект-сущность с заполненным полями, Метрика создаёт такой же)

Parameters:

counterId - Идентификатор счетчика

source - Образец, описывающий сущность.

Returns:

Созданная сущность, загруженная из Метрики. У неё должны быть заполнены все поля, заданные в образце, плюс Метрика может проставить значения некоторых полей автоматически

updateEntity

T updateEntity(int counterId,
               T entity)

Изменяет объект-сущность в Метрике, основываясь на заданном образце.

Parameters:

counterId - Идентификатор счетчика

entity - Образец, описывающий сущность.

Returns:

Измененная сущность, загруженная из Метрики. У неё должны быть заполнены все поля, заданные в образце, плюс Метрика может проставить значения некоторых полей автоматически

deleteEntity

void deleteEntity(int counterId,
                  K entityId)

Удаляет из Метрики объект-сущность

Parameters:

counterId - Идентификатор счетчика

entityId - Идентификатор сущности