com.liferay.portlet.shopping.service
Interface ShoppingCategoryLocalService

All Known Implementing Classes:

ShoppingCategoryLocalServiceBaseImpl, ShoppingCategoryLocalServiceImpl, ShoppingCategoryLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingCategoryLocalService

The interface for the shopping category local service.

Never modify or reference this interface directly. Always use ShoppingCategoryLocalServiceUtil to access the shopping category local service. Add custom service methods to ShoppingCategoryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

ShoppingCategoryLocalServiceUtil, ShoppingCategoryLocalServiceBaseImpl, ShoppingCategoryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

ShoppingCategory	addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext)
void	addCategoryResources(long categoryId, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addCategoryResources(long categoryId, String[] communityPermissions, String[] guestPermissions)
void	addCategoryResources(ShoppingCategory category, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addCategoryResources(ShoppingCategory category, String[] communityPermissions, String[] guestPermissions)
ShoppingCategory	addShoppingCategory(ShoppingCategory shoppingCategory) Adds the shopping category to the database.
ShoppingCategory	createShoppingCategory(long categoryId) Creates a new shopping category with the primary key.
void	deleteCategories(long groupId)
void	deleteCategory(long categoryId)
void	deleteCategory(ShoppingCategory category)
void	deleteShoppingCategory(long categoryId) Deletes the shopping category with the primary key from the database.
void	deleteShoppingCategory(ShoppingCategory shoppingCategory) Deletes the shopping category from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<ShoppingCategory>	getCategories(long groupId)
List<ShoppingCategory>	getCategories(long groupId, long parentCategoryId, int start, int end)
int	getCategoriesCount(long groupId, long parentCategoryId)
ShoppingCategory	getCategory(long categoryId)
List<ShoppingCategory>	getParentCategories(long categoryId)
List<ShoppingCategory>	getParentCategories(ShoppingCategory category)
ShoppingCategory	getParentCategory(ShoppingCategory category)
List<ShoppingCategory>	getShoppingCategories(int start, int end) Gets a range of all the shopping categories.
int	getShoppingCategoriesCount() Gets the number of shopping categories.
ShoppingCategory	getShoppingCategory(long categoryId) Gets the shopping category with the primary key.
void	getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
ShoppingCategory	updateCategory(long categoryId, long parentCategoryId, String name, String description, boolean mergeWithParentCategory, ServiceContext serviceContext)
ShoppingCategory	updateShoppingCategory(ShoppingCategory shoppingCategory) Updates the shopping category in the database.
ShoppingCategory	updateShoppingCategory(ShoppingCategory shoppingCategory, boolean merge) Updates the shopping category in the database.

Method Detail

addShoppingCategory

ShoppingCategory addShoppingCategory(ShoppingCategory shoppingCategory)
                                     throws SystemException

Adds the shopping category to the database. Also notifies the appropriate model listeners.

Parameters:

shoppingCategory - the shopping category to add

Returns:

the shopping category that was added

Throws:

SystemException - if a system exception occurred

createShoppingCategory

ShoppingCategory createShoppingCategory(long categoryId)

Creates a new shopping category with the primary key. Does not add the shopping category to the database.

Parameters:

categoryId - the primary key for the new shopping category

Returns:

the new shopping category

deleteShoppingCategory

void deleteShoppingCategory(long categoryId)
                            throws PortalException,
                                   SystemException

Deletes the shopping category with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

categoryId - the primary key of the shopping category to delete

Throws:

PortalException - if a shopping category with the primary key could not be found

SystemException - if a system exception occurred

deleteShoppingCategory

void deleteShoppingCategory(ShoppingCategory shoppingCategory)
                            throws SystemException

Deletes the shopping category from the database. Also notifies the appropriate model listeners.

Parameters:

shoppingCategory - the shopping category to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getShoppingCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getShoppingCategory(long categoryId)
                                     throws PortalException,
                                            SystemException

Gets the shopping category with the primary key.

Parameters:

categoryId - the primary key of the shopping category to get

Returns:

the shopping category

Throws:

PortalException - if a shopping category with the primary key could not be found

SystemException - if a system exception occurred

getShoppingCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getShoppingCategories(int start,
                                                                                      int end)
                                             throws SystemException

Gets a range of all the shopping categories.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of shopping categories to return

end - the upper bound of the range of shopping categories to return (not inclusive)

Returns:

the range of shopping categories

Throws:

SystemException - if a system exception occurred

getShoppingCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingCategoriesCount()
                               throws SystemException

Gets the number of shopping categories.

Returns:

the number of shopping categories

Throws:

SystemException - if a system exception occurred

updateShoppingCategory

ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory)
                                        throws SystemException

Updates the shopping category in the database. Also notifies the appropriate model listeners.

Parameters:

shoppingCategory - the shopping category to update

Returns:

the shopping category that was updated

Throws:

SystemException - if a system exception occurred

updateShoppingCategory

ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory,
                                        boolean merge)
                                        throws SystemException

Updates the shopping category in the database. Also notifies the appropriate model listeners.

Parameters:

shoppingCategory - the shopping category to update

merge - whether to merge the shopping category with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the shopping category that was updated

Throws:

SystemException - if a system exception occurred

addCategory

ShoppingCategory addCategory(long userId,
                             long parentCategoryId,
                             String name,
                             String description,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(long categoryId,
                          boolean addCommunityPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(long categoryId,
                          String[] communityPermissions,
                          String[] guestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          boolean addCommunityPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          String[] communityPermissions,
                          String[] guestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteCategories

void deleteCategories(long groupId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(long categoryId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(ShoppingCategory category)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getCategories(long groupId)
                                     throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getCategories(long groupId,
                                                                              long parentCategoryId,
                                                                              int start,
                                                                              int end)
                                     throws SystemException

Throws:

SystemException

getCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesCount(long groupId,
                                                                long parentCategoryId)
                       throws SystemException

Throws:

SystemException

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getCategory(long categoryId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getParentCategories(long categoryId)
                                           throws PortalException,
                                                  SystemException

Throws:

PortalException

SystemException

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getParentCategories(ShoppingCategory category)
                                           throws PortalException,
                                                  SystemException

Throws:

PortalException

SystemException

getParentCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getParentCategory(ShoppingCategory category)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getSubcategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubcategoryIds(List<Long> categoryIds,
                                                                long groupId,
                                                                long categoryId)
                       throws SystemException

Throws:

SystemException

updateCategory

ShoppingCategory updateCategory(long categoryId,
                                long parentCategoryId,
                                String name,
                                String description,
                                boolean mergeWithParentCategory,
                                ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException