Interface LayoutRevisionLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutRevisionLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutRevision
(long userId, long layoutSetBranchId, long layoutBranchId, long parentLayoutRevisionId, boolean head, long plid, long portletPreferencesPlid, boolean privateLayout, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext) addLayoutRevision
(LayoutRevision layoutRevision) Adds the layout revision to the database.createLayoutRevision
(long layoutRevisionId) Creates a new layout revision with the primary key.createPersistedModel
(Serializable primaryKeyObj) void
deleteLayoutLayoutRevisions
(long plid) deleteLayoutRevision
(long layoutRevisionId) Deletes the layout revision with the primary key from the database.deleteLayoutRevision
(LayoutRevision layoutRevision) Deletes the layout revision from the database.void
deleteLayoutRevisions
(long layoutSetBranchId, long plid) void
deleteLayoutRevisions
(long layoutSetBranchId, long layoutBranchId, long plid) void
deleteLayoutSetBranchLayoutRevisions
(long layoutSetBranchId) deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(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
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchLastLayoutRevision
(long plid, boolean head) fetchLatestLayoutRevision
(long layoutSetBranchId, long plid) fetchLatestLayoutRevision
(long layoutSetBranchId, long layoutBranchId, long plid) fetchLayoutRevision
(long layoutRevisionId) fetchLayoutRevision
(long layoutSetBranchId, long layoutBranchId, boolean head, long plid) getChildLayoutRevisions
(long layoutSetBranchId, long parentLayoutRevisionId, long plid) getChildLayoutRevisions
(long layoutSetBranchId, long parentLayoutRevision, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) int
getChildLayoutRevisionsCount
(long layoutSetBranchId, long parentLayoutRevision, long plid) getLayoutRevision
(long layoutRevisionId) Returns the layout revision with the primary key.getLayoutRevision
(long layoutSetBranchId, long layoutBranchId, long plid) getLayoutRevisions
(int start, int end) Returns a range of all the layout revisions.getLayoutRevisions
(long plid) getLayoutRevisions
(long layoutSetBranchId, boolean head) getLayoutRevisions
(long layoutSetBranchId, boolean head, int status) getLayoutRevisions
(long layoutSetBranchId, int status) getLayoutRevisions
(long layoutSetBranchId, long plid) getLayoutRevisions
(long layoutSetBranchId, long plid, boolean head) getLayoutRevisions
(long layoutSetBranchId, long plid, int status) getLayoutRevisions
(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) getLayoutRevisions
(long layoutSetBranchId, long layoutBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) getLayoutRevisionsByStatus
(int status) int
Returns the number of layout revisions.int
getLayoutRevisionsCount
(long plid) int
getLayoutRevisionsCount
(long layoutSetBranchId, long layoutBranchId, long plid) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) updateLayoutRevision
(long userId, long layoutRevisionId, long layoutBranchId, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext) updateLayoutRevision
(LayoutRevision layoutRevision) Updates the layout revision in the database or adds it if it does not yet exist.updateStatus
(long userId, long layoutRevisionId, int status, ServiceContext serviceContext) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutRevision
Adds the layout revision to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutRevisionLocalServiceImpl 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:
layoutRevision
- the layout revision- Returns:
- the layout revision that was added
-
addLayoutRevision
LayoutRevision addLayoutRevision(long userId, long layoutSetBranchId, long layoutBranchId, long parentLayoutRevisionId, boolean head, long plid, long portletPreferencesPlid, boolean privateLayout, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createLayoutRevision
Creates a new layout revision with the primary key. Does not add the layout revision to the database.- Parameters:
layoutRevisionId
- the primary key for the new layout revision- Returns:
- the new layout revision
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutLayoutRevisions
- Throws:
PortalException
-
deleteLayoutRevision
@Indexable(type=DELETE) @SystemEvent(type=1) LayoutRevision deleteLayoutRevision(LayoutRevision layoutRevision) throws PortalException Deletes the layout revision from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutRevisionLocalServiceImpl 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:
layoutRevision
- the layout revision- Returns:
- the layout revision that was removed
- Throws:
PortalException
-
deleteLayoutRevision
@Indexable(type=DELETE) LayoutRevision deleteLayoutRevision(long layoutRevisionId) throws PortalException Deletes the layout revision with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutRevisionLocalServiceImpl 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:
layoutRevisionId
- the primary key of the layout revision- Returns:
- the layout revision that was removed
- Throws:
PortalException
- if a layout revision with the primary key could not be found
-
deleteLayoutRevisions
- Throws:
PortalException
-
deleteLayoutRevisions
void deleteLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranchLayoutRevisions
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(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.portal.model.impl.LayoutRevisionModelImpl
.- 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(DynamicQuery dynamicQuery, int start, int end, 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.portal.model.impl.LayoutRevisionModelImpl
.- 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(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(DynamicQuery dynamicQuery, 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
-
fetchLastLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision fetchLastLayoutRevision(long plid, boolean head) -
fetchLatestLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId, long plid) -
fetchLatestLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId, long layoutBranchId, long plid) -
fetchLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision fetchLayoutRevision(long layoutRevisionId) -
fetchLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision fetchLayoutRevision(long layoutSetBranchId, long layoutBranchId, boolean head, long plid) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getChildLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevisionId, long plid) -
getChildLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevision, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) -
getChildLayoutRevisionsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getChildLayoutRevisionsCount(long layoutSetBranchId, long parentLayoutRevision, long plid) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision getLayoutRevision(long layoutRevisionId) throws PortalException Returns the layout revision with the primary key.- Parameters:
layoutRevisionId
- the primary key of the layout revision- Returns:
- the layout revision
- Throws:
PortalException
- if a layout revision with the primary key could not be found
-
getLayoutRevision
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutRevision getLayoutRevision(long layoutSetBranchId, long layoutBranchId, long plid) throws PortalException - Throws:
PortalException
-
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(int start, int end) Returns a range of all the layout revisions.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.portal.model.impl.LayoutRevisionModelImpl
.- Parameters:
start
- the lower bound of the range of layout revisionsend
- the upper bound of the range of layout revisions (not inclusive)- Returns:
- the range of layout revisions
-
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long plid) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, boolean head) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, boolean head, int status) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, int status) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, boolean head) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int status) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) -
getLayoutRevisions
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator) -
getLayoutRevisionsByStatus
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutRevision> getLayoutRevisionsByStatus(int status) -
getLayoutRevisionsCount
Returns the number of layout revisions.- Returns:
- the number of layout revisions
-
getLayoutRevisionsCount
-
getLayoutRevisionsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getLayoutRevisionsCount(long layoutSetBranchId, long layoutBranchId, long plid) -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
updateLayoutRevision
Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutRevisionLocalServiceImpl 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:
layoutRevision
- the layout revision- Returns:
- the layout revision that was updated
-
updateLayoutRevision
LayoutRevision updateLayoutRevision(long userId, long layoutRevisionId, long layoutBranchId, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateStatus
LayoutRevision updateStatus(long userId, long layoutRevisionId, int status, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-