org.exoplatform.addon.marketplace.service

Interface MarketPlaceService

All Known Implementing Classes:

MarketPlaceServiceImpl

public interface MarketPlaceService

Created by kmenzli on 11/11/2016.

Method Summary

Modifier and Type	Method and Description
long	count() Return the total numbre of registered categories
Category	createCategory(Category category) Create a category with given category model object.
Category	createCategory(Category category, long parentId) Create a sub-category with given category model object and parent category ID.
List<Category>	findAllCategories() Return all categories registered in the DB
org.exoplatform.commons.utils.ListAccess<Category>	findCategories(String query)
Category	findCategoryByName(String categoryName)
Category	getCategory(Long categoryId) Return the category with given categoryId.
org.exoplatform.commons.utils.ListAccess<Category>	getSubCategory(long parentId) Return a list of children of a parent category with given parentId.
void	removeCategory(long categoryId, boolean deleteChild) Remove the category with given categoryId, and also its descendants if deleteChild is true.
Category	updateCategory(Category category) Update the category.

Method Detail

createCategory

Category createCategory(Category category)

Create a category with given category model object.

Parameters:

category -

Returns:

createCategory

Category createCategory(Category category,
                        long parentId)
                 throws MarketPlaceException

Create a sub-category with given category model object and parent category ID.

Parameters:

category - the category metadata to create.

parentId - parent Category ID

Returns:

Throws:

MarketPlaceException - the category associated with parentId doesn't exist.

updateCategory

Category updateCategory(Category category)

Update the category. It should throws MarketPlaceException if the category has been removed OR not existed from database.

Parameters:

category -

Returns:

removeCategory

void removeCategory(long categoryId,
                    boolean deleteChild)
             throws MarketPlaceException

Remove the category with given categoryId, and also its descendants if deleteChild is true.

Parameters:

categoryId -

deleteChild -

Throws:

MarketPlaceException

getCategory

Category getCategory(Long categoryId)
              throws MarketPlaceException

Return the category with given categoryId.

Parameters:

categoryId -

Returns:

Throws:

MarketPlaceException

getSubCategory

org.exoplatform.commons.utils.ListAccess<Category> getSubCategory(long parentId)

Return a list of children of a parent category with given parentId.

Parameters:

parentId -

Returns:

findCategories

org.exoplatform.commons.utils.ListAccess<Category> findCategories(String query)

count

long count()

Return the total numbre of registered categories

Returns:

findAllCategories

List<Category> findAllCategories()
                          throws MarketPlaceException

Return all categories registered in the DB

Returns:

Throws:

MarketPlaceException

findCategoryByName

Category findCategoryByName(String categoryName)
                     throws MarketPlaceException

Parameters:

categoryName -

Returns:

Category object with same name as in the input of the method

Throws:

MarketPlaceException