Liferay 6.2-ce-ga5

com.liferay.portal.service
Class LayoutRevisionLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.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.

See Also:
LayoutRevisionLocalService, LayoutRevisionLocalServiceBaseImpl, LayoutRevisionLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
LayoutRevisionLocalServiceUtil()
           
 
Method Summary
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 wapThemeId, String wapColorSchemeId, 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 DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match 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)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 orderByComparator)
           
static int getChildLayoutRevisionsCount(long layoutSetBranchId, long parentLayoutRevision, long plid)
           
static LayoutRevision getLayoutRevision(long layoutRevisionId)
          Returns the layout revision with the primary key.
static LayoutRevision getLayoutRevision(long layoutSetBranchId, long plid, boolean head)
           
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, int status)
           
static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid)
           
static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int status)
           
static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int start, int end, OrderByComparator orderByComparator)
           
static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid, int start, int end, OrderByComparator orderByComparator)
           
static int getLayoutRevisionsCount()
          Returns the number of layout revisions.
static int getLayoutRevisionsCount(long layoutSetBranchId, long layoutBranchId, long plid)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static LayoutRevisionLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(LayoutRevisionLocalService service)
          Deprecated. As of 6.2.0
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 wapThemeId, String wapColorSchemeId, String css, ServiceContext serviceContext)
           
static LayoutRevision updateStatus(long userId, long layoutRevisionId, int status, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.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)
                                        throws SystemException
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
Throws:
SystemException - if a system exception occurred

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

deleteLayoutRevision

public static LayoutRevision deleteLayoutRevision(long layoutRevisionId)
                                           throws PortalException,
                                                  SystemException
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
SystemException - if a system exception occurred

deleteLayoutRevision

public static LayoutRevision deleteLayoutRevision(LayoutRevision layoutRevision)
                                           throws PortalException,
                                                  SystemException
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
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchLayoutRevision

public static LayoutRevision fetchLayoutRevision(long layoutRevisionId)
                                          throws SystemException
Throws:
SystemException

getLayoutRevision

public static LayoutRevision getLayoutRevision(long layoutRevisionId)
                                        throws PortalException,
                                               SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(int start,
                                                      int end)
                                               throws SystemException
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
Throws:
SystemException - if a system exception occurred

getLayoutRevisionsCount

public static int getLayoutRevisionsCount()
                                   throws SystemException
Returns the number of layout revisions.

Returns:
the number of layout revisions
Throws:
SystemException - if a system exception occurred

updateLayoutRevision

public static LayoutRevision updateLayoutRevision(LayoutRevision layoutRevision)
                                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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 wapThemeId,
                                               String wapColorSchemeId,
                                               String css,
                                               ServiceContext serviceContext)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

deleteLayoutLayoutRevisions

public static void deleteLayoutLayoutRevisions(long plid)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

deleteLayoutRevisions

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

deleteLayoutRevisions

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

deleteLayoutSetBranchLayoutRevisions

public static void deleteLayoutSetBranchLayoutRevisions(long layoutSetBranchId)
                                                 throws PortalException,
                                                        SystemException
Throws:
PortalException
SystemException

fetchLastLayoutRevision

public static LayoutRevision fetchLastLayoutRevision(long plid,
                                                     boolean head)
                                              throws SystemException
Throws:
SystemException

fetchLatestLayoutRevision

public static LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId,
                                                       long plid)
                                                throws SystemException
Throws:
SystemException

fetchLayoutRevision

public static LayoutRevision fetchLayoutRevision(long layoutSetBranchId,
                                                 boolean head,
                                                 long plid)
                                          throws SystemException
Throws:
SystemException

getChildLayoutRevisions

public static List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId,
                                                           long parentLayoutRevisionId,
                                                           long plid)
                                                    throws SystemException
Throws:
SystemException

getChildLayoutRevisions

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

getChildLayoutRevisionsCount

public static int getChildLayoutRevisionsCount(long layoutSetBranchId,
                                               long parentLayoutRevision,
                                               long plid)
                                        throws SystemException
Throws:
SystemException

getLayoutRevision

public static LayoutRevision getLayoutRevision(long layoutSetBranchId,
                                               long plid,
                                               boolean head)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getLayoutRevision

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

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long plid)
                                               throws SystemException
Throws:
SystemException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      boolean head)
                                               throws SystemException
Throws:
SystemException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      int status)
                                               throws SystemException
Throws:
SystemException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long plid)
                                               throws SystemException
Throws:
SystemException

getLayoutRevisions

public static List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                      long plid,
                                                      int status)
                                               throws SystemException
Throws:
SystemException

getLayoutRevisions

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

getLayoutRevisions

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

getLayoutRevisionsCount

public static int getLayoutRevisionsCount(long layoutSetBranchId,
                                          long layoutBranchId,
                                          long plid)
                                   throws SystemException
Throws:
SystemException

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 wapThemeId,
                                                  String wapColorSchemeId,
                                                  String css,
                                                  ServiceContext serviceContext)
                                           throws PortalException,
                                                  SystemException
Throws:
PortalException
SystemException

updateStatus

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

getService

public static LayoutRevisionLocalService getService()

setService

public void setService(LayoutRevisionLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5