public class LayoutBranchLocalServiceUtil
extends Object
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.LayoutBranchLocalService
Constructor and Description |
---|
LayoutBranchLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static LayoutBranch |
addLayoutBranch(LayoutBranch layoutBranch)
Adds the layout branch to the database.
|
static 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 |
createLayoutBranch(long layoutBranchId)
Creates a new layout branch with the primary key.
|
static PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
static LayoutBranch |
deleteLayoutBranch(LayoutBranch layoutBranch)
Deletes the layout branch from the database.
|
static LayoutBranch |
deleteLayoutBranch(long layoutBranchId)
Deletes the layout branch with the primary key 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 |
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 |
getActionableDynamicQuery() |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
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 |
getLayoutBranchsCount()
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 |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static LayoutBranchLocalService |
getService() |
static void |
setService(LayoutBranchLocalService service) |
static LayoutBranch |
updateLayoutBranch(LayoutBranch layoutBranch)
Updates the layout branch in the database or adds it if it does not yet exist.
|
static LayoutBranch |
updateLayoutBranch(long layoutBranchId,
String name,
String description,
ServiceContext serviceContext) |
public static LayoutBranch addLayoutBranch(LayoutBranch layoutBranch)
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.
layoutBranch
- the layout branchpublic static LayoutBranch addLayoutBranch(long layoutSetBranchId, long plid, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException
PortalException
public static LayoutBranch addLayoutBranch(long layoutRevisionId, String name, String description, boolean master, ServiceContext serviceContext) throws PortalException
PortalException
public static LayoutBranch createLayoutBranch(long layoutBranchId)
layoutBranchId
- the primary key for the new layout branchpublic static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch)
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.
layoutBranch
- the layout branchpublic static LayoutBranch deleteLayoutBranch(long layoutBranchId) throws PortalException
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.
layoutBranchId
- the primary key of the layout branchPortalException
- if a layout branch with the primary key could not be foundpublic static void deleteLayoutBranchesByPlid(long plid) throws PortalException
PortalException
public static void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId) throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutBranchModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutBranchModelImpl
.
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 (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static LayoutBranch fetchLayoutBranch(long layoutBranchId)
public static ActionableDynamicQuery getActionableDynamicQuery()
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static LayoutBranch getLayoutBranch(long layoutBranchId) throws PortalException
layoutBranchId
- the primary key of the layout branchPortalException
- if a layout branch with the primary key could not be foundpublic static List<LayoutBranch> getLayoutBranches(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutBranch> orderByComparator)
public static List<LayoutBranch> getLayoutBranchs(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.LayoutBranchModelImpl
.
start
- the lower bound of the range of layout branchesend
- the upper bound of the range of layout branches (not inclusive)public static int getLayoutBranchsCount()
public static List<LayoutBranch> getLayoutSetBranchLayoutBranches(long layoutSetBranchId)
public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid) throws PortalException
PortalException
public static LayoutBranch getMasterLayoutBranch(long layoutSetBranchId, long plid, ServiceContext serviceContext) throws PortalException
PortalException
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch)
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.
layoutBranch
- the layout branchpublic static LayoutBranch updateLayoutBranch(long layoutBranchId, String name, String description, ServiceContext serviceContext) throws PortalException
PortalException
public static LayoutBranchLocalService getService()
public static void setService(LayoutBranchLocalService service)