com.liferay.shopping.service

Interface ShoppingCategoryLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

ShoppingCategoryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ShoppingCategoryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.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.

See Also:

ShoppingCategoryLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
ShoppingCategory	addCategory(long userId, long parentCategoryId, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
void	addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(long categoryId, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
void	addCategoryResources(ShoppingCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
void	addCategoryResources(ShoppingCategory category, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
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)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
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.
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
ShoppingCategory	fetchShoppingCategory(long categoryId)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
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)
ShoppingCategory	getCategory(long groupId, java.lang.String categoryName)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
java.util.List<ShoppingCategory>	getParentCategories(long categoryId)
java.util.List<ShoppingCategory>	getParentCategories(ShoppingCategory category)
ShoppingCategory	getParentCategory(ShoppingCategory category)
com.liferay.portal.kernel.model.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)
ShoppingCategory	updateCategory(long categoryId, long parentCategoryId, java.lang.String name, java.lang.String description, boolean mergeWithParentCategory, com.liferay.portal.kernel.service.ServiceContext serviceContext)
ShoppingCategory	updateShoppingCategory(ShoppingCategory shoppingCategory) Updates the shopping category in the database or adds it if it does not yet exist.

Method Detail

addCategory

ShoppingCategory addCategory(long userId,
                             long parentCategoryId,
                             java.lang.String name,
                             java.lang.String description,
                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCategoryResources

void addCategoryResources(long categoryId,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCategoryResources

void addCategoryResources(long categoryId,
                          com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addShoppingCategory

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

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

createShoppingCategory

@Transactional(enabled=false)
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

deleteCategories

void deleteCategories(long groupId)
               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCategory

void deleteCategory(long categoryId)
             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCategory

void deleteCategory(ShoppingCategory category)
             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteShoppingCategory

@Indexable(type=DELETE)
ShoppingCategory deleteShoppingCategory(long categoryId)
                                                         throws com.liferay.portal.kernel.exception.PortalException

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:

com.liferay.portal.kernel.exception.PortalException - if a shopping category with the primary key could not be found

deleteShoppingCategory

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

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchShoppingCategory

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ShoppingCategory> getCategories(long groupId)

getCategories

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

getCategoriesCount

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

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getCategory(long categoryId)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getCategory(long groupId,
                                                                                                java.lang.String categoryName)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ShoppingCategory> getParentCategories(long categoryId)
                                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ShoppingCategory> getParentCategories(ShoppingCategory category)
                                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getParentCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getParentCategory(ShoppingCategory category)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getShoppingCategories

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

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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.shopping.model.impl.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

getShoppingCategoriesCount

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

Returns the number of shopping categories.

Returns:

the number of shopping categories

getShoppingCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getShoppingCategory(long categoryId)
                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Returns the shopping category with the primary key.

Parameters:

categoryId - the primary key of the shopping category

Returns:

the shopping category

Throws:

com.liferay.portal.kernel.exception.PortalException - if a shopping category with the primary key could not be found

getSubcategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubcategoryIds(java.util.List<java.lang.Long> categoryIds,
                                                                                          long groupId,
                                                                                          long categoryId)

updateCategory

ShoppingCategory updateCategory(long categoryId,
                                long parentCategoryId,
                                java.lang.String name,
                                java.lang.String description,
                                boolean mergeWithParentCategory,
                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateShoppingCategory

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

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