com.liferay.portal.kernel.service

Class LayoutSetBranchLocalServiceUtil

Object

com.liferay.portal.kernel.service.LayoutSetBranchLocalServiceUtil

@ProviderType
public class LayoutSetBranchLocalServiceUtil
extends Object

Provides the local service utility for LayoutSetBranch. This utility wraps LayoutSetBranchLocalServiceImpl 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:

LayoutSetBranchLocalService, LayoutSetBranchLocalServiceBaseImpl, LayoutSetBranchLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
LayoutSetBranchLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static LayoutSetBranch	addLayoutSetBranch(LayoutSetBranch layoutSetBranch) Adds the layout set branch to the database.
static LayoutSetBranch	addLayoutSetBranch(long userId, long groupId, boolean privateLayout, String name, String description, boolean master, long copyLayoutSetBranchId, ServiceContext serviceContext)
static LayoutSetBranch	createLayoutSetBranch(long layoutSetBranchId) Creates a new layout set branch with the primary key.
static LayoutSetBranch	deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch) Deletes the layout set branch from the database.
static LayoutSetBranch	deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch, boolean includeMaster)
static LayoutSetBranch	deleteLayoutSetBranch(long layoutSetBranchId) Deletes the layout set branch with the primary key from the database.
static void	deleteLayoutSetBranches(long groupId, boolean privateLayout)
static void	deleteLayoutSetBranches(long groupId, boolean privateLayout, boolean includeMaster)
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 LayoutSetBranch	fetchLayoutSetBranch(long layoutSetBranchId)
static LayoutSetBranch	fetchLayoutSetBranch(long groupId, boolean privateLayout, String name)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static LayoutSetBranch	getLayoutSetBranch(long layoutSetBranchId) Returns the layout set branch with the primary key.
static LayoutSetBranch	getLayoutSetBranch(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 branchs.
static int	getLayoutSetBranchsCount() Returns the number of layout set branchs.
static LayoutSetBranch	getMasterLayoutSetBranch(long groupId, boolean privateLayout)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static LayoutSetBranchLocalService	getService()
static LayoutSetBranch	getUserLayoutSetBranch(long userId, long groupId, boolean privateLayout, long layoutSetId, long layoutSetBranchId)
static LayoutSetBranch	mergeLayoutSetBranch(long layoutSetBranchId, long mergeLayoutSetBranchId, ServiceContext serviceContext)
static LayoutSetBranch	updateLayoutSetBranch(LayoutSetBranch layoutSetBranch) Updates the layout set branch in the database or adds it if it does not yet exist.
static LayoutSetBranch	updateLayoutSetBranch(long layoutSetBranchId, String name, String description, ServiceContext serviceContext)

Methods inherited from class Object

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

Constructor Detail

LayoutSetBranchLocalServiceUtil

public LayoutSetBranchLocalServiceUtil()

Method Detail

addLayoutSetBranch

public static LayoutSetBranch addLayoutSetBranch(LayoutSetBranch layoutSetBranch)

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

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

public static LayoutSetBranch createLayoutSetBranch(long layoutSetBranchId)

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

deleteLayoutSetBranch

public static LayoutSetBranch deleteLayoutSetBranch(LayoutSetBranch layoutSetBranch)
                                             throws PortalException

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

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

public static LayoutSetBranch deleteLayoutSetBranch(long layoutSetBranchId)
                                             throws PortalException

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

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

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

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

fetchLayoutSetBranch

public static LayoutSetBranch fetchLayoutSetBranch(long layoutSetBranchId)

fetchLayoutSetBranch

public static LayoutSetBranch fetchLayoutSetBranch(long groupId,
                                                   boolean privateLayout,
                                                   String name)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutSetBranch

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

public static LayoutSetBranch getLayoutSetBranch(long groupId,
                                                 boolean privateLayout,
                                                 String name)
                                          throws PortalException

Throws:

PortalException

getLayoutSetBranches

public static List<LayoutSetBranch> getLayoutSetBranches(long groupId,
                                                         boolean privateLayout)

getLayoutSetBranchs

public static List<LayoutSetBranch> getLayoutSetBranchs(int start,
                                                        int end)

Returns a range of all the layout set 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 LayoutSetBranchModelImpl. 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 set branchs

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

Returns:

the range of layout set branchs

getLayoutSetBranchsCount

public static int getLayoutSetBranchsCount()

Returns the number of layout set branchs.

Returns:

the number of layout set branchs

getMasterLayoutSetBranch

public static LayoutSetBranch getMasterLayoutSetBranch(long groupId,
                                                       boolean privateLayout)
                                                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

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

public static LayoutSetBranch updateLayoutSetBranch(LayoutSetBranch layoutSetBranch)

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

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

public static LayoutSetBranchLocalService getService()