com.trackstudio.soap.service.category
Class Category

java.lang.Object
  extended by com.trackstudio.soap.service.category.Category

public class Category
extends java.lang.Object

Класс описывает web-сервис для работы с категориями


Constructor Summary
Category()
           
 
Method Summary
 void addRelatedCategory(java.lang.String sessionId, java.lang.String parentCategoryId, java.lang.String related)
          Добавляет подкатегорию для указанной
 boolean canChangeWorkflow(java.lang.String sessionId, java.lang.String categoryId)
          Проверяется, можно ли изменять процесс для категории или нет.
 java.lang.String createCategory(java.lang.String sessionId, java.lang.String taskId, java.lang.String name, java.lang.String workflowId, boolean handlerRequired, boolean groupHandlerAllowed)
          Создает новую категорию
 void deleteCategory(java.lang.String sessionId, java.lang.String categoryId)
          Удаляет категорию по ее ID
 void editCategory(java.lang.String sessionId, java.lang.String categoryId, java.lang.String name, java.lang.String action, java.lang.String description, boolean handlerRequired, boolean groupHandlerAllowed, java.lang.String workflowId, java.lang.String budget, java.lang.String preferences, java.lang.String icon)
          Редактирует категорию
 CategoryBean[] getAllAvailableCategoryList(java.lang.String sessionId, java.lang.String taskId)
          Возвращает список всех доступных категорий для задачи
 CategoryBean[] getAllCategoryList(java.lang.String sessionId, java.lang.String statusId)
          Возвращает список всех категорий для статуса
 CategoryBean[] getAvailableCategoryList(java.lang.String sessionId, java.lang.String taskId)
          Возвращает список доступных категорий для задачи
 boolean getCategoryIsValid(java.lang.String sessionId, java.lang.String categoryId, java.lang.String taskId)
          Проверяеет валидна категория или нет
 java.lang.String[] getCategoryRuleList(java.lang.String sessionId, java.lang.String prstatusId, java.lang.String categoryId)
          Возвращает список прав, которые есть у указанного статуса на указанную категорию
 CategoryBean[] getChildrenCategoryList(java.lang.String sessionId, java.lang.String categoryId, java.lang.String taskId)
          Возвращает список дочерних категорий для указанной
 CategoryBean[] getCreatableCategoryList(java.lang.String sessionId, java.lang.String taskId)
          Возвращает список доступных категорий для задачи
 CategoryBean[] getParentCategoryList(java.lang.String sessionId, java.lang.String categoryId, java.lang.String taskId)
          Возвращает список родителских категорий для указанной
 java.lang.String getTemplate(java.lang.String sessionId, java.lang.String categoryId)
          Возвращает шаблон описания для категории
 boolean hasSubcategories(java.lang.String sessionId, java.lang.String categoryId, java.lang.String taskId)
          Проверяет на наличие подкатегорий у указанной
 boolean isCategoryCanBeHandler(java.lang.String sessionId, java.lang.String taskId, java.lang.String categoryId, boolean isNew, java.lang.String submitter)
          Проверяеет есть ли право у пользователя быть ответственным для категории
 boolean isCategoryDeletable(java.lang.String sessionId, java.lang.String taskId, java.lang.String categoryId)
          Проверяеет есть ли право на удаление категории
 boolean isCategoryEditable(java.lang.String sessionId, java.lang.String taskId, java.lang.String categoryId)
          Проверяеет есть ли право на редактирование категории
 boolean isCategoryViewable(java.lang.String sessionId, java.lang.String taskId, java.lang.String categoryId)
          Проверяеет есть ли право на просмотр категории
 void removeRelatedCategory(java.lang.String sessionId, java.lang.String parentCategoryId, java.lang.String related)
          Удаляет подкатегорию для укащанной
 void setCategoryRule(java.lang.String sessionId, java.lang.String categoryId, java.lang.String prstatusId, java.lang.String createType, java.lang.String viewType, java.lang.String modifyType, java.lang.String handlerType, java.lang.String deleteType)
          Устанавливает правила доступа для категории
 void setCategoryTrigger(java.lang.String sessionId, java.lang.String categoryId, java.lang.String before, java.lang.String insteadOf, java.lang.String after, java.lang.String updBefore, java.lang.String updInsteadOf, java.lang.String updAfter)
          Устанавливает триггеры для категории
 void setTemplate(java.lang.String sessionId, java.lang.String categoryId, java.lang.String template)
          Устанавливает для категории текст шаблона описания
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Category

public Category()
Method Detail

getAvailableCategoryList

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

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

getAllAvailableCategoryList

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

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

getAllCategoryList

public CategoryBean[] getAllCategoryList(java.lang.String sessionId,
                                         java.lang.String statusId)
                                  throws java.lang.Exception
Возвращает список всех категорий для статуса

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

createCategory

public java.lang.String createCategory(java.lang.String sessionId,
                                       java.lang.String taskId,
                                       java.lang.String name,
                                       java.lang.String workflowId,
                                       boolean handlerRequired,
                                       boolean groupHandlerAllowed)
                                throws java.lang.Exception
Создает новую категорию

Parameters:
sessionId - сессия пользователя
taskId - ID родительской задачи
name - Название категории
workflowId - ID процесса
handlerRequired - Обязательность ответственного
groupHandlerAllowed - Можно ли задавать группу в качестве ответственного
Returns:
ID созданной категории
Throws:
GranException - при необходимости
java.lang.Exception

deleteCategory

public void deleteCategory(java.lang.String sessionId,
                           java.lang.String categoryId)
                    throws java.lang.Exception
Удаляет категорию по ее ID

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

getTemplate

public java.lang.String getTemplate(java.lang.String sessionId,
                                    java.lang.String categoryId)
                             throws java.lang.Exception
Возвращает шаблон описания для категории

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

setTemplate

public void setTemplate(java.lang.String sessionId,
                        java.lang.String categoryId,
                        java.lang.String template)
                 throws java.lang.Exception
Устанавливает для категории текст шаблона описания

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

editCategory

public void editCategory(java.lang.String sessionId,
                         java.lang.String categoryId,
                         java.lang.String name,
                         java.lang.String action,
                         java.lang.String description,
                         boolean handlerRequired,
                         boolean groupHandlerAllowed,
                         java.lang.String workflowId,
                         java.lang.String budget,
                         java.lang.String preferences,
                         java.lang.String icon)
                  throws java.lang.Exception
Редактирует категорию

Parameters:
sessionId - сессия пользователя
categoryId - ID категории
name - Название категории
action - Название действия
description - Описание категории
handlerRequired - Обязательность ответственного
groupHandlerAllowed - Можно ли задавать группу в качестве ответственного
workflowId - ID процесса
budget - ФОрмат бюджета
preferences - настройки категории
icon - иконка категории
Throws:
GranException - при необходимости
java.lang.Exception

getChildrenCategoryList

public CategoryBean[] getChildrenCategoryList(java.lang.String sessionId,
                                              java.lang.String categoryId,
                                              java.lang.String taskId)
                                       throws java.lang.Exception
Возвращает список дочерних категорий для указанной

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

getParentCategoryList

public CategoryBean[] getParentCategoryList(java.lang.String sessionId,
                                            java.lang.String categoryId,
                                            java.lang.String taskId)
                                     throws java.lang.Exception
Возвращает список родителских категорий для указанной

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

hasSubcategories

public boolean hasSubcategories(java.lang.String sessionId,
                                java.lang.String categoryId,
                                java.lang.String taskId)
                         throws java.lang.Exception
Проверяет на наличие подкатегорий у указанной

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

setCategoryRule

public void setCategoryRule(java.lang.String sessionId,
                            java.lang.String categoryId,
                            java.lang.String prstatusId,
                            java.lang.String createType,
                            java.lang.String viewType,
                            java.lang.String modifyType,
                            java.lang.String handlerType,
                            java.lang.String deleteType)
                     throws java.lang.Exception
Устанавливает правила доступа для категории

Parameters:
sessionId - сессия пользователя
categoryId - ID категории
prstatusId - ID статуса, для которого выставляются права
createType - CREATE_ALL, CREATE_HANDLER, CREATE_SUBMITTER, CREATE_SUBMITTER_AND_HANDLER или CREATE_NONE
viewType - VIEW_ALL, VIEW_HANDLER, VIEW_SUBMITTER, VIEW_SUBMITTER_AND_HANDLER или VIEW_NONE
modifyType - EDIT_ALL, EDIT_HANDLER, EDIT_SUBMITTER, EDIT_SUBMITTER_AND_HANDLER или EDIT_NONE
handlerType - BE_HANDLER_ALL, BE_HANDLER_HANDLER, BE_HANDLER_SUBMITTER, BE_HANDLER_SUBMITTER_AND_HANDLER или BE_HANDLER_NONE
deleteType - DELETE_ALL, DELETE_HANDLER, DELETE_SUBMITTER, DELETE_SUBMITTER_AND_HANDLER или DELETE_NONE
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
CategoryConstants

addRelatedCategory

public void addRelatedCategory(java.lang.String sessionId,
                               java.lang.String parentCategoryId,
                               java.lang.String related)
                        throws java.lang.Exception
Добавляет подкатегорию для указанной

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

removeRelatedCategory

public void removeRelatedCategory(java.lang.String sessionId,
                                  java.lang.String parentCategoryId,
                                  java.lang.String related)
                           throws java.lang.Exception
Удаляет подкатегорию для укащанной

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

getCreatableCategoryList

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

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

getCategoryRuleList

public java.lang.String[] getCategoryRuleList(java.lang.String sessionId,
                                              java.lang.String prstatusId,
                                              java.lang.String categoryId)
                                       throws java.lang.Exception
Возвращает список прав, которые есть у указанного статуса на указанную категорию

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

canChangeWorkflow

public boolean canChangeWorkflow(java.lang.String sessionId,
                                 java.lang.String categoryId)
                          throws java.lang.Exception
Проверяется, можно ли изменять процесс для категории или нет. Если есть хоть одна задача с заданной категорий, то менять процесс нельзя

Parameters:
sessionId - сессия пользователя
categoryId - ID категории, для которой произовадится проверка
Returns:
TRUE - можно менять процесс, FALSE - нельзя
Throws:
GranException - при необходимости
java.lang.Exception

isCategoryEditable

public boolean isCategoryEditable(java.lang.String sessionId,
                                  java.lang.String taskId,
                                  java.lang.String categoryId)
                           throws java.lang.Exception
Проверяеет есть ли право на редактирование категории

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

isCategoryCanBeHandler

public boolean isCategoryCanBeHandler(java.lang.String sessionId,
                                      java.lang.String taskId,
                                      java.lang.String categoryId,
                                      boolean isNew,
                                      java.lang.String submitter)
                               throws java.lang.Exception
Проверяеет есть ли право у пользователя быть ответственным для категории

Parameters:
sessionId - сессия пользователя
taskId - ID задачи
categoryId - ID категории
isNew - Новая ли задача создается?
submitter - ID автора
Returns:
TRUE - если есть, FALSE - если нет
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
Category

isCategoryDeletable

public boolean isCategoryDeletable(java.lang.String sessionId,
                                   java.lang.String taskId,
                                   java.lang.String categoryId)
                            throws java.lang.Exception
Проверяеет есть ли право на удаление категории

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

isCategoryViewable

public boolean isCategoryViewable(java.lang.String sessionId,
                                  java.lang.String taskId,
                                  java.lang.String categoryId)
                           throws java.lang.Exception
Проверяеет есть ли право на просмотр категории

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

setCategoryTrigger

public void setCategoryTrigger(java.lang.String sessionId,
                               java.lang.String categoryId,
                               java.lang.String before,
                               java.lang.String insteadOf,
                               java.lang.String after,
                               java.lang.String updBefore,
                               java.lang.String updInsteadOf,
                               java.lang.String updAfter)
                        throws java.lang.Exception
Устанавливает триггеры для категории

Parameters:
sessionId - сессия пользователя
categoryId - ID категории
before - before-триггер
insteadOf - instanseof-триггер
after - after-триггер
updBefore - update before-триггер
updInsteadOf - update-instanseof-триггер
updAfter - update-after-триггер
Throws:
GranException - при необходимости
java.lang.Exception
See Also:
Category

getCategoryIsValid

public boolean getCategoryIsValid(java.lang.String sessionId,
                                  java.lang.String categoryId,
                                  java.lang.String taskId)
                           throws java.lang.Exception
Проверяеет валидна категория или нет

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


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