Class LayoutBranchLocalServiceUtil
com.liferay.portal.service.impl.LayoutBranchLocalServiceImpl
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 LayoutBranch
addLayoutBranch
(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) static LayoutBranch
addLayoutBranch
(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext) static LayoutBranch
addLayoutBranch
(LayoutBranch layoutBranch) Adds the layout branch to the database.static LayoutBranch
createLayoutBranch
(long layoutBranchId) Creates a new layout branch with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static LayoutBranch
deleteLayoutBranch
(long layoutBranchId) Deletes the layout branch with the primary key from the database.static LayoutBranch
deleteLayoutBranch
(LayoutBranch layoutBranch) Deletes the layout branch from the database.static void
deleteLayoutBranchesByPlid
(long plid) static void
deleteLayoutSetBranchLayoutBranches
(long layoutSetBranchId) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <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 long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static LayoutBranch
fetchLayoutBranch
(long layoutBranchId) static ActionableDynamicQuery
static LayoutBranch
getLayoutBranch
(long layoutBranchId) Returns the layout branch with the primary key.static List<LayoutBranch>
getLayoutBranches
(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator) static List<LayoutBranch>
getLayoutBranchs
(int start, int end) Returns a range of all the layout branches.static int
Returns the number of layout branches.static List<LayoutBranch>
getLayoutSetBranchLayoutBranches
(long layoutSetBranchId) static LayoutBranch
getMasterLayoutBranch
(long layoutSetBranchId, long plid) static LayoutBranch
getMasterLayoutBranch
(long layoutSetBranchId, long plid, ServiceContext serviceContext) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static LayoutBranchLocalService
static void
setService
(LayoutBranchLocalService service) static LayoutBranch
updateLayoutBranch
(long layoutBranchId, String name, String description, ServiceContext serviceContext) static LayoutBranch
updateLayoutBranch
(LayoutBranch layoutBranch) Updates the layout branch in the database or adds it if it does not yet exist.
-
Constructor Details
-
LayoutBranchLocalServiceUtil
public LayoutBranchLocalServiceUtil()
-
-
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
public static LayoutBranch addLayoutBranch(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addLayoutBranch
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId) 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 - 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
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 - 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
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
-
fetchLayoutBranch
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getLayoutBranch
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
public static List<LayoutBranch> getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator) -
getLayoutBranchs
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
public static int getLayoutBranchsCount()Returns the number of layout branches.- Returns:
- the number of layout branches
-
getLayoutSetBranchLayoutBranches
-
getMasterLayoutBranch
public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid) throws PortalException - Throws:
PortalException
-
getMasterLayoutBranch
public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- 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
public static LayoutBranch updateLayoutBranch(long layoutBranchId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
getService
-
setService
-