com.liferay.commerce.product.service

Interface CPDisplayLayoutLocalService

All Superinterfaces:

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

All Known Implementing Classes:

CPDisplayLayoutLocalServiceWrapper

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

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

CPDisplayLayoutLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
CPDisplayLayout	addCPDisplayLayout(CPDisplayLayout cpDisplayLayout) Adds the cp display layout to the database.
CPDisplayLayout	addCPDisplayLayout(long userId, long groupId, java.lang.Class<?> clazz, long classPK, java.lang.String layoutUuid)
CPDisplayLayout	createCPDisplayLayout(long CPDisplayLayoutId) Creates a new cp display layout with the primary key.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
CPDisplayLayout	deleteCPDisplayLayout(java.lang.Class<?> clazz, long classPK)
CPDisplayLayout	deleteCPDisplayLayout(CPDisplayLayout cpDisplayLayout) Deletes the cp display layout from the database.
CPDisplayLayout	deleteCPDisplayLayout(long CPDisplayLayoutId) Deletes the cp display layout with the primary key from the database.
void	deleteCPDisplayLayouts(java.lang.Class<?> clazz, long classPK)
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.
CPDisplayLayout	fetchCPDisplayLayout(long CPDisplayLayoutId)
CPDisplayLayout	fetchCPDisplayLayout(long groupId, java.lang.Class<?> clazz, long classPK)
java.util.List<CPDisplayLayout>	fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId, java.lang.String layoutUuid)
java.util.List<CPDisplayLayout>	fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId, java.lang.String layoutUuid, int start, int end)
CPDisplayLayout	fetchCPDisplayLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the cp display layout matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
CPDisplayLayout	getCPDisplayLayout(long CPDisplayLayoutId) Returns the cp display layout with the primary key.
CPDisplayLayout	getCPDisplayLayoutByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the cp display layout matching the UUID and group.
java.util.List<CPDisplayLayout>	getCPDisplayLayouts(int start, int end) Returns a range of all the cp display layouts.
java.util.List<CPDisplayLayout>	getCPDisplayLayoutsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the cp display layouts matching the UUID and company.
java.util.List<CPDisplayLayout>	getCPDisplayLayoutsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CPDisplayLayout> orderByComparator) Returns a range of cp display layouts matching the UUID and company.
int	getCPDisplayLayoutsCount() Returns the number of cp display layouts.
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<CPDisplayLayout>	searchCPDisplayLayout(long companyId, long groupId, java.lang.String className, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
CPDisplayLayout	updateCPDisplayLayout(CPDisplayLayout cpDisplayLayout) Updates the cp display layout in the database or adds it if it does not yet exist.
CPDisplayLayout	updateCPDisplayLayout(long cpDisplayLayoutId, long classPK, java.lang.String layoutUuid)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addCPDisplayLayout

@Indexable(type=REINDEX)
CPDisplayLayout addCPDisplayLayout(CPDisplayLayout cpDisplayLayout)

Adds the cp display layout to the database. Also notifies the appropriate model listeners.

Important: Inspect CPDisplayLayoutLocalServiceImpl 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:

cpDisplayLayout - the cp display layout

Returns:

the cp display layout that was added

addCPDisplayLayout

@Indexable(type=REINDEX)
CPDisplayLayout addCPDisplayLayout(long userId,
                                                            long groupId,
                                                            java.lang.Class<?> clazz,
                                                            long classPK,
                                                            java.lang.String layoutUuid)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCPDisplayLayout

@Transactional(enabled=false)
CPDisplayLayout createCPDisplayLayout(long CPDisplayLayoutId)

Creates a new cp display layout with the primary key. Does not add the cp display layout to the database.

Parameters:

CPDisplayLayoutId - the primary key for the new cp display layout

Returns:

the new cp display layout

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

deleteCPDisplayLayout

@Indexable(type=DELETE)
CPDisplayLayout deleteCPDisplayLayout(java.lang.Class<?> clazz,
                                                              long classPK)

deleteCPDisplayLayout

@Indexable(type=DELETE)
CPDisplayLayout deleteCPDisplayLayout(CPDisplayLayout cpDisplayLayout)

Deletes the cp display layout from the database. Also notifies the appropriate model listeners.

Important: Inspect CPDisplayLayoutLocalServiceImpl 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:

cpDisplayLayout - the cp display layout

Returns:

the cp display layout that was removed

deleteCPDisplayLayout

@Indexable(type=DELETE)
CPDisplayLayout deleteCPDisplayLayout(long CPDisplayLayoutId)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Deletes the cp display layout with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect CPDisplayLayoutLocalServiceImpl 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:

CPDisplayLayoutId - the primary key of the cp display layout

Returns:

the cp display layout that was removed

Throws:

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

deleteCPDisplayLayouts

void deleteCPDisplayLayouts(java.lang.Class<?> clazz,
                            long classPK)

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.CPDisplayLayoutModelImpl.

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.CPDisplayLayoutModelImpl.

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

fetchCPDisplayLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPDisplayLayout fetchCPDisplayLayout(long CPDisplayLayoutId)

fetchCPDisplayLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPDisplayLayout fetchCPDisplayLayout(long groupId,
                                                                                                        java.lang.Class<?> clazz,
                                                                                                        long classPK)

fetchCPDisplayLayoutByGroupIdAndLayoutUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CPDisplayLayout> fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId,
                                                                                                                                              java.lang.String layoutUuid)

fetchCPDisplayLayoutByGroupIdAndLayoutUuid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CPDisplayLayout> fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId,
                                                                                                                                              java.lang.String layoutUuid,
                                                                                                                                              int start,
                                                                                                                                              int end)

fetchCPDisplayLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPDisplayLayout fetchCPDisplayLayoutByUuidAndGroupId(java.lang.String uuid,
                                                                                                                        long groupId)

Returns the cp display layout matching the UUID and group.

Parameters:

uuid - the cp display layout's UUID

groupId - the primary key of the group

Returns:

the matching cp display layout, or null if a matching cp display layout could not be found

getActionableDynamicQuery

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

getCPDisplayLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPDisplayLayout getCPDisplayLayout(long CPDisplayLayoutId)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the cp display layout with the primary key.

Parameters:

CPDisplayLayoutId - the primary key of the cp display layout

Returns:

the cp display layout

Throws:

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

getCPDisplayLayoutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CPDisplayLayout getCPDisplayLayoutByUuidAndGroupId(java.lang.String uuid,
                                                                                                                      long groupId)
                                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Returns the cp display layout matching the UUID and group.

Parameters:

uuid - the cp display layout's UUID

groupId - the primary key of the group

Returns:

the matching cp display layout

Throws:

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

getCPDisplayLayouts

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

Returns a range of all the cp display layouts.

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.CPDisplayLayoutModelImpl.

Parameters:

start - the lower bound of the range of cp display layouts

end - the upper bound of the range of cp display layouts (not inclusive)

Returns:

the range of cp display layouts

getCPDisplayLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                         long companyId)

Returns all the cp display layouts matching the UUID and company.

Parameters:

uuid - the UUID of the cp display layouts

companyId - the primary key of the company

Returns:

the matching cp display layouts, or an empty list if no matches were found

getCPDisplayLayoutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                         long companyId,
                                                                                                                                         int start,
                                                                                                                                         int end,
                                                                                                                                         com.liferay.portal.kernel.util.OrderByComparator<CPDisplayLayout> orderByComparator)

Returns a range of cp display layouts matching the UUID and company.

Parameters:

uuid - the UUID of the cp display layouts

companyId - the primary key of the company

start - the lower bound of the range of cp display layouts

end - the upper bound of the range of cp display layouts (not inclusive)

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

Returns:

the range of matching cp display layouts, or an empty list if no matches were found

getCPDisplayLayoutsCount

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

Returns the number of cp display layouts.

Returns:

the number of cp display layouts

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

searchCPDisplayLayout

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.search.BaseModelSearchResult<CPDisplayLayout> searchCPDisplayLayout(long companyId,
                                                                                                                                                                 long groupId,
                                                                                                                                                                 java.lang.String className,
                                                                                                                                                                 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

updateCPDisplayLayout

@Indexable(type=REINDEX)
CPDisplayLayout updateCPDisplayLayout(CPDisplayLayout cpDisplayLayout)

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

Important: Inspect CPDisplayLayoutLocalServiceImpl 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:

cpDisplayLayout - the cp display layout

Returns:

the cp display layout that was updated

updateCPDisplayLayout

@Indexable(type=REINDEX)
CPDisplayLayout updateCPDisplayLayout(long cpDisplayLayoutId,
                                                               long classPK,
                                                               java.lang.String layoutUuid)
                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException