com.liferay.portlet.shopping.service

Interface ShoppingCategoryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

ShoppingCategoryLocalServiceWrapper

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

Provides the local service interface for ShoppingCategory. 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.

Author:

Brian Wing Shun Chan

See Also:

ShoppingCategoryLocalServiceUtil, com.liferay.portlet.shopping.service.base.ShoppingCategoryLocalServiceBaseImpl, com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
ShoppingCategory	addCategory(long userId, long parentCategoryId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(long categoryId, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
void	addCategoryResources(ShoppingCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(ShoppingCategory category, java.lang.String[] groupPermissions, java.lang.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)
ShoppingCategory	deleteShoppingCategory(long categoryId) Deletes the shopping category with the primary key from the database.
ShoppingCategory	deleteShoppingCategory(ShoppingCategory shoppingCategory) Deletes the shopping category from the database.
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
ShoppingCategory	fetchShoppingCategory(long categoryId)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
java.util.List<ShoppingCategory>	getCategories(long groupId)
java.util.List<ShoppingCategory>	getCategories(long groupId, long parentCategoryId, int start, int end)
int	getCategoriesCount(long groupId, long parentCategoryId)
ShoppingCategory	getCategory(long categoryId)
java.util.List<ShoppingCategory>	getParentCategories(long categoryId)
java.util.List<ShoppingCategory>	getParentCategories(ShoppingCategory category)
ShoppingCategory	getParentCategory(ShoppingCategory category)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<ShoppingCategory>	getShoppingCategories(int start, int end) Returns a range of all the shopping categories.
int	getShoppingCategoriesCount() Returns the number of shopping categories.
ShoppingCategory	getShoppingCategory(long categoryId) Returns the shopping category with the primary key.
void	getSubcategoryIds(java.util.List<java.lang.Long> categoryIds, long groupId, long categoryId)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
ShoppingCategory	updateCategory(long categoryId, long parentCategoryId, java.lang.String name, java.lang.String description, boolean mergeWithParentCategory, ServiceContext serviceContext)
ShoppingCategory	updateShoppingCategory(ShoppingCategory shoppingCategory) Updates the shopping category in the database or adds it if it does not yet exist.

Method Detail

addShoppingCategory

@Indexable(type=REINDEX)
ShoppingCategory addShoppingCategory(ShoppingCategory shoppingCategory)
                                     throws SystemException

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

Parameters:

shoppingCategory - the shopping category

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

@Indexable(type=DELETE)
ShoppingCategory 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

Returns:

the shopping category that was removed

Throws:

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

SystemException - if a system exception occurred

deleteShoppingCategory

@Indexable(type=DELETE)
ShoppingCategory deleteShoppingCategory(ShoppingCategory shoppingCategory)
                                        throws SystemException

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

Parameters:

shoppingCategory - the shopping category

Returns:

the shopping category that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchShoppingCategory

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

Throws:

SystemException

getShoppingCategory

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

Returns the shopping category with the primary key.

Parameters:

categoryId - the primary key of the shopping category

Returns:

the shopping category

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getShoppingCategories

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

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of shopping categories

end - the upper bound of the range of shopping categories (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

Returns the number of shopping categories.

Returns:

the number of shopping categories

Throws:

SystemException - if a system exception occurred

updateShoppingCategory

@Indexable(type=REINDEX)
ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory)
                                        throws SystemException

Updates the shopping category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

shoppingCategory - the shopping category

Returns:

the shopping category that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCategory

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(long categoryId,
                        java.lang.String[] groupPermissions,
                        java.lang.String[] guestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                        java.lang.String[] groupPermissions,
                        java.lang.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)
java.util.List<ShoppingCategory> getCategories(long groupId)
                                               throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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)
java.util.List<ShoppingCategory> getParentCategories(long categoryId)
                                                     throws PortalException,
                                                            SystemException

Throws:

PortalException

SystemException

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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(java.util.List<java.lang.Long> categoryIds,
                                                              long groupId,
                                                              long categoryId)
                       throws SystemException

Throws:

SystemException

updateCategory

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

Throws:

PortalException

SystemException