001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * The interface for the layout revision local service.
025     *
026     * <p>
027     * This is a local service. 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see LayoutRevisionLocalServiceUtil
032     * @see com.liferay.portal.service.base.LayoutRevisionLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface LayoutRevisionLocalService extends PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * Never modify or reference this interface directly. Always use {@link LayoutRevisionLocalServiceUtil} to access the layout revision local service. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
043             */
044    
045            /**
046            * Adds the layout revision to the database. Also notifies the appropriate model listeners.
047            *
048            * @param layoutRevision the layout revision
049            * @return the layout revision that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.LayoutRevision addLayoutRevision(
053                    com.liferay.portal.model.LayoutRevision layoutRevision)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new layout revision with the primary key. Does not add the layout revision to the database.
058            *
059            * @param layoutRevisionId the primary key for the new layout revision
060            * @return the new layout revision
061            */
062            public com.liferay.portal.model.LayoutRevision createLayoutRevision(
063                    long layoutRevisionId);
064    
065            /**
066            * Deletes the layout revision with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutRevisionId the primary key of the layout revision
069            * @throws PortalException if a layout revision with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public void deleteLayoutRevision(long layoutRevisionId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            /**
077            * Deletes the layout revision from the database. Also notifies the appropriate model listeners.
078            *
079            * @param layoutRevision the layout revision
080            * @throws PortalException
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteLayoutRevision(
084                    com.liferay.portal.model.LayoutRevision layoutRevision)
085                    throws com.liferay.portal.kernel.exception.PortalException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            /**
089            * Performs a dynamic query on the database and returns the matching rows.
090            *
091            * @param dynamicQuery the dynamic query
092            * @return the matching rows
093            * @throws SystemException if a system exception occurred
094            */
095            @SuppressWarnings("rawtypes")
096            public java.util.List dynamicQuery(
097                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
098                    throws com.liferay.portal.kernel.exception.SystemException;
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query
108            * @param start the lower bound of the range of model instances
109            * @param end the upper bound of the range of model instances (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException;
117    
118            /**
119            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
120            *
121            * <p>
122            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
129            * @return the ordered range of matching rows
130            * @throws SystemException if a system exception occurred
131            */
132            @SuppressWarnings("rawtypes")
133            public java.util.List dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end,
136                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
137                    throws com.liferay.portal.kernel.exception.SystemException;
138    
139            /**
140            * Returns the number of rows that match the dynamic query.
141            *
142            * @param dynamicQuery the dynamic query
143            * @return the number of rows that match the dynamic query
144            * @throws SystemException if a system exception occurred
145            */
146            public long dynamicQueryCount(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
148                    throws com.liferay.portal.kernel.exception.SystemException;
149    
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public com.liferay.portal.model.LayoutRevision fetchLayoutRevision(
152                    long layoutRevisionId)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the layout revision with the primary key.
157            *
158            * @param layoutRevisionId the primary key of the layout revision
159            * @return the layout revision
160            * @throws PortalException if a layout revision with the primary key could not be found
161            * @throws SystemException if a system exception occurred
162            */
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.LayoutRevision getLayoutRevision(
165                    long layoutRevisionId)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.PersistedModel getPersistedModel(
171                    java.io.Serializable primaryKeyObj)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns a range of all the layout revisions.
177            *
178            * <p>
179            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
180            * </p>
181            *
182            * @param start the lower bound of the range of layout revisions
183            * @param end the upper bound of the range of layout revisions (not inclusive)
184            * @return the range of layout revisions
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Returns the number of layout revisions.
194            *
195            * @return the number of layout revisions
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getLayoutRevisionsCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
204            *
205            * @param layoutRevision the layout revision
206            * @return the layout revision that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portal.model.LayoutRevision updateLayoutRevision(
210                    com.liferay.portal.model.LayoutRevision layoutRevision)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
215            *
216            * @param layoutRevision the layout revision
217            * @param merge whether to merge the layout revision with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
218            * @return the layout revision that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portal.model.LayoutRevision updateLayoutRevision(
222                    com.liferay.portal.model.LayoutRevision layoutRevision, boolean merge)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            public com.liferay.portal.model.LayoutRevision addLayoutRevision(
240                    long userId, long layoutSetBranchId, long layoutBranchId,
241                    long parentLayoutRevisionId, boolean head, long plid,
242                    long portletPreferencesPlid, boolean privateLayout,
243                    java.lang.String name, java.lang.String title,
244                    java.lang.String description, java.lang.String keywords,
245                    java.lang.String robots, java.lang.String typeSettings,
246                    boolean iconImage, long iconImageId, java.lang.String themeId,
247                    java.lang.String colorSchemeId, java.lang.String wapThemeId,
248                    java.lang.String wapColorSchemeId, java.lang.String css,
249                    com.liferay.portal.service.ServiceContext serviceContext)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public void deleteLayoutLayoutRevisions(long plid)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            public void deleteLayoutRevisions(long layoutSetBranchId, long plid)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deleteLayoutRevisions(long layoutSetBranchId,
262                    long layoutBranchId, long plid)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void deleteLayoutSetBranchLayoutRevisions(long layoutSetBranchId)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public com.liferay.portal.model.LayoutRevision fetchLastLayoutRevision(
272                    long plid, boolean head)
273                    throws com.liferay.portal.kernel.exception.SystemException;
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public java.util.List<com.liferay.portal.model.LayoutRevision> getChildLayoutRevisions(
277                    long layoutSetBranchId, long parentLayoutRevisionId, long plid)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portal.model.LayoutRevision> getChildLayoutRevisions(
282                    long layoutSetBranchId, long parentLayoutRevision, long plid,
283                    int start, int end,
284                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
288            public int getChildLayoutRevisionsCount(long layoutSetBranchId,
289                    long parentLayoutRevision, long plid)
290                    throws com.liferay.portal.kernel.exception.SystemException;
291    
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public com.liferay.portal.model.LayoutRevision getLayoutRevision(
294                    long layoutSetBranchId, long plid, boolean head)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public com.liferay.portal.model.LayoutRevision getLayoutRevision(
300                    long layoutSetBranchId, long layoutBranchId, long plid)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
306                    long plid) throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
310                    long layoutSetBranchId, boolean head)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
315                    long layoutSetBranchId, int status)
316                    throws com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
320                    long layoutSetBranchId, long plid)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
325                    long layoutSetBranchId, long plid, int status)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
330                    long layoutSetBranchId, long layoutBranchId, long plid, int start,
331                    int end,
332                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public int getLayoutRevisionsCount(long layoutSetBranchId,
337                    long layoutBranchId, long plid)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            public com.liferay.portal.model.LayoutRevision updateLayoutRevision(
341                    long userId, long layoutRevisionId, long layoutBranchId,
342                    java.lang.String name, java.lang.String title,
343                    java.lang.String description, java.lang.String keywords,
344                    java.lang.String robots, java.lang.String typeSettings,
345                    boolean iconImage, long iconImageId, java.lang.String themeId,
346                    java.lang.String colorSchemeId, java.lang.String wapThemeId,
347                    java.lang.String wapColorSchemeId, java.lang.String css,
348                    com.liferay.portal.service.ServiceContext serviceContext)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException;
351    
352            public com.liferay.portal.model.LayoutRevision updateStatus(long userId,
353                    long layoutRevisionId, int status,
354                    com.liferay.portal.service.ServiceContext serviceContext)
355                    throws com.liferay.portal.kernel.exception.PortalException,
356                            com.liferay.portal.kernel.exception.SystemException;
357    }