Liferay 7.0-ce-b4

com.liferay.portal.service
Interface LayoutRevisionLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
LayoutRevisionLocalServiceBaseImpl, LayoutRevisionLocalServiceImpl, LayoutRevisionLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface LayoutRevisionLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for LayoutRevision. 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:
LayoutRevisionLocalServiceUtil, LayoutRevisionLocalServiceBaseImpl, LayoutRevisionLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 LayoutRevision addLayoutRevision(LayoutRevision layoutRevision)
          Adds the layout revision to the database.
 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)
           
 LayoutRevision createLayoutRevision(long layoutRevisionId)
          Creates a new layout revision with the primary key.
 void deleteLayoutLayoutRevisions(long plid)
           
 LayoutRevision deleteLayoutRevision(LayoutRevision layoutRevision)
          Deletes the layout revision from the database.
 LayoutRevision deleteLayoutRevision(long layoutRevisionId)
          Deletes the layout revision with the primary key from the database.
 void deleteLayoutRevisions(long layoutSetBranchId, long plid)
           
 void deleteLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid)
           
 void deleteLayoutSetBranchLayoutRevisions(long layoutSetBranchId)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 LayoutRevision fetchLastLayoutRevision(long plid, boolean head)
           
 LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId, long plid)
           
 LayoutRevision fetchLayoutRevision(long layoutRevisionId)
           
 LayoutRevision fetchLayoutRevision(long layoutSetBranchId, boolean head, long plid)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevisionId, long plid)
           
 List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId, long parentLayoutRevision, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
           
 int getChildLayoutRevisionsCount(long layoutSetBranchId, long parentLayoutRevision, long plid)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 LayoutRevision getLayoutRevision(long layoutRevisionId)
          Returns the layout revision with the primary key.
 LayoutRevision getLayoutRevision(long layoutSetBranchId, long plid, boolean head)
           
 LayoutRevision getLayoutRevision(long layoutSetBranchId, long layoutBranchId, long plid)
           
 List<LayoutRevision> getLayoutRevisions(int start, int end)
          Returns a range of all the layout revisions.
 List<LayoutRevision> getLayoutRevisions(long plid)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, boolean head)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, int status)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int status)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
           
 List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId, long layoutBranchId, long plid, int start, int end, OrderByComparator<LayoutRevision> orderByComparator)
           
 int getLayoutRevisionsCount()
          Returns the number of layout revisions.
 int getLayoutRevisionsCount(long layoutSetBranchId, long layoutBranchId, long plid)
           
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 LayoutRevision updateLayoutRevision(LayoutRevision layoutRevision)
          Updates the layout revision in the database or adds it if it does not yet exist.
 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)
           
 LayoutRevision updateStatus(long userId, long layoutRevisionId, int status, ServiceContext serviceContext)
           
 

Method Detail

addLayoutRevision

@Indexable(type=REINDEX)
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

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
Throws:
PortalException

createLayoutRevision

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

void deleteLayoutLayoutRevisions(long plid)
                                 throws PortalException
Throws:
PortalException

deleteLayoutRevision

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

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

deleteLayoutRevisions

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

deleteLayoutSetBranchLayoutRevisions

void deleteLayoutSetBranchLayoutRevisions(long layoutSetBranchId)
                                          throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision fetchLastLayoutRevision(long plid,
                                                                                boolean head)

fetchLatestLayoutRevision

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId,
                                                                                  long plid)

fetchLayoutRevision

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision fetchLayoutRevision(long layoutRevisionId)

fetchLayoutRevision

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision fetchLayoutRevision(long layoutSetBranchId,
                                                                            boolean head,
                                                                            long plid)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getChildLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId,
                                                                                      long parentLayoutRevision,
                                                                                      long plid,
                                                                                      int start,
                                                                                      int end,
                                                                                      OrderByComparator<LayoutRevision> orderByComparator)

getChildLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getChildLayoutRevisions(long layoutSetBranchId,
                                                                                      long parentLayoutRevisionId,
                                                                                      long plid)

getChildLayoutRevisionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getChildLayoutRevisionsCount(long layoutSetBranchId,
                                                                          long parentLayoutRevision,
                                                                          long plid)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLayoutRevision

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision getLayoutRevision(long layoutSetBranchId,
                                                                          long layoutBranchId,
                                                                          long plid)
                                 throws PortalException
Throws:
PortalException

getLayoutRevision

@Transactional(propagation=SUPPORTS,
               readOnly=true)
LayoutRevision getLayoutRevision(long layoutSetBranchId,
                                                                          long plid,
                                                                          boolean head)
                                 throws PortalException
Throws:
PortalException

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 boolean head)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 long layoutBranchId,
                                                                                 long plid,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator<LayoutRevision> orderByComparator)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 long plid)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 long plid,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator<LayoutRevision> orderByComparator)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 long plid,
                                                                                 int status)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
                                                                                 int status)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<LayoutRevision> getLayoutRevisions(long plid)

getLayoutRevisions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getLayoutRevisionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutRevisionsCount()
Returns the number of layout revisions.

Returns:
the number of layout revisions

getLayoutRevisionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLayoutRevisionsCount(long layoutSetBranchId,
                                                                     long layoutBranchId,
                                                                     long plid)

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

updateLayoutRevision

@Indexable(type=REINDEX)
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

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
Throws:
PortalException

updateStatus

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

Liferay 7.0-ce-b4