org.bonitasoft.engine.core.category.impl

Class CategoryServiceImpl

java.lang.Object

org.bonitasoft.engine.core.category.impl.CategoryServiceImpl

All Implemented Interfaces:

CategoryService

public class CategoryServiceImpl
extends java.lang.Object
implements CategoryService

Author:

Yanyan Liu, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.category.CategoryService

CATEGORY

Constructor Summary

Constructors

Constructor and Description
CategoryServiceImpl(ReadPersistenceService persistenceService, Recorder recorder, EventService eventService, SessionService sessionService, ReadSessionAccessor sessionAccessor, QueriableLoggerService queriableLoggerService)

Method Summary

Modifier and Type	Method and Description
void	addProcessDefinitionsToCategory(long categoryId, java.util.List<java.lang.Long> processDefinitionIds) Add process definitions to a category
void	addProcessDefinitionToCategory(long categoryId, long processDefinitionId) Add a process definition to a category
SCategory	createCategory(java.lang.String name, java.lang.String description) Create a category by give name and description
void	deleteCategory(long categoryId) Delete a category by its id
long	deleteProcessCategoryMappings(java.util.List<SProcessCategoryMapping> mappings)
java.util.List<SCategory>	getCategories(int fromIndex, int numberOfCategories, java.lang.String field, OrderByType order) Retrieves a list of categories, The returned list is paginated
java.util.List<SCategory>	getCategoriesOfProcessDefinition(long processDefinitionId, int fromIndex, int numberOfCategories, OrderByType order) Get categories for specific process definition, the result list is paginated
java.util.List<SCategory>	getCategoriesUnrelatedToProcessDefinition(long processDefinitionId, int fromIndex, int numberOfCategories, OrderByType order) Get categories not attached for specific process definition, the result list is paginated
SCategory	getCategory(long id) Get category by its id
SCategory	getCategoryByName(java.lang.String name) Get category by its name
long	getNumberOfCategories() Get the total number of categories
long	getNumberOfCategoriesOfProcess(long processDefinitionId) Get number of categories of the specific process definition
long	getNumberOfCategoriesUnrelatedToProcess(long processDefinitionId) Get number of categories not attached of the specific process definition
long	getNumberOfCategorizedProcessIds(java.util.List<java.lang.Long> processIds) Get number of categorized processes
long	getNumberOfProcessDeploymentInfosOfCategory(long categoryId) Get the number of process definition for specific category
void	removeCategoriesFromProcessDefinition(long processDefinitionId, java.util.List<java.lang.Long> categoryIds) Remove specific categories for specific process definition
java.util.List<SProcessCategoryMapping>	searchProcessCategoryMappings(QueryOptions queryOptions) Search process category mappings corresponding to criteria
void	updateCategory(long categoryId, EntityUpdateDescriptor descriptor) Update a category by its id

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryServiceImpl

public CategoryServiceImpl(ReadPersistenceService persistenceService,
                           Recorder recorder,
                           EventService eventService,
                           SessionService sessionService,
                           ReadSessionAccessor sessionAccessor,
                           QueriableLoggerService queriableLoggerService)

Method Detail

createCategory

public SCategory createCategory(java.lang.String name,
                                java.lang.String description)
                         throws SCategoryAlreadyExistsException,
                                SCategoryCreationException

Description copied from interface: CategoryService

Create a category by give name and description

Specified by:

createCategory in interface CategoryService

Parameters:

name - The name of category

description - The description of category

Returns:

the category object with id

Throws:

SCategoryAlreadyExistsException - Error thrown if category is already exist

SCategoryCreationException - Error thrown if has exceptions during the category creation.

getCategory

public SCategory getCategory(long id)
                      throws SCategoryNotFoundException

Description copied from interface: CategoryService

Get category by its id

Specified by:

getCategory in interface CategoryService

Parameters:

id - Identifier of the category

Returns:

a category object

Throws:

SCategoryNotFoundException - Error thrown if no category have an id corresponding to the parameter.

getCategoryByName

public SCategory getCategoryByName(java.lang.String name)
                            throws SCategoryNotFoundException

Description copied from interface: CategoryService

Get category by its name

Specified by:

getCategoryByName in interface CategoryService

Parameters:

name - Name of the category

Returns:

a category object

Throws:

SCategoryNotFoundException - Error thrown if no category have a name corresponding to the parameter.

updateCategory

public void updateCategory(long categoryId,
                           EntityUpdateDescriptor descriptor)
                    throws SCategoryException

Description copied from interface: CategoryService

Update a category by its id

Specified by:

updateCategory in interface CategoryService

Parameters:

categoryId - Identifier of the category

Throws:

SCategoryNotFoundException - Error thrown if no category have an id corresponding to the parameter.

SCategoryException - Error thrown if has exception during the category update

deleteCategory

public void deleteCategory(long categoryId)
                    throws SCategoryNotFoundException,
                           SCategoryDeletionException

Description copied from interface: CategoryService

Delete a category by its id

Specified by:

deleteCategory in interface CategoryService

Parameters:

categoryId - Identifier of the category

Throws:

SCategoryNotFoundException - Error thrown if no category have an id corresponding to the parameter.

SCategoryDeletionException - Error thrown if has exception during the category deletion

getNumberOfCategories

public long getNumberOfCategories()
                           throws SCategoryException

Description copied from interface: CategoryService

Get the total number of categories

Specified by:

getNumberOfCategories in interface CategoryService

Returns:

The total number of Categories

Throws:

SCategoryException

getCategories

public java.util.List<SCategory> getCategories(int fromIndex,
                                               int numberOfCategories,
                                               java.lang.String field,
                                               OrderByType order)
                                        throws SCategoryException

Description copied from interface: CategoryService

Retrieves a list of categories, The returned list is paginated

Specified by:

getCategories in interface CategoryService

Parameters:

fromIndex - Index of the record to be returned. First record has index 0.

numberOfCategories - Number of categories per page. Maximum number of categories returned.

field - The field used by the list order

order - ASC or DESC

Returns:

The list of category objects

Throws:

SPageOutOfRangeException - Error thrown if page is out of the range.

SCategoryException - Error thrown if has exception during the category retrieve

addProcessDefinitionToCategory

public void addProcessDefinitionToCategory(long categoryId,
                                           long processDefinitionId)
                                    throws SCategoryException

Description copied from interface: CategoryService

Add a process definition to a category

Specified by:

addProcessDefinitionToCategory in interface CategoryService

Parameters:

categoryId - Identifier of the category

processDefinitionId - Identifier of the process definition

Throws:

SCategoryNotFoundException - Error thrown if no category have an id corresponding to the parameter.

SCategoryException - Error thrown if has exception during the adding action

addProcessDefinitionsToCategory

public void addProcessDefinitionsToCategory(long categoryId,
                                            java.util.List<java.lang.Long> processDefinitionIds)
                                     throws SCategoryException

Description copied from interface: CategoryService

Add process definitions to a category

Specified by:

addProcessDefinitionsToCategory in interface CategoryService

Parameters:

categoryId - Identifier of the category

processDefinitionIds - Identifier of the process definition

Throws:

SCategoryNotFoundException - Error thrown if no category have an id corresponding to the parameter.

SCategoryException - Error thrown if has exception during the adding action

SCategoryInProcessAlreadyExistsException

getNumberOfCategoriesOfProcess

public long getNumberOfCategoriesOfProcess(long processDefinitionId)
                                    throws SCategoryException

Description copied from interface: CategoryService

Get number of categories of the specific process definition

Specified by:

getNumberOfCategoriesOfProcess in interface CategoryService

Parameters:

processDefinitionId - Identifier of the process definition

Returns:

number of categories

Throws:

SCategoryException - Error thrown if has exception during the category number retrieve action

getNumberOfCategoriesUnrelatedToProcess

public long getNumberOfCategoriesUnrelatedToProcess(long processDefinitionId)
                                             throws SCategoryException

Description copied from interface: CategoryService

Get number of categories not attached of the specific process definition

Specified by:

getNumberOfCategoriesUnrelatedToProcess in interface CategoryService

Returns:

number of categories

Throws:

SCategoryException - Error thrown if has exception during the category number retrieve action

getCategoriesOfProcessDefinition

public java.util.List<SCategory> getCategoriesOfProcessDefinition(long processDefinitionId,
                                                                  int fromIndex,
                                                                  int numberOfCategories,
                                                                  OrderByType order)
                                                           throws SCategoryException

Description copied from interface: CategoryService

Get categories for specific process definition, the result list is paginated

Specified by:

getCategoriesOfProcessDefinition in interface CategoryService

Parameters:

processDefinitionId - Identifier of the process definition

fromIndex - Start index of satisfied record

numberOfCategories - Number of categories per page. Maximum number of categories returned.

order - Criterion for order, default order by name

Returns:

The matching list of category

Throws:

SCategoryException - Error thrown if has exception during the category retrieve action

SIndexOutOfRangeException - Error thrown if index is out of the range.

getCategoriesUnrelatedToProcessDefinition

public java.util.List<SCategory> getCategoriesUnrelatedToProcessDefinition(long processDefinitionId,
                                                                           int fromIndex,
                                                                           int numberOfCategories,
                                                                           OrderByType order)
                                                                    throws SCategoryException

Description copied from interface: CategoryService

Get categories not attached for specific process definition, the result list is paginated

Specified by:

getCategoriesUnrelatedToProcessDefinition in interface CategoryService

Returns:

The matching list of category

Throws:

SCategoryException

removeCategoriesFromProcessDefinition

public void removeCategoriesFromProcessDefinition(long processDefinitionId,
                                                  java.util.List<java.lang.Long> categoryIds)
                                           throws SCategoryException

Description copied from interface: CategoryService

Remove specific categories for specific process definition

Specified by:

removeCategoriesFromProcessDefinition in interface CategoryService

Parameters:

processDefinitionId - Identifier of the process definition

categoryIds - Identifiers of the categories

Throws:

SCategoryException

searchProcessCategoryMappings

public java.util.List<SProcessCategoryMapping> searchProcessCategoryMappings(QueryOptions queryOptions)
                                                                      throws SBonitaReadException

Description copied from interface: CategoryService

Search process category mappings corresponding to criteria

Specified by:

searchProcessCategoryMappings in interface CategoryService

Returns:

List of process category mappings

Throws:

SBonitaReadException

deleteProcessCategoryMappings

public long deleteProcessCategoryMappings(java.util.List<SProcessCategoryMapping> mappings)

Specified by:

deleteProcessCategoryMappings in interface CategoryService

Returns:

Number of deleted category mapping

getNumberOfCategorizedProcessIds

public long getNumberOfCategorizedProcessIds(java.util.List<java.lang.Long> processIds)
                                      throws SCategoryException

Description copied from interface: CategoryService

Get number of categorized processes

Specified by:

getNumberOfCategorizedProcessIds in interface CategoryService

Parameters:

processIds - Identifier of the process definition

Returns:

the number of categorized processes

Throws:

SCategoryException

getNumberOfProcessDeploymentInfosOfCategory

public long getNumberOfProcessDeploymentInfosOfCategory(long categoryId)
                                                 throws SBonitaReadException

Description copied from interface: CategoryService

Get the number of process definition for specific category

Specified by:

getNumberOfProcessDeploymentInfosOfCategory in interface CategoryService

Parameters:

categoryId - Identifier of the category

Returns:

The number of process definition for specific category

Throws:

SBonitaReadException