com.liferay.commerce.product.service

Class CPDisplayLayoutLocalServiceUtil

java.lang.Object

com.liferay.commerce.product.service.CPDisplayLayoutLocalServiceUtil

public class CPDisplayLayoutLocalServiceUtil
extends java.lang.Object

Provides the local service utility for CPDisplayLayout. This utility wraps com.liferay.commerce.product.service.impl.CPDisplayLayoutLocalServiceImpl 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:

CPDisplayLayoutLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
CPDisplayLayoutLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CPDisplayLayoutLocalServiceUtil

public CPDisplayLayoutLocalServiceUtil()

Method Detail

addCPDisplayLayout

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

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

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

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

deleteCPDisplayLayout

public static CPDisplayLayout deleteCPDisplayLayout(java.lang.Class<?> clazz,
                                                    long classPK)

deleteCPDisplayLayout

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

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

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

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

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

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

fetchCPDisplayLayout

public static CPDisplayLayout fetchCPDisplayLayout(long CPDisplayLayoutId)

fetchCPDisplayLayout

public static CPDisplayLayout fetchCPDisplayLayout(long groupId,
                                                   java.lang.Class<?> clazz,
                                                   long classPK)

fetchCPDisplayLayoutByGroupIdAndLayoutUuid

public static java.util.List<CPDisplayLayout> fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId,
                                                                                         java.lang.String layoutUuid)

fetchCPDisplayLayoutByGroupIdAndLayoutUuid

public static java.util.List<CPDisplayLayout> fetchCPDisplayLayoutByGroupIdAndLayoutUuid(long groupId,
                                                                                         java.lang.String layoutUuid,
                                                                                         int start,
                                                                                         int end)

fetchCPDisplayLayoutByUuidAndGroupId

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

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

getCPDisplayLayout

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

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

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

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

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

public static int getCPDisplayLayoutsCount()

Returns the number of cp display layouts.

Returns:

the number of cp display layouts

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

searchCPDisplayLayout

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

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

public static CPDisplayLayout updateCPDisplayLayout(long cpDisplayLayoutId,
                                                    long classPK,
                                                    java.lang.String layoutUuid)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CPDisplayLayoutLocalService getService()