com.liferay.commerce.product.service

Class CPOptionCategoryLocalServiceUtil

java.lang.Object

com.liferay.commerce.product.service.CPOptionCategoryLocalServiceUtil

public class CPOptionCategoryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CPOptionCategory. This utility wraps com.liferay.commerce.product.service.impl.CPOptionCategoryLocalServiceImpl and is an 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.

See Also:

CPOptionCategoryLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CPOptionCategoryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CPOptionCategory	addCPOptionCategory(CPOptionCategory cpOptionCategory) Adds the cp option category to the database.
static CPOptionCategory	addCPOptionCategory(long userId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, double priority, java.lang.String key, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static CPOptionCategory	createCPOptionCategory(long CPOptionCategoryId) Creates a new cp option category with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteCPOptionCategories(long companyId)
static CPOptionCategory	deleteCPOptionCategory(CPOptionCategory cpOptionCategory) Deletes the cp option category from the database.
static CPOptionCategory	deleteCPOptionCategory(long CPOptionCategoryId) Deletes the cp option category with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <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.
static <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.
static <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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static CPOptionCategory	fetchCPOptionCategory(long CPOptionCategoryId)
static CPOptionCategory	fetchCPOptionCategory(long companyId, java.lang.String key)
static CPOptionCategory	fetchCPOptionCategoryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the cp option category with the matching UUID and company.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<CPOptionCategory>	getCPOptionCategories(int start, int end) Returns a range of all the cp option categories.
static java.util.List<CPOptionCategory>	getCPOptionCategories(long companyId, int start, int end)
static int	getCPOptionCategoriesCount() Returns the number of cp option categories.
static CPOptionCategory	getCPOptionCategory(long CPOptionCategoryId) Returns the cp option category with the primary key.
static CPOptionCategory	getCPOptionCategory(long companyId, java.lang.String key)
static CPOptionCategory	getCPOptionCategoryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the cp option category with the matching UUID and company.
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CPOptionCategoryLocalService	getService()
static com.liferay.portal.kernel.search.BaseModelSearchResult<CPOptionCategory>	searchCPOptionCategories(long companyId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
static CPOptionCategory	updateCPOptionCategory(CPOptionCategory cpOptionCategory) Updates the cp option category in the database or adds it if it does not yet exist.
static CPOptionCategory	updateCPOptionCategory(long cpOptionCategoryId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, double priority, java.lang.String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

CPOptionCategoryLocalServiceUtil

public CPOptionCategoryLocalServiceUtil()

Method Detail

addCPOptionCategory

public static CPOptionCategory addCPOptionCategory(CPOptionCategory cpOptionCategory)

Adds the cp option category to the database. Also notifies the appropriate model listeners.

Important: Inspect CPOptionCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

cpOptionCategory - the cp option category

Returns:

the cp option category that was added

addCPOptionCategory

public static CPOptionCategory addCPOptionCategory(long userId,
                                                   java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                   java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                   double priority,
                                                   java.lang.String key,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCPOptionCategory

public static CPOptionCategory createCPOptionCategory(long CPOptionCategoryId)

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

Parameters:

CPOptionCategoryId - the primary key for the new cp option category

Returns:

the new cp option category

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPOptionCategories

public static void deleteCPOptionCategories(long companyId)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPOptionCategory

public static CPOptionCategory deleteCPOptionCategory(CPOptionCategory cpOptionCategory)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the cp option category from the database. Also notifies the appropriate model listeners.

Important: Inspect CPOptionCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

cpOptionCategory - the cp option category

Returns:

the cp option category that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPOptionCategory

public static CPOptionCategory deleteCPOptionCategory(long CPOptionCategoryId)
                                               throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect CPOptionCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

CPOptionCategoryId - the primary key of the cp option category

Returns:

the cp option category that was removed

Throws:

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

deletePersistedModel

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

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

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

public static <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, then the query will include the default ORDER BY logic from com.liferay.commerce.product.model.impl.CPOptionCategoryModelImpl.

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

public static <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, then the query will include the default ORDER BY logic from com.liferay.commerce.product.model.impl.CPOptionCategoryModelImpl.

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

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

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

fetchCPOptionCategory

public static CPOptionCategory fetchCPOptionCategory(long CPOptionCategoryId)

fetchCPOptionCategory

public static CPOptionCategory fetchCPOptionCategory(long companyId,
                                                     java.lang.String key)

fetchCPOptionCategoryByUuidAndCompanyId

public static CPOptionCategory fetchCPOptionCategoryByUuidAndCompanyId(java.lang.String uuid,
                                                                       long companyId)

Returns the cp option category with the matching UUID and company.

Parameters:

uuid - the cp option category's UUID

companyId - the primary key of the company

Returns:

the matching cp option category, or null if a matching cp option category could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCPOptionCategories

public static java.util.List<CPOptionCategory> getCPOptionCategories(int start,
                                                                     int end)

Returns a range of all the cp option 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, then the query will include the default ORDER BY logic from com.liferay.commerce.product.model.impl.CPOptionCategoryModelImpl.

Parameters:

start - the lower bound of the range of cp option categories

end - the upper bound of the range of cp option categories (not inclusive)

Returns:

the range of cp option categories

getCPOptionCategories

public static java.util.List<CPOptionCategory> getCPOptionCategories(long companyId,
                                                                     int start,
                                                                     int end)

getCPOptionCategoriesCount

public static int getCPOptionCategoriesCount()

Returns the number of cp option categories.

Returns:

the number of cp option categories

getCPOptionCategory

public static CPOptionCategory getCPOptionCategory(long CPOptionCategoryId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the cp option category with the primary key.

Parameters:

CPOptionCategoryId - the primary key of the cp option category

Returns:

the cp option category

Throws:

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

getCPOptionCategory

public static CPOptionCategory getCPOptionCategory(long companyId,
                                                   java.lang.String key)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCPOptionCategoryByUuidAndCompanyId

public static CPOptionCategory getCPOptionCategoryByUuidAndCompanyId(java.lang.String uuid,
                                                                     long companyId)
                                                              throws com.liferay.portal.kernel.exception.PortalException

Returns the cp option category with the matching UUID and company.

Parameters:

uuid - the cp option category's UUID

companyId - the primary key of the company

Returns:

the matching cp option category

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching cp option category could not be found

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchCPOptionCategories

public static com.liferay.portal.kernel.search.BaseModelSearchResult<CPOptionCategory> searchCPOptionCategories(long companyId,
                                                                                                                java.lang.String keywords,
                                                                                                                int start,
                                                                                                                int end,
                                                                                                                com.liferay.portal.kernel.search.Sort sort)
                                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCPOptionCategory

public static CPOptionCategory updateCPOptionCategory(CPOptionCategory cpOptionCategory)

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

Important: Inspect CPOptionCategoryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

cpOptionCategory - the cp option category

Returns:

the cp option category that was updated

updateCPOptionCategory

public static CPOptionCategory updateCPOptionCategory(long cpOptionCategoryId,
                                                      java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                      double priority,
                                                      java.lang.String key)
                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CPOptionCategoryLocalService getService()