Class CPDisplayLayoutLocalServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic CPDisplayLayout
addCPDisplayLayout
(long userId, long groupId, Class<?> clazz, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) static CPDisplayLayout
addCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Adds the cp display layout to the database.static CPDisplayLayout
createCPDisplayLayout
(long CPDisplayLayoutId) Creates a new cp display layout with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static CPDisplayLayout
deleteCPDisplayLayout
(long CPDisplayLayoutId) Deletes the cp display layout with the primary key from the database.static CPDisplayLayout
deleteCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Deletes the cp display layout from the database.static CPDisplayLayout
deleteCPDisplayLayout
(Class<?> clazz, long classPK) static void
deleteCPDisplayLayouts
(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
static <T> 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> 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> 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, Class<?> clazz, long classPK) static CPDisplayLayout
fetchCPDisplayLayoutByUuidAndGroupId
(String uuid, long groupId) Returns the cp display layout matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static CPDisplayLayout
getCPDisplayLayout
(long CPDisplayLayoutId) Returns the cp display layout with the primary key.static CPDisplayLayout
getCPDisplayLayoutByUuidAndGroupId
(String uuid, long groupId) Returns the cp display layout matching the UUID and group.static List<CPDisplayLayout>
getCPDisplayLayouts
(int start, int end) Returns a range of all the cp display layouts.static List<CPDisplayLayout>
getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
(long groupId, String layoutPageTemplateEntryUuid) static List<CPDisplayLayout>
getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
(long groupId, String layoutPageTemplateEntryUuid, int start, int end) static List<CPDisplayLayout>
getCPDisplayLayoutsByGroupIdAndLayoutUuid
(long groupId, String layoutUuid) static List<CPDisplayLayout>
getCPDisplayLayoutsByGroupIdAndLayoutUuid
(long groupId, String layoutUuid, int start, int end) static List<CPDisplayLayout>
getCPDisplayLayoutsByUuidAndCompanyId
(String uuid, long companyId) Returns all the cp display layouts matching the UUID and company.static List<CPDisplayLayout>
getCPDisplayLayoutsByUuidAndCompanyId
(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
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
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static CPDisplayLayoutLocalService
static com.liferay.portal.kernel.search.BaseModelSearchResult<CPDisplayLayout>
searchCPDisplayLayout
(long companyId, long groupId, String className, Integer type, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) static CPDisplayLayout
updateCPDisplayLayout
(long cpDisplayLayoutId, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) static CPDisplayLayout
updateCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Updates the cp display layout in the database or adds it if it does not yet exist.
-
Constructor Details
-
CPDisplayLayoutLocalServiceUtil
public CPDisplayLayoutLocalServiceUtil()
-
-
Method Details
-
addCPDisplayLayout
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, Class<?> clazz, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createCPDisplayLayout
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteCPDisplayLayout
-
deleteCPDisplayLayout
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
-
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
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> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPDisplayLayoutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPDisplayLayoutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchCPDisplayLayout
-
fetchCPDisplayLayout
-
fetchCPDisplayLayoutByUuidAndGroupId
Returns the cp display layout matching the UUID and group.- Parameters:
uuid
- the cp display layout's UUIDgroupId
- 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(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 UUIDgroupId
- 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
Returns a range of all the cp display layouts.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.commerce.product.model.impl.CPDisplayLayoutModelImpl
.- Parameters:
start
- the lower bound of the range of cp display layoutsend
- the upper bound of the range of cp display layouts (not inclusive)- Returns:
- the range of cp display layouts
-
getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
public static List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid) -
getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
public static List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid, int start, int end) -
getCPDisplayLayoutsByGroupIdAndLayoutUuid
public static List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid) -
getCPDisplayLayoutsByGroupIdAndLayoutUuid
public static List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid, int start, int end) -
getCPDisplayLayoutsByUuidAndCompanyId
public static List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(String uuid, long companyId) Returns all the cp display layouts matching the UUID and company.- Parameters:
uuid
- the UUID of the cp display layoutscompanyId
- the primary key of the company- Returns:
- the matching cp display layouts, or an empty list if no matches were found
-
getCPDisplayLayoutsByUuidAndCompanyId
public static List<CPDisplayLayout> getCPDisplayLayoutsByUuidAndCompanyId(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 layoutscompanyId
- the primary key of the companystart
- the lower bound of the range of cp display layoutsend
- the upper bound of the range of cp display layouts (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(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, String className, Integer type, 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
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, String layoutPageTemplateEntryUuid, String layoutUuid) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getService
-