Interface LayoutSetBranchLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
LayoutSetBranchLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddLayoutSetBranch
(long userId, long groupId, boolean privateLayout, String name, String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext) addLayoutSetBranch
(LayoutSetBranch layoutSetBranch) Adds the layout set branch to the database.createLayoutSetBranch
(long layoutSetBranchId) Creates a new layout set branch with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteLayoutSetBranch
(long layoutSetBranchId) Deletes the layout set branch with the primary key from the database.deleteLayoutSetBranch
(long currentLayoutPlid, long layoutSetBranchId) deleteLayoutSetBranch
(long currentLayoutPlid, LayoutSetBranch layoutSetBranch, boolean includeMaster) deleteLayoutSetBranch
(LayoutSetBranch layoutSetBranch) Deletes the layout set branch from the database.deleteLayoutSetBranch
(LayoutSetBranch layoutSetBranch, boolean includeMaster) void
deleteLayoutSetBranches
(long groupId, boolean privateLayout) void
deleteLayoutSetBranches
(long groupId, boolean privateLayout, boolean includeMaster) 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.fetchLayoutSetBranch
(long layoutSetBranchId) fetchLayoutSetBranch
(long groupId, boolean privateLayout, String name) getLayoutSetBranch
(long layoutSetBranchId) Returns the layout set branch with the primary key.getLayoutSetBranch
(long groupId, boolean privateLayout, String name) getLayoutSetBranches
(long groupId, boolean privateLayout) getLayoutSetBranchs
(int start, int end) Returns a range of all the layout set branches.int
Returns the number of layout set branches.getMasterLayoutSetBranch
(long groupId, boolean privateLayout) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getUserLayoutSetBranch
(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId) mergeLayoutSetBranch
(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext) updateLayoutSetBranch
(long layoutSetBranchId, String name, String description, ServiceContext serviceContext) updateLayoutSetBranch
(LayoutSetBranch layoutSetBranch) Updates the layout set 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
-
addLayoutSetBranch
Adds the layout set branch to the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetBranchLocalServiceImpl 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:
layoutSetBranch
- the layout set branch- Returns:
- the layout set branch that was added
-
addLayoutSetBranch
LayoutSetBranch addLayoutSetBranch(long userId, long groupId, boolean privateLayout, String name, String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createLayoutSetBranch
Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.- Parameters:
layoutSetBranchId
- the primary key for the new layout set branch- Returns:
- the new layout set branch
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteLayoutSetBranch
@Indexable(type=DELETE) LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch) throws PortalException Deletes the layout set branch from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetBranchLocalServiceImpl 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:
layoutSetBranch
- the layout set branch- Returns:
- the layout set branch that was removed
- Throws:
PortalException
-
deleteLayoutSetBranch
LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranch
@Indexable(type=DELETE) LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId) throws PortalException Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect LayoutSetBranchLocalServiceImpl 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:
layoutSetBranchId
- the primary key of the layout set branch- Returns:
- the layout set branch that was removed
- Throws:
PortalException
- if a layout set branch with the primary key could not be found
-
deleteLayoutSetBranch
LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranch
LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, long layoutSetBranchId) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranches
- Throws:
PortalException
-
deleteLayoutSetBranches
void deleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster) throws PortalException - 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.LayoutSetBranchModelImpl
.- 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.LayoutSetBranchModelImpl
.- 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
-
fetchLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId) -
fetchLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch fetchLayoutSetBranch(long groupId, boolean privateLayout, String name) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch getLayoutSetBranch(long layoutSetBranchId) throws PortalException Returns the layout set branch with the primary key.- Parameters:
layoutSetBranchId
- the primary key of the layout set branch- Returns:
- the layout set branch
- Throws:
PortalException
- if a layout set branch with the primary key could not be found
-
getLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch getLayoutSetBranch(long groupId, boolean privateLayout, String name) throws PortalException - Throws:
PortalException
-
getLayoutSetBranches
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetBranch> getLayoutSetBranches(long groupId, boolean privateLayout) -
getLayoutSetBranchs
@Transactional(propagation=SUPPORTS, readOnly=true) List<LayoutSetBranch> getLayoutSetBranchs(int start, int end) Returns a range of all the layout set 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.LayoutSetBranchModelImpl
.- Parameters:
start
- the lower bound of the range of layout set branchesend
- the upper bound of the range of layout set branches (not inclusive)- Returns:
- the range of layout set branches
-
getLayoutSetBranchsCount
Returns the number of layout set branches.- Returns:
- the number of layout set branches
-
getMasterLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch getMasterLayoutSetBranch(long groupId, boolean privateLayout) 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
-
getUserLayoutSetBranch
@Transactional(propagation=SUPPORTS, readOnly=true) LayoutSetBranch getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId) throws PortalException - Throws:
PortalException
-
mergeLayoutSetBranch
LayoutSetBranch mergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateLayoutSetBranch
Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect LayoutSetBranchLocalServiceImpl 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:
layoutSetBranch
- the layout set branch- Returns:
- the layout set branch that was updated
-
updateLayoutSetBranch
LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-