com.liferay.portal.kernel.service

Class LayoutRevisionLocalServiceUtil

Object

com.liferay.portal.kernel.service.LayoutRevisionLocalServiceUtil

@ProviderType
public class LayoutRevisionLocalServiceUtil
extends Object

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

LayoutRevisionLocalService, LayoutRevisionLocalServiceBaseImpl, LayoutRevisionLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
LayoutRevisionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static LayoutRevision	addLayoutRevision(LayoutRevision layoutRevision) Adds the layout revision to the database.
static LayoutRevision	addLayoutRevision(long userId, long layoutSetBranchId, long layoutBranchId, long parentLayoutRevisionId, boolean head, long plid, long portletPreferencesPlid, boolean privateLayout, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext)
static LayoutRevision	createLayoutRevision(long layoutRevisionId) Creates a new layout revision with the primary key.
static void	deleteLayoutLayoutRevisions(long plid)
static LayoutRevision	deleteLayoutRevision(LayoutRevision layoutRevision) Deletes the layout revision from the database.
static LayoutRevision	deleteLayoutRevision(long layoutRevisionId) Deletes the layout revision with the primary key from the database.
static void	deleteLayoutRevisions(long layoutSetBranchId, long plid)
static void	deleteLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid)
static void	deleteLayoutSetBranchLayoutRevisions(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 LayoutRevision	fetchLastLayoutRevision(long plid, boolean head)
static LayoutRevision	fetchLatestLayoutRevision(long layoutSetBranchId, long plid)
static LayoutRevision	fetchLayoutRevision(long layoutRevisionId)
static LayoutRevision	fetchLayoutRevision(long layoutSetBranchId, boolean head, long plid) Deprecated. As of Judson (7.1.x), with no direct replacement
static LayoutRevision	fetchLayoutRevision(long layoutSetBranchId, long layoutBranchId, boolean head, long plid)
static ActionableDynamicQuery	getActionableDynamicQuery()
static List<LayoutRevision>	getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevisionId, long plid)
static List<LayoutRevision>	getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevision, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
static int	getChildLayoutRevisionsCount(long layoutSetBranchId, long parentLayoutRevision, long plid)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static LayoutRevision	getLayoutRevision(long layoutRevisionId) Returns the layout revision with the primary key.
static LayoutRevision	getLayoutRevision(long layoutSetBranchId, long plid, boolean head) Deprecated. As of Judson (7.1.x), with no direct replacement
static LayoutRevision	getLayoutRevision(long layoutSetBranchId, long layoutBranchId, long plid)
static List<LayoutRevision>	getLayoutRevisions(int start, int end) Returns a range of all the layout revisions.
static List<LayoutRevision>	getLayoutRevisions(long plid)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, boolean head)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, boolean head, int status)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, int status)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, long plid)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, long plid, boolean head)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, long plid, int status)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
static List<LayoutRevision>	getLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
static int	getLayoutRevisionsCount() Returns the number of layout revisions.
static int	getLayoutRevisionsCount(long layoutSetBranchId, long layoutBranchId, long plid)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static LayoutRevisionLocalService	getService()
static LayoutRevision	updateLayoutRevision(LayoutRevision layoutRevision) Updates the layout revision in the database or adds it if it does not yet exist.
static LayoutRevision	updateLayoutRevision(long userId, long layoutRevisionId, long layoutBranchId, String name, String title, String description, String keywords, String robots, String typeSettings, boolean iconImage, long iconImageId, String themeId, String colorSchemeId, String css, ServiceContext serviceContext)
static LayoutRevision	updateStatus(long userId, long layoutRevisionId, int status, ServiceContext serviceContext)

Methods inherited from class Object

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

Constructor Detail

LayoutRevisionLocalServiceUtil

public LayoutRevisionLocalServiceUtil()

Method Detail

addLayoutRevision

public static LayoutRevision addLayoutRevision(LayoutRevision layoutRevision)

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

Parameters:

layoutRevision - the layout revision

Returns:

the layout revision that was added

addLayoutRevision

public static LayoutRevision addLayoutRevision(long userId,
                                               long layoutSetBranchId,
                                               long layoutBranchId,
                                               long parentLayoutRevisionId,
                                               boolean head,
                                               long plid,
                                               long portletPreferencesPlid,
                                               boolean privateLayout,
                                               String name,
                                               String title,
                                               String description,
                                               String keywords,
                                               String robots,
                                               String typeSettings,
                                               boolean iconImage,
                                               long iconImageId,
                                               String themeId,
                                               String colorSchemeId,
                                               String css,
                                               ServiceContext serviceContext)
                                        throws PortalException

Throws:

PortalException

createLayoutRevision

public static LayoutRevision createLayoutRevision(long layoutRevisionId)

Creates a new layout revision with the primary key. Does not add the layout revision to the database.

Parameters:

layoutRevisionId - the primary key for the new layout revision

Returns:

the new layout revision

deleteLayoutLayoutRevisions

public static void deleteLayoutLayoutRevisions(long plid)
                                        throws PortalException

Throws:

PortalException

deleteLayoutRevision

public static LayoutRevision deleteLayoutRevision(LayoutRevision layoutRevision)
                                           throws PortalException

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

Parameters:

layoutRevision - the layout revision

Returns:

the layout revision that was removed

Throws:

PortalException

deleteLayoutRevision

public static LayoutRevision deleteLayoutRevision(long layoutRevisionId)
                                           throws PortalException

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

Parameters:

layoutRevisionId - the primary key of the layout revision

Returns:

the layout revision that was removed

Throws:

PortalException - if a layout revision with the primary key could not be found

deleteLayoutRevisions

public static void deleteLayoutRevisions(long layoutSetBranchId,
                                         long plid)
                                  throws PortalException

Throws:

PortalException

deleteLayoutRevisions

public static void deleteLayoutRevisions(long layoutSetBranchId,
                                         long layoutBranchId,
                                         long plid)
                                  throws PortalException

Throws:

PortalException

deleteLayoutSetBranchLayoutRevisions

public static void deleteLayoutSetBranchLayoutRevisions(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 LayoutRevisionModelImpl. 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 LayoutRevisionModelImpl. 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

fetchLastLayoutRevision

public static LayoutRevision fetchLastLayoutRevision(long plid,
                                                     boolean head)

fetchLatestLayoutRevision

public static LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId,
                                                       long plid)

fetchLayoutRevision

public static LayoutRevision fetchLayoutRevision(long layoutRevisionId)

fetchLayoutRevision

@Deprecated
public static LayoutRevision fetchLayoutRevision(long layoutSetBranchId,
                                                             boolean head,
                                                             long plid)

Deprecated. As of Judson (7.1.x), with no direct replacement

fetchLayoutRevision

public static LayoutRevision fetchLayoutRevision(long layoutSetBranchId,
                                                 long layoutBranchId,
                                                 boolean head,
                                                 long plid)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getChildLayoutRevisions

public static List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId,
                                                           long parentLayoutRevisionId,
                                                           long plid)

getChildLayoutRevisions

public static List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId,
                                                           long parentLayoutRevision,
                                                           long plid,
                                                           int start,
                                                           int end,
                                                           OrderByComparator<LayoutRevision> orderByComparator)

getChildLayoutRevisionsCount

public static int getChildLayoutRevisionsCount(long layoutSetBranchId,
                                               long parentLayoutRevision,
                                               long plid)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutRevision

public static LayoutRevision getLayoutRevision(long layoutRevisionId)
                                        throws PortalException

Returns the layout revision with the primary key.

Parameters:

layoutRevisionId - the primary key of the layout revision

Returns:

the layout revision

Throws:

PortalException - if a layout revision with the primary key could not be found

getLayoutRevision

@Deprecated
public static LayoutRevision getLayoutRevision(long layoutSetBranchId,
                                                           long plid,
                                                           boolean head)
                                                    throws PortalException

Deprecated. As of Judson (7.1.x), with no direct replacement

Throws:

PortalException

getLayoutRevision

public static LayoutRevision getLayoutRevision(long layoutSetBranchId,
                                               long layoutBranchId,
                                               long plid)
                                        throws PortalException

Throws:

PortalException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(int start,
                                                      int end)

Returns a range of all the layout revisions.

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 LayoutRevisionModelImpl. 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 revisions

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

Returns:

the range of layout revisions

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long plid)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      boolean head)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      boolean head,
                                                      int status)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      int status)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long plid)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long plid,
                                                      boolean head)

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long plid,
                                                      int status)

getLayoutRevisions

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

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long layoutBranchId,
                                                      long plid,
                                                      int start,
                                                      int end,
                                                      OrderByComparator<LayoutRevision> orderByComparator)

getLayoutRevisionsCount

public static int getLayoutRevisionsCount()

Returns the number of layout revisions.

Returns:

the number of layout revisions

getLayoutRevisionsCount

public static int getLayoutRevisionsCount(long layoutSetBranchId,
                                          long layoutBranchId,
                                          long plid)

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

updateLayoutRevision

public static LayoutRevision updateLayoutRevision(LayoutRevision layoutRevision)

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

Parameters:

layoutRevision - the layout revision

Returns:

the layout revision that was updated

updateLayoutRevision

public static LayoutRevision updateLayoutRevision(long userId,
                                                  long layoutRevisionId,
                                                  long layoutBranchId,
                                                  String name,
                                                  String title,
                                                  String description,
                                                  String keywords,
                                                  String robots,
                                                  String typeSettings,
                                                  boolean iconImage,
                                                  long iconImageId,
                                                  String themeId,
                                                  String colorSchemeId,
                                                  String css,
                                                  ServiceContext serviceContext)
                                           throws PortalException

Throws:

PortalException

updateStatus

public static LayoutRevision updateStatus(long userId,
                                          long layoutRevisionId,
                                          int status,
                                          ServiceContext serviceContext)
                                   throws PortalException

Throws:

PortalException

getService

public static LayoutRevisionLocalService getService()