Interface LayoutBranchLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutBranchLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutBranch
(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) addLayoutBranch
(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext) addLayoutBranch
(LayoutBranch layoutBranch) Adds the layout branch to the database.createLayoutBranch
(long layoutBranchId) Creates a new layout branch with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteLayoutBranch
(long layoutBranchId) Deletes the layout branch with the primary key from the database.deleteLayoutBranch
(LayoutBranch layoutBranch) Deletes the layout branch from the database.void
deleteLayoutBranchesByPlid
(long plid) void
deleteLayoutSetBranchLayoutBranches
(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.fetchLayoutBranch
(long layoutBranchId) getLayoutBranch
(long layoutBranchId) Returns the layout branch with the primary key.getLayoutBranches
(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator) getLayoutBranchs
(int start, int end) Returns a range of all the layout branches.int
Returns the number of layout branches.getLayoutSetBranchLayoutBranches
(long layoutSetBranchId) getMasterLayoutBranch
(long layoutSetBranchId, long plid) getMasterLayoutBranch
(long layoutSetBranchId, long plid, ServiceContext serviceContext) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) updateLayoutBranch
(long layoutBranchId, String name, String description, ServiceContext serviceContext) updateLayoutBranch
(LayoutBranch layoutBranch) Updates the layout branch in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addLayoutBranch
Adds the layout branch to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutBranchLocalServiceImpl 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:
layoutBranch
- the layout branch- Returns:
- the layout branch that was added
-
addLayoutBranch
LayoutBranch addLayoutBranch(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addLayoutBranch
LayoutBranch addLayoutBranch(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createLayoutBranch
Creates a new layout branch with the primary key. Does not add the layout branch to the database.- Parameters:
layoutBranchId
- the primary key for the new layout branch- Returns:
- the new layout branch
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutBranch
Deletes the layout branch from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutBranchLocalServiceImpl 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:
layoutBranch
- the layout branch- Returns:
- the layout branch that was removed
-
deleteLayoutBranch
Deletes the layout branch with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutBranchLocalServiceImpl 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:
layoutBranchId
- the primary key of the layout branch- Returns:
- the layout branch that was removed
- Throws:
PortalException
- if a layout branch with the primary key could not be found
-
deleteLayoutBranchesByPlid
- Throws:
PortalException
-
deleteLayoutSetBranchLayoutBranches
- 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.LayoutBranchModelImpl
.- 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.LayoutBranchModelImpl
.- 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
-
fetchLayoutBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutBranch fetchLayoutBranch(long layoutBranchId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLayoutBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutBranch getLayoutBranch(long layoutBranchId) throws PortalException Returns the layout branch with the primary key.- Parameters:
layoutBranchId
- the primary key of the layout branch- Returns:
- the layout branch
- Throws:
PortalException
- if a layout branch with the primary key could not be found
-
getLayoutBranches
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutBranch> getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator) -
getLayoutBranchs
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutBranch> getLayoutBranchs(int start, int end) Returns a range of all the layout branches.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.LayoutBranchModelImpl
.- Parameters:
start
- the lower bound of the range of layout branchesend
- the upper bound of the range of layout branches (not inclusive)- Returns:
- the range of layout branches
-
getLayoutBranchsCount
Returns the number of layout branches.- Returns:
- the number of layout branches
-
getLayoutSetBranchLayoutBranches
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutBranch> getLayoutSetBranchLayoutBranches(long layoutSetBranchId) -
getMasterLayoutBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid) throws PortalException - Throws:
PortalException
-
getMasterLayoutBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
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
-
updateLayoutBranch
Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutBranchLocalServiceImpl 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:
layoutBranch
- the layout branch- Returns:
- the layout branch that was updated
-
updateLayoutBranch
LayoutBranch updateLayoutBranch(long layoutBranchId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-