Interface CPDisplayLayoutLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService
,com.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
CPDisplayLayoutLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddCPDisplayLayout
(long userId, long groupId, Class<?> clazz, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) addCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Adds the cp display layout to the database.createCPDisplayLayout
(long CPDisplayLayoutId) Creates a new cp display layout with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteCPDisplayLayout
(long CPDisplayLayoutId) Deletes the cp display layout with the primary key from the database.deleteCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Deletes the cp display layout from the database.deleteCPDisplayLayout
(Class<?> clazz, long classPK) void
deleteCPDisplayLayouts
(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
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.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.fetchCPDisplayLayout
(long CPDisplayLayoutId) fetchCPDisplayLayout
(long groupId, Class<?> clazz, long classPK) fetchCPDisplayLayoutByUuidAndGroupId
(String uuid, long groupId) Returns the cp display layout matching the UUID and group.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getCPDisplayLayout
(long CPDisplayLayoutId) Returns the cp display layout with the primary key.getCPDisplayLayoutByUuidAndGroupId
(String uuid, long groupId) Returns the cp display layout matching the UUID and group.getCPDisplayLayouts
(int start, int end) Returns a range of all the cp display layouts.getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
(long groupId, String layoutPageTemplateEntryUuid) getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
(long groupId, String layoutPageTemplateEntryUuid, int start, int end) getCPDisplayLayoutsByGroupIdAndLayoutUuid
(long groupId, String layoutUuid) getCPDisplayLayoutsByGroupIdAndLayoutUuid
(long groupId, String layoutUuid, int start, int end) getCPDisplayLayoutsByUuidAndCompanyId
(String uuid, long companyId) Returns all the cp display layouts matching the UUID and company.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.int
Returns the number of cp display layouts.com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPDisplayLayout>
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) 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) updateCPDisplayLayout
(long cpDisplayLayoutId, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) updateCPDisplayLayout
(CPDisplayLayout cpDisplayLayout) Updates the cp display layout in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPDisplayLayout>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
@Indexable(type=REINDEX) 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
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- 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
@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
-
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 interfacecom.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 interfacecom.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 interfacecom.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> 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> 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@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 queryprojection
- 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, Class<?> clazz, long classPK) -
fetchCPDisplayLayoutByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) CPDisplayLayout fetchCPDisplayLayoutByUuidAndGroupId(String uuid, long groupId) 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
@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(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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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
@Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid) -
getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid
@Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutPageTemplateEntryUuid(long groupId, String layoutPageTemplateEntryUuid, int start, int end) -
getCPDisplayLayoutsByGroupIdAndLayoutUuid
@Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid) -
getCPDisplayLayoutsByGroupIdAndLayoutUuid
@Transactional(propagation=SUPPORTS, readOnly=true) List<CPDisplayLayout> getCPDisplayLayoutsByGroupIdAndLayoutUuid(long groupId, String layoutUuid, int start, int end) -
getCPDisplayLayoutsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@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
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(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModel
in interfacecom.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, 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
@Indexable(type=REINDEX) CPDisplayLayout updateCPDisplayLayout(long cpDisplayLayoutId, long classPK, String layoutPageTemplateEntryUuid, String layoutUuid) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPDisplayLayout> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<CPDisplayLayout>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<CPDisplayLayout>
- Throws:
E extends Throwable
-