com.liferay.portlet.shopping.service

Class ShoppingCategoryLocalServiceUtil

java.lang.Object

com.liferay.portlet.shopping.service.ShoppingCategoryLocalServiceUtil

@ProviderType
public class ShoppingCategoryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for ShoppingCategory. This utility wraps com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
ShoppingCategoryLocalServiceUtil()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ShoppingCategoryLocalServiceUtil

public ShoppingCategoryLocalServiceUtil()

Method Detail

addShoppingCategory

public static 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

public static 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

public static 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

public static 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

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

public static 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

public static 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

public static 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

public static 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

public static ShoppingCategory fetchShoppingCategory(long categoryId)
                                              throws SystemException

Throws:

SystemException

getShoppingCategory

public static 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

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getShoppingCategories

public static 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

public static int getShoppingCategoriesCount()
                                      throws SystemException

Returns the number of shopping categories.

Returns:

the number of shopping categories

Throws:

SystemException - if a system exception occurred

updateShoppingCategory

public static 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

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCategory

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

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

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(ShoppingCategory category,
                        java.lang.String[] groupPermissions,
                        java.lang.String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

deleteCategories

public static void deleteCategories(long groupId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteCategory

public static void deleteCategory(ShoppingCategory category)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getCategories

public static java.util.List<ShoppingCategory> getCategories(long groupId)
                                                      throws SystemException

Throws:

SystemException

getCategories

public static java.util.List<ShoppingCategory> getCategories(long groupId,
                                             long parentCategoryId,
                                             int start,
                                             int end)
                                                      throws SystemException

Throws:

SystemException

getCategoriesCount

public static int getCategoriesCount(long groupId,
                     long parentCategoryId)
                              throws SystemException

Throws:

SystemException

getCategory

public static ShoppingCategory getCategory(long categoryId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getParentCategories

public static java.util.List<ShoppingCategory> getParentCategories(long categoryId)
                                                            throws PortalException,
                                                                   SystemException

Throws:

PortalException

SystemException

getParentCategories

public static java.util.List<ShoppingCategory> getParentCategories(ShoppingCategory category)
                                                            throws PortalException,
                                                                   SystemException

Throws:

PortalException

SystemException

getParentCategory

public static ShoppingCategory getParentCategory(ShoppingCategory category)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

getSubcategoryIds

public static void getSubcategoryIds(java.util.List<java.lang.Long> categoryIds,
                     long groupId,
                     long categoryId)
                              throws SystemException

Throws:

SystemException

updateCategory

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

Throws:

PortalException

SystemException

getService

public static ShoppingCategoryLocalService getService()

setService

public void setService(ShoppingCategoryLocalService service)

Deprecated. As of 6.2.0