Class LayoutSetBranchLocalServiceUtil
com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic LayoutSetBranchaddLayoutSetBranch(long userId, long groupId, boolean privateLayout, String name, String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext) static LayoutSetBranchaddLayoutSetBranch(LayoutSetBranch layoutSetBranch) Adds the layout set branch to the database.static LayoutSetBranchcreateLayoutSetBranch(long layoutSetBranchId) Creates a new layout set branch with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static LayoutSetBranchdeleteLayoutSetBranch(long layoutSetBranchId) Deletes the layout set branch with the primary key from the database.static LayoutSetBranchdeleteLayoutSetBranch(long currentLayoutPlid, long layoutSetBranchId) static LayoutSetBranchdeleteLayoutSetBranch(long currentLayoutPlid, LayoutSetBranch layoutSetBranch, boolean includeMaster) static LayoutSetBranchdeleteLayoutSetBranch(LayoutSetBranch layoutSetBranch) Deletes the layout set branch from the database.static LayoutSetBranchdeleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster) static voiddeleteLayoutSetBranches(long groupId, boolean privateLayout) static voiddeleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster) static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <T> List<T>dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <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.static <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.static longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static LayoutSetBranchfetchLayoutSetBranch(long layoutSetBranchId) static LayoutSetBranchfetchLayoutSetBranch(long groupId, boolean privateLayout, String name) static ActionableDynamicQuerystatic LayoutSetBranchgetLayoutSetBranch(long layoutSetBranchId) Returns the layout set branch with the primary key.static LayoutSetBranchgetLayoutSetBranch(long groupId, boolean privateLayout, String name) static List<LayoutSetBranch>getLayoutSetBranches(long groupId, boolean privateLayout) static List<LayoutSetBranch>getLayoutSetBranchs(int start, int end) Returns a range of all the layout set branches.static intReturns the number of layout set branches.static LayoutSetBranchgetMasterLayoutSetBranch(long groupId, boolean privateLayout) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static LayoutSetBranchLocalServicestatic LayoutSetBranchgetUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId) static LayoutSetBranchmergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext) static voidsetService(LayoutSetBranchLocalService service) static LayoutSetBranchupdateLayoutSetBranch(long layoutSetBranchId, String name, String description, ServiceContext serviceContext) static LayoutSetBranchupdateLayoutSetBranch(LayoutSetBranch layoutSetBranch) Updates the layout set branch in the database or adds it if it does not yet exist.
-
Constructor Details
-
LayoutSetBranchLocalServiceUtil
public LayoutSetBranchLocalServiceUtil()
-
-
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
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranch
public static 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
public static LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranch
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
public static LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, LayoutSetBranch layoutSetBranch, boolean includeMaster) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranch
public static LayoutSetBranch deleteLayoutSetBranch(long currentLayoutPlid, long layoutSetBranchId) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranches
public static void deleteLayoutSetBranches(long groupId, boolean privateLayout) throws PortalException - Throws:
PortalException
-
deleteLayoutSetBranches
public static void deleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster) throws PortalException - Throws:
PortalException
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
public static <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
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
-
fetchLayoutSetBranch
public static LayoutSetBranch fetchLayoutSetBranch(long groupId, boolean privateLayout, String name) -
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getLayoutSetBranch
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
public static LayoutSetBranch getLayoutSetBranch(long groupId, boolean privateLayout, String name) throws PortalException - Throws:
PortalException
-
getLayoutSetBranches
-
getLayoutSetBranchs
Returns a range of all the layout set branches.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
public static int getLayoutSetBranchsCount()Returns the number of layout set branches.- Returns:
- the number of layout set branches
-
getMasterLayoutSetBranch
public static LayoutSetBranch getMasterLayoutSetBranch(long groupId, boolean privateLayout) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getUserLayoutSetBranch
public static LayoutSetBranch getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId) throws PortalException - Throws:
PortalException
-
mergeLayoutSetBranch
public static 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
public static LayoutSetBranch updateLayoutSetBranch(long layoutSetBranchId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
getService
-
setService
-