com.trackstudio.soap.service.filter
Class Filter

java.lang.Object
  extended by com.trackstudio.soap.service.filter.Filter

public class Filter
extends java.lang.Object

Класс описывает web-сервис для работы с приложенными фильтрами


Constructor Summary
Filter()
           
 
Method Summary
 java.lang.String cloneTaskFilter(java.lang.String sessionId, java.lang.String filterId, java.lang.String currentTaskId)
          Создает копию указанного фильтра для задач (клонирует)
 java.lang.String cloneUserFilter(java.lang.String sessionId, java.lang.String currentUserId, java.lang.String filterId)
          Создает копию указанного фильтра для пользоватлея (клонирует)
 java.lang.String createSubscription(java.lang.String sessionId, java.lang.String name, java.lang.String userId, java.lang.String groupId, java.lang.String taskId, java.lang.String filterId)
          Создает новую подписку
 java.lang.String createTaskFilter(java.lang.String sessionId, java.lang.String name, java.lang.String description, boolean priv, java.lang.String taskId, java.lang.String ownerId, java.lang.String preferences)
          Создает фильтр для задач
 java.lang.String createUserFilter(java.lang.String sessionId, java.lang.String toUserId, java.lang.String name, java.lang.String description, boolean priv, java.lang.String preferences)
          Создает фильтр для полдьзователей
 void deleteTaskFilter(java.lang.String sessionId, java.lang.String filterId)
          Удаляет фильтр для задач
 void deleteUserFilter(java.lang.String sessionId, java.lang.String filterId)
          Удаляет фильтр для пользователей
 NotificationBean[] getAllNotificationList(java.lang.String sessionId, java.lang.String filterId)
          Возвращает список оповещений, созданных для данного фильтра
 SubscriptionBean[] getAllSubscriptionList(java.lang.String sessionId, java.lang.String filterId)
          Возвращает список всех подписок для фильтра
 FilterBean[] getAllTaskFilterList(java.lang.String sessionId, java.lang.String taskId)
          Возвращает список фильтров задач для задачи taskId, которые доступны текущему пользователю, включая фильтры, созданные для подзадач
 FilterBean[] getAllUserFilterList(java.lang.String sessionId, java.lang.String userId)
          Возвращает список фильтров пользоватлелей для пользователя ownerId, которые доступны пользователю currentUserId, включая фильтры, созданные для дочерних пользовталей
 java.lang.String getCurrentFilterId(java.lang.String sessionId, java.lang.String taskId)
          Возвращает текущий выбранный пользователем фильтр на уровне задачи taskId
 java.lang.String getCurrentUserFilterId(java.lang.String sessionId, java.lang.String userId)
          Возвращает текущий выбранный пользователем фильтр на уровне пользователя userId
 NotificationBean[] getNotificationList(java.lang.String sessionId, java.lang.String filterId, java.lang.String taskId)
          Возвращает список оповещений для определенного фильтра, которые могу рассылаться для указанной задачи.
 NotificationBean[] getPrstatusNotificationList(java.lang.String sessionId, java.lang.String prstatusId)
          Возвращает список нотификаций для заданного статуса
 SubscriptionBean[] getPrstatusSubscriptionList(java.lang.String sessionId, java.lang.String prstatusId)
          Возвращает список подписок для заданного статуса
 SubscriptionBean[] getSubscriptionList(java.lang.String sessionId, java.lang.String filterId, java.lang.String taskId)
          Возвращает список подписок для задачи и фильтра
 FilterBean[] getTaskFilterList(java.lang.String sessionId, java.lang.String taskId)
          Возвращает список фильтров задач для задачи taskId, которые доступны текущему пользователю
 TaskFvalueBean getTaskFValue(java.lang.String sessionId, java.lang.String filterId)
          Возвращает параметры для фильтра задач
 FilterBean[] getUserFilterList(java.lang.String sessionId, java.lang.String userId)
          Возвращает список фильтров пользоватлелей для пользователя ownerId, которые доступны пользователю currentUserId
 UserFvalueBean getUserFValue(java.lang.String sessionId, java.lang.String filterId)
          Возвращает параметры для фильтра пользователя
 NotificationBean[] getUserNotificationList(java.lang.String sessionId, java.lang.String userId)
          Возвращает список нотификаций для заданного пользователя
 SubscriptionBean[] getUserSubscriptionList(java.lang.String sessionId, java.lang.String userId)
          Возвращает список подписок для заданного пользователя
 java.lang.String setCurrentFilter(java.lang.String sessionId, java.lang.String taskId, java.lang.String filterId)
          Устанавливает текущий выбранный фильтр для текущего пользователя или задачи
 java.lang.String setCurrentUserFilter(java.lang.String sessionId, java.lang.String userId, java.lang.String filterId)
          Устанавливает текущий выбранный фильтр для пользователя или задачи
 void setNotification(java.lang.String sessionId, java.lang.String name, java.lang.String filterId, java.lang.String userId, java.lang.String groupId, java.lang.String taskId)
          Создает уведомление о событиях
 void setTaskFValue(java.lang.String sessionId, java.lang.String filterId, TaskFvalueBean map)
          Сохраняет параметры фильтра
 void setUserFValue(java.lang.String sessionId, java.lang.String filterId, UserFvalueBean map)
          Сохраняет параметры фильтра
 void unsetNotification(java.lang.String sessionId, java.lang.String notificationId)
          Удаляет уведомление о событиях
 void unSubscribe(java.lang.String sessionId, java.lang.String subscriptionId)
          Удаляет подписку
 void updateNotification(java.lang.String sessionId, java.lang.String notificationId, java.lang.String filterId, java.lang.String name, java.lang.String templateId, java.lang.String condition)
          Произодится редактирование уведомления о событиях
 void updateSubscription(java.lang.String sessionId, java.lang.String subscriptionId, java.lang.String name, java.lang.String filterId, java.lang.String templateId, long startDate, long stopDate, long nextRun, int interval)
          Редактирует существующую подписку
 void updateTaskFilter(java.lang.String sessionId, java.lang.String filterId, java.lang.String name, java.lang.String description, boolean priv, java.lang.String preferences)
          Редактирование фильтра для задач
 void updateUserFilter(java.lang.String sessionId, java.lang.String filterId, java.lang.String name, java.lang.String description, boolean priv, java.lang.String preferences)
          Редактирование фильтра для задач
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Filter

public Filter()
Method Detail

getUserNotificationList

public NotificationBean[] getUserNotificationList(java.lang.String sessionId,
                                                  java.lang.String userId)
                                           throws java.lang.Exception
Возвращает список нотификаций для заданного пользователя

Parameters:
sessionId - сессия пользователя
userId - ID пользователя, для которого достаются нотификации
Returns:
Спсок нотификаций
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredNotificationBean

getPrstatusNotificationList

public NotificationBean[] getPrstatusNotificationList(java.lang.String sessionId,
                                                      java.lang.String prstatusId)
                                               throws java.lang.Exception
Возвращает список нотификаций для заданного статуса

Parameters:
sessionId - сессия пользователя
prstatusId - ID статуса, для которого достаются нотификации
Returns:
Спсок нотификаций
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredNotificationBean

getUserSubscriptionList

public SubscriptionBean[] getUserSubscriptionList(java.lang.String sessionId,
                                                  java.lang.String userId)
                                           throws java.lang.Exception
Возвращает список подписок для заданного пользователя

Parameters:
sessionId - сессия пользователя
userId - ID пользователя, для которого достаются подписки
Returns:
Спсок нотификаций
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredSubscriptionBean

getPrstatusSubscriptionList

public SubscriptionBean[] getPrstatusSubscriptionList(java.lang.String sessionId,
                                                      java.lang.String prstatusId)
                                               throws java.lang.Exception
Возвращает список подписок для заданного статуса

Parameters:
sessionId - сессия пользователя
prstatusId - ID статуса, для которого достаются подписки
Returns:
Спсок нотификаций
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredSubscriptionBean

getTaskFilterList

public FilterBean[] getTaskFilterList(java.lang.String sessionId,
                                      java.lang.String taskId)
                               throws java.lang.Exception
Возвращает список фильтров задач для задачи taskId, которые доступны текущему пользователю

Parameters:
sessionId - сессия пользователя
taskId - ID задачи, на уровне которой созданы фильтры (по дереву задач)
Returns:
Спсок фильтров
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredFilterBean

getAllTaskFilterList

public FilterBean[] getAllTaskFilterList(java.lang.String sessionId,
                                         java.lang.String taskId)
                                  throws java.lang.Exception
Возвращает список фильтров задач для задачи taskId, которые доступны текущему пользователю, включая фильтры, созданные для подзадач

Parameters:
sessionId - сессия пользователя
taskId - ID задачи, на уровне которой созданы фильтры (по дереву задач)
Returns:
Спсок фильтров
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredFilterBean

getTaskFValue

public TaskFvalueBean getTaskFValue(java.lang.String sessionId,
                                    java.lang.String filterId)
                             throws java.lang.Exception
Возвращает параметры для фильтра задач

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, для которого получаем параметры
Returns:
параметры для фильтра в виде объекта UserFValue
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredTaskFValueBean

getUserFValue

public UserFvalueBean getUserFValue(java.lang.String sessionId,
                                    java.lang.String filterId)
                             throws java.lang.Exception
Возвращает параметры для фильтра пользователя

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, для которого получаем параметры
Returns:
параметры для фильтра в виде объекта UserFValue
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredTaskFValueBean

setTaskFValue

public void setTaskFValue(java.lang.String sessionId,
                          java.lang.String filterId,
                          TaskFvalueBean map)
                   throws java.lang.Exception
Сохраняет параметры фильтра

Parameters:
sessionId - сессия пользователя
filterId - Id фильтра, параметры которого сохраняются
map - Сохраняемые параметры
Throws:
GranException - при необходимости
java.lang.Exception

setUserFValue

public void setUserFValue(java.lang.String sessionId,
                          java.lang.String filterId,
                          UserFvalueBean map)
                   throws java.lang.Exception
Сохраняет параметры фильтра

Parameters:
sessionId - сессия пользователя
filterId - Id фильтра, параметры которого сохраняются
map - Сохраняемые параметры
Throws:
GranException - при необходимости
java.lang.Exception

getSubscriptionList

public SubscriptionBean[] getSubscriptionList(java.lang.String sessionId,
                                              java.lang.String filterId,
                                              java.lang.String taskId)
                                       throws java.lang.Exception
Возвращает список подписок для задачи и фильтра

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, для которого получаем подписки
taskId - ID задачи, для которой получаем подписки
Returns:
список подписок
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredSubscriptionBean

getAllSubscriptionList

public SubscriptionBean[] getAllSubscriptionList(java.lang.String sessionId,
                                                 java.lang.String filterId)
                                          throws java.lang.Exception
Возвращает список всех подписок для фильтра

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, для которого получаем подписки
Returns:
список подписок
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredSubscriptionBean

unSubscribe

public void unSubscribe(java.lang.String sessionId,
                        java.lang.String subscriptionId)
                 throws java.lang.Exception
Удаляет подписку

Parameters:
sessionId - сессия пользователя
subscriptionId - ID подписки, которую удаляем
Throws:
GranException - при необходимости
java.lang.Exception

updateSubscription

public void updateSubscription(java.lang.String sessionId,
                               java.lang.String subscriptionId,
                               java.lang.String name,
                               java.lang.String filterId,
                               java.lang.String templateId,
                               long startDate,
                               long stopDate,
                               long nextRun,
                               int interval)
                        throws java.lang.Exception
Редактирует существующую подписку

Parameters:
sessionId - сессия пользователя
name - Название подписки
subscriptionId - ID редактируемой подписки
filterId - ID фильтра, для которого получаем подписки
startDate - Дата/время начала рассылки
stopDate - Дата/время окончания рассылки
nextRun - Время следующего запуска
interval - Истервал рассылки
templateId - ID шаблона письма
Throws:
GranException - при необходимости
java.lang.Exception

createSubscription

public java.lang.String createSubscription(java.lang.String sessionId,
                                           java.lang.String name,
                                           java.lang.String userId,
                                           java.lang.String groupId,
                                           java.lang.String taskId,
                                           java.lang.String filterId)
                                    throws java.lang.Exception
Создает новую подписку

Parameters:
sessionId - сессия пользователя
name - Название подписки
userId - ID подписанного пользователя
groupId - ID подписанной группы
taskId - ID задаче, на уровне которой создается подписка
filterId - ID фильтра, для которого получаем подписки
Returns:
ID созданной подписки
Throws:
GranException - при необходимости
java.lang.Exception

createTaskFilter

public java.lang.String createTaskFilter(java.lang.String sessionId,
                                         java.lang.String name,
                                         java.lang.String description,
                                         boolean priv,
                                         java.lang.String taskId,
                                         java.lang.String ownerId,
                                         java.lang.String preferences)
                                  throws java.lang.Exception
Создает фильтр для задач

Parameters:
sessionId - сессия пользователя
name - название фильтра
description - описание фильтра
priv - указывает приватный фильтр или нет
taskId - ID задачи на уровне которой создается фильтр
ownerId - ID пользователя, который создает фильтр
Returns:
ID созданного фильтра
Throws:
GranException - при необходимости
java.lang.Exception

createUserFilter

public java.lang.String createUserFilter(java.lang.String sessionId,
                                         java.lang.String toUserId,
                                         java.lang.String name,
                                         java.lang.String description,
                                         boolean priv,
                                         java.lang.String preferences)
                                  throws java.lang.Exception
Создает фильтр для полдьзователей

Parameters:
sessionId - сессия пользователя
toUserId - ID пользователя на уровне которого создается фильтр
name - Название задачи
description - Описание задачи
priv - указывает приватный фильтр или нет
Returns:
ID созданного фильтра
Throws:
GranException - при необходимости
java.lang.Exception

cloneTaskFilter

public java.lang.String cloneTaskFilter(java.lang.String sessionId,
                                        java.lang.String filterId,
                                        java.lang.String currentTaskId)
                                 throws java.lang.Exception
Создает копию указанного фильтра для задач (клонирует)

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, который клонируем
currentTaskId - ID задачи, на уровне которой клонируется фильтр
Returns:
ID нового фильтра
Throws:
GranException - при необходимости
java.lang.Exception

cloneUserFilter

public java.lang.String cloneUserFilter(java.lang.String sessionId,
                                        java.lang.String currentUserId,
                                        java.lang.String filterId)
                                 throws java.lang.Exception
Создает копию указанного фильтра для пользоватлея (клонирует)

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, который клонируем
currentUserId - ID пользователя, который клонирует фильтр
Returns:
ID нового фильтра
Throws:
GranException - при необходимости
java.lang.Exception

updateTaskFilter

public void updateTaskFilter(java.lang.String sessionId,
                             java.lang.String filterId,
                             java.lang.String name,
                             java.lang.String description,
                             boolean priv,
                             java.lang.String preferences)
                      throws java.lang.Exception
Редактирование фильтра для задач

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра
name - Название фильтра
description - Описание фильтра
priv - Видимость фильтра (приватный или публичный)
preferences - Настройки фильтра
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SafeString

updateUserFilter

public void updateUserFilter(java.lang.String sessionId,
                             java.lang.String filterId,
                             java.lang.String name,
                             java.lang.String description,
                             boolean priv,
                             java.lang.String preferences)
                      throws java.lang.Exception
Редактирование фильтра для задач

Parameters:
sessionId - Сессия пользователя
filterId - ID фильтра
name - Название фильтра
description - Описание фильтра
priv - Видимость фильтра (приватный или публичный)
preferences - Настройки фильтра
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SafeString

deleteTaskFilter

public void deleteTaskFilter(java.lang.String sessionId,
                             java.lang.String filterId)
                      throws java.lang.Exception
Удаляет фильтр для задач

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, Который удаляем
Throws:
GranException - при необходимости
java.lang.Exception

deleteUserFilter

public void deleteUserFilter(java.lang.String sessionId,
                             java.lang.String filterId)
                      throws java.lang.Exception
Удаляет фильтр для пользователей

Parameters:
sessionId - сессия ользователя
filterId - ID фильтра, который удаляем
Throws:
GranException - при необходимости
java.lang.Exception

getCurrentFilterId

public java.lang.String getCurrentFilterId(java.lang.String sessionId,
                                           java.lang.String taskId)
                                    throws java.lang.Exception
Возвращает текущий выбранный пользователем фильтр на уровне задачи taskId

Parameters:
sessionId - сессия ользователя
taskId - ID Задачи, на уровне которой берется фильтр
Returns:
ID текущего фильтра пользователя
Throws:
GranException - при необходимости
java.lang.Exception

getCurrentUserFilterId

public java.lang.String getCurrentUserFilterId(java.lang.String sessionId,
                                               java.lang.String userId)
                                        throws java.lang.Exception
Возвращает текущий выбранный пользователем фильтр на уровне пользователя userId

Parameters:
sessionId - сессия пользователя
userId - ID Пользователя, на уровле которого берется фильтр
Returns:
ID текущего фильтра пользователя
Throws:
GranException - при необходимости
java.lang.Exception

setCurrentFilter

public java.lang.String setCurrentFilter(java.lang.String sessionId,
                                         java.lang.String taskId,
                                         java.lang.String filterId)
                                  throws java.lang.Exception
Устанавливает текущий выбранный фильтр для текущего пользователя или задачи

Parameters:
sessionId - сессия пользователя
taskId - ID задачи, для которой устанавливается текущий выбранный фильтр
filterId - ID фильтра, который устанавливается
Returns:
ID установленного фильтра
Throws:
GranException - при необходимости
java.lang.Exception

setCurrentUserFilter

public java.lang.String setCurrentUserFilter(java.lang.String sessionId,
                                             java.lang.String userId,
                                             java.lang.String filterId)
                                      throws java.lang.Exception
Устанавливает текущий выбранный фильтр для пользователя или задачи

Parameters:
sessionId - сессия пользователя
userId - ID пользователя, для которого устанавливается текущий выбранный фильтр
filterId - ID фильтра, который устанавливается
Returns:
ID установленного фильтра
Throws:
GranException - при необходимости
java.lang.Exception

getNotificationList

public NotificationBean[] getNotificationList(java.lang.String sessionId,
                                              java.lang.String filterId,
                                              java.lang.String taskId)
                                       throws java.lang.Exception
Возвращает список оповещений для определенного фильтра, которые могу рассылаться для указанной задачи.

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра
taskId - текущая задача
Returns:
список уведомлений
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredNotificationBean

getAllNotificationList

public NotificationBean[] getAllNotificationList(java.lang.String sessionId,
                                                 java.lang.String filterId)
                                          throws java.lang.Exception
Возвращает список оповещений, созданных для данного фильтра

Parameters:
sessionId - сессия пользователя
filterId - ID фильтра, для которого беруться уведомления
Returns:
список уведомлений
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredNotificationBean

setNotification

public void setNotification(java.lang.String sessionId,
                            java.lang.String name,
                            java.lang.String filterId,
                            java.lang.String userId,
                            java.lang.String groupId,
                            java.lang.String taskId)
                     throws java.lang.Exception
Создает уведомление о событиях

Parameters:
sessionId - сессия пользователя
name - Название уведомления
filterId - ID фильтра, с использованием которого фильтруются задачи для рассылки уведомлений
userId - ID пользователя, для которого создается уведомление
groupId - ID группы, для которой создается уведомление
taskId - ID хадачи, на уровне которой создается уведомление
Throws:
GranException - при необходимости
java.lang.Exception

updateNotification

public void updateNotification(java.lang.String sessionId,
                               java.lang.String notificationId,
                               java.lang.String filterId,
                               java.lang.String name,
                               java.lang.String templateId,
                               java.lang.String condition)
                        throws java.lang.Exception
Произодится редактирование уведомления о событиях

Parameters:
sessionId - сессия пользователя
notificationId - ID редактируемого уведомления
name - Название уведомления
templateId - ID шаблона письма
filterId - ID фильтра, на основании которого фильтруются задачи для рассылки уведомлений
condition - Перечень события, на которые идет реакция
Throws:
GranException - при необходимости
java.lang.Exception

unsetNotification

public void unsetNotification(java.lang.String sessionId,
                              java.lang.String notificationId)
                       throws java.lang.Exception
Удаляет уведомление о событиях

Parameters:
sessionId - сессия пользователя
notificationId - ID удаляемого уведомления
Throws:
GranException - при необходимости
java.lang.Exception

getUserFilterList

public FilterBean[] getUserFilterList(java.lang.String sessionId,
                                      java.lang.String userId)
                               throws java.lang.Exception
Возвращает список фильтров пользоватлелей для пользователя ownerId, которые доступны пользователю currentUserId

Parameters:
sessionId - сессия пользователя
userId - ID пользователя, для которого достаются фильтры
Returns:
Спсок фильтров
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredFilterBean

getAllUserFilterList

public FilterBean[] getAllUserFilterList(java.lang.String sessionId,
                                         java.lang.String userId)
                                  throws java.lang.Exception
Возвращает список фильтров пользоватлелей для пользователя ownerId, которые доступны пользователю currentUserId, включая фильтры, созданные для дочерних пользовталей

Parameters:
sessionId - сессия пользователя
userId - ID пользователя, для которого достаются фильтры
Returns:
Спсок фильтров
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
SecuredFilterBean


Copyright © 2002-2009 TrackStudio, Ltd. All Rights Reserved.