com.liferay.portal.kernel.service

Class LayoutBranchLocalServiceUtil

Object

com.liferay.portal.kernel.service.LayoutBranchLocalServiceUtil

@ProviderType
public class LayoutBranchLocalServiceUtil
extends Object

Provides the local service utility for LayoutBranch. This utility wraps LayoutBranchLocalServiceImpl and is the primary 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:

LayoutBranchLocalService, LayoutBranchLocalServiceBaseImpl, LayoutBranchLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
LayoutBranchLocalServiceUtil()

Method Summary

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 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	deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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 branchs.
static int	getLayoutBranchsCount() Returns the number of layout branchs.
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 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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutBranchLocalServiceUtil

public LayoutBranchLocalServiceUtil()

Method Detail

addLayoutBranch

public static LayoutBranch addLayoutBranch(LayoutBranch layoutBranch)

Adds the layout branch to the database. Also notifies the appropriate model listeners.

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

public static LayoutBranch createLayoutBranch(long layoutBranchId)

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

deleteLayoutBranch

public static LayoutBranch deleteLayoutBranch(LayoutBranch layoutBranch)

Deletes the layout branch from the database. Also notifies the appropriate model listeners.

Parameters:

layoutBranch - the layout branch

Returns:

the layout branch that was removed

deleteLayoutBranch

public static LayoutBranch deleteLayoutBranch(long layoutBranchId)
                                       throws PortalException

Deletes the layout branch with the primary key from the database. Also notifies the appropriate model listeners.

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

deleteLayoutSetBranchLayoutBranches

public static void deleteLayoutSetBranchLayoutBranches(long layoutSetBranchId)
                                                throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public 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.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutBranchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - 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 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutBranchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static 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

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchLayoutBranch

public static LayoutBranch fetchLayoutBranch(long layoutBranchId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutBranch

public static 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

public static List<LayoutBranch> getLayoutBranches(long layoutSetBranchId,
                                                   long plid,
                                                   int start,
                                                   int end,
                                                   OrderByComparator<LayoutBranch> orderByComparator)

getLayoutBranchs

public static List<LayoutBranch> getLayoutBranchs(int start,
                                                  int end)

Returns a range of all the layout branchs.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from LayoutBranchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of layout branchs

end - the upper bound of the range of layout branchs (not inclusive)

Returns:

the range of layout branchs

getLayoutBranchsCount

public static int getLayoutBranchsCount()

Returns the number of layout branchs.

Returns:

the number of layout branchs

getLayoutSetBranchLayoutBranches

public static List<LayoutBranch> getLayoutSetBranchLayoutBranches(long layoutSetBranchId)

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

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateLayoutBranch

public static LayoutBranch updateLayoutBranch(LayoutBranch layoutBranch)

Updates the layout branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

public static LayoutBranchLocalService getService()