com.liferay.commerce.product.service

Interface CPOptionCategoryLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CPOptionCategoryLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CPOptionCategoryLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

CPOptionCategoryLocalServiceUtil

Generated:

Method Summary

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

getBasePersistence

Method Detail

addCPOptionCategory

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

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

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

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

Specified by:

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPOptionCategories

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteCPOptionCategory

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

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

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

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

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

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

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

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, 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

@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, 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

@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

fetchCPOptionCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPOptionCategory fetchCPOptionCategory(long CPOptionCategoryId)

fetchCPOptionCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPOptionCategory fetchCPOptionCategory(long companyId,
                                                                                                          java.lang.String key)

fetchCPOptionCategoryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

getCPOptionCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CPOptionCategory> getCPOptionCategories(long companyId,
                                                                                                                          int start,
                                                                                                                          int end)

getCPOptionCategoriesCount

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

Returns the number of cp option categories.

Returns:

the number of cp option categories

getCPOptionCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPOptionCategory getCPOptionCategory(long companyId,
                                                                                                        java.lang.String key)
                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getCPOptionCategoryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

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

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

searchCPOptionCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

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