001    /**
002     * Copyright (c) 2000-present 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.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.LayoutRevision;
026    import com.liferay.portal.kernel.model.PersistedModel;
027    import com.liferay.portal.kernel.search.Indexable;
028    import com.liferay.portal.kernel.search.IndexableType;
029    import com.liferay.portal.kernel.transaction.Isolation;
030    import com.liferay.portal.kernel.transaction.Propagation;
031    import com.liferay.portal.kernel.transaction.Transactional;
032    import com.liferay.portal.kernel.util.OrderByComparator;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for LayoutRevision. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see LayoutRevisionLocalServiceUtil
046     * @see com.liferay.portal.service.base.LayoutRevisionLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface LayoutRevisionLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * 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.
059             */
060    
061            /**
062            * Adds the layout revision to the database. Also notifies the appropriate model listeners.
063            *
064            * @param layoutRevision the layout revision
065            * @return the layout revision that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public LayoutRevision addLayoutRevision(LayoutRevision layoutRevision);
069    
070            public LayoutRevision addLayoutRevision(long userId,
071                    long layoutSetBranchId, long layoutBranchId,
072                    long parentLayoutRevisionId, boolean head, long plid,
073                    long portletPreferencesPlid, boolean privateLayout,
074                    java.lang.String name, java.lang.String title,
075                    java.lang.String description, java.lang.String keywords,
076                    java.lang.String robots, java.lang.String typeSettings,
077                    boolean iconImage, long iconImageId, java.lang.String themeId,
078                    java.lang.String colorSchemeId, java.lang.String css,
079                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
080                    throws PortalException;
081    
082            /**
083            * Creates a new layout revision with the primary key. Does not add the layout revision to the database.
084            *
085            * @param layoutRevisionId the primary key for the new layout revision
086            * @return the new layout revision
087            */
088            public LayoutRevision createLayoutRevision(long layoutRevisionId);
089    
090            public void deleteLayoutLayoutRevisions(long plid)
091                    throws PortalException;
092    
093            /**
094            * Deletes the layout revision from the database. Also notifies the appropriate model listeners.
095            *
096            * @param layoutRevision the layout revision
097            * @return the layout revision that was removed
098            * @throws PortalException
099            */
100            @Indexable(type = IndexableType.DELETE)
101            public LayoutRevision deleteLayoutRevision(LayoutRevision layoutRevision)
102                    throws PortalException;
103    
104            /**
105            * Deletes the layout revision with the primary key from the database. Also notifies the appropriate model listeners.
106            *
107            * @param layoutRevisionId the primary key of the layout revision
108            * @return the layout revision that was removed
109            * @throws PortalException if a layout revision with the primary key could not be found
110            */
111            @Indexable(type = IndexableType.DELETE)
112            public LayoutRevision deleteLayoutRevision(long layoutRevisionId)
113                    throws PortalException;
114    
115            public void deleteLayoutRevisions(long layoutSetBranchId,
116                    long layoutBranchId, long plid) throws PortalException;
117    
118            public void deleteLayoutRevisions(long layoutSetBranchId, long plid)
119                    throws PortalException;
120    
121            public void deleteLayoutSetBranchLayoutRevisions(long layoutSetBranchId)
122                    throws PortalException;
123    
124            /**
125            * @throws PortalException
126            */
127            @Override
128            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
129                    throws PortalException;
130    
131            public DynamicQuery dynamicQuery();
132    
133            /**
134            * Performs a dynamic query on the database and returns the matching rows.
135            *
136            * @param dynamicQuery the dynamic query
137            * @return the matching rows
138            */
139            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
140    
141            /**
142            * Performs a dynamic query on the database and returns a range of the matching rows.
143            *
144            * <p>
145            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutRevisionModelImpl}. If both <code>orderByComparator</code> 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.
146            * </p>
147            *
148            * @param dynamicQuery the dynamic query
149            * @param start the lower bound of the range of model instances
150            * @param end the upper bound of the range of model instances (not inclusive)
151            * @return the range of matching rows
152            */
153            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
154                    int end);
155    
156            /**
157            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
158            *
159            * <p>
160            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutRevisionModelImpl}. If both <code>orderByComparator</code> 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.
161            * </p>
162            *
163            * @param dynamicQuery the dynamic query
164            * @param start the lower bound of the range of model instances
165            * @param end the upper bound of the range of model instances (not inclusive)
166            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
167            * @return the ordered range of matching rows
168            */
169            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
170                    int end, OrderByComparator<T> orderByComparator);
171    
172            /**
173            * Returns the number of rows matching the dynamic query.
174            *
175            * @param dynamicQuery the dynamic query
176            * @return the number of rows matching the dynamic query
177            */
178            public long dynamicQueryCount(DynamicQuery dynamicQuery);
179    
180            /**
181            * Returns the number of rows matching the dynamic query.
182            *
183            * @param dynamicQuery the dynamic query
184            * @param projection the projection to apply to the query
185            * @return the number of rows matching the dynamic query
186            */
187            public long dynamicQueryCount(DynamicQuery dynamicQuery,
188                    Projection projection);
189    
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public LayoutRevision fetchLastLayoutRevision(long plid, boolean head);
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public LayoutRevision fetchLatestLayoutRevision(long layoutSetBranchId,
195                    long plid);
196    
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public LayoutRevision fetchLayoutRevision(long layoutRevisionId);
199    
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public LayoutRevision fetchLayoutRevision(long layoutSetBranchId,
202                    boolean head, long plid);
203    
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public ActionableDynamicQuery getActionableDynamicQuery();
206    
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public List<LayoutRevision> getChildLayoutRevisions(
209                    long layoutSetBranchId, long parentLayoutRevision, long plid,
210                    int start, int end, OrderByComparator<LayoutRevision> orderByComparator);
211    
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public List<LayoutRevision> getChildLayoutRevisions(
214                    long layoutSetBranchId, long parentLayoutRevisionId, long plid);
215    
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public int getChildLayoutRevisionsCount(long layoutSetBranchId,
218                    long parentLayoutRevision, long plid);
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
222    
223            /**
224            * Returns the layout revision with the primary key.
225            *
226            * @param layoutRevisionId the primary key of the layout revision
227            * @return the layout revision
228            * @throws PortalException if a layout revision with the primary key could not be found
229            */
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public LayoutRevision getLayoutRevision(long layoutRevisionId)
232                    throws PortalException;
233    
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public LayoutRevision getLayoutRevision(long layoutSetBranchId,
236                    long layoutBranchId, long plid) throws PortalException;
237    
238            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
239            public LayoutRevision getLayoutRevision(long layoutSetBranchId, long plid,
240                    boolean head) throws PortalException;
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
244                    boolean head);
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
248                    long layoutBranchId, long plid, int start, int end,
249                    OrderByComparator<LayoutRevision> orderByComparator);
250    
251            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
253                    long plid);
254    
255            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
257                    long plid, int start, int end,
258                    OrderByComparator<LayoutRevision> orderByComparator);
259    
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
262                    long plid, int status);
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public List<LayoutRevision> getLayoutRevisions(long layoutSetBranchId,
266                    int status);
267    
268            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269            public List<LayoutRevision> getLayoutRevisions(long plid);
270    
271            /**
272            * Returns a range of all the layout revisions.
273            *
274            * <p>
275            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.LayoutRevisionModelImpl}. If both <code>orderByComparator</code> 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.
276            * </p>
277            *
278            * @param start the lower bound of the range of layout revisions
279            * @param end the upper bound of the range of layout revisions (not inclusive)
280            * @return the range of layout revisions
281            */
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public List<LayoutRevision> getLayoutRevisions(int start, int end);
284    
285            /**
286            * Returns the number of layout revisions.
287            *
288            * @return the number of layout revisions
289            */
290            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
291            public int getLayoutRevisionsCount();
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public int getLayoutRevisionsCount(long layoutSetBranchId,
295                    long layoutBranchId, long plid);
296    
297            /**
298            * Returns the OSGi service identifier.
299            *
300            * @return the OSGi service identifier
301            */
302            public java.lang.String getOSGiServiceIdentifier();
303    
304            @Override
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
307                    throws PortalException;
308    
309            /**
310            * Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
311            *
312            * @param layoutRevision the layout revision
313            * @return the layout revision that was updated
314            */
315            @Indexable(type = IndexableType.REINDEX)
316            public LayoutRevision updateLayoutRevision(LayoutRevision layoutRevision);
317    
318            public LayoutRevision updateLayoutRevision(long userId,
319                    long layoutRevisionId, long layoutBranchId, java.lang.String name,
320                    java.lang.String title, java.lang.String description,
321                    java.lang.String keywords, java.lang.String robots,
322                    java.lang.String typeSettings, boolean iconImage, long iconImageId,
323                    java.lang.String themeId, java.lang.String colorSchemeId,
324                    java.lang.String css,
325                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
326                    throws PortalException;
327    
328            public LayoutRevision updateStatus(long userId, long layoutRevisionId,
329                    int status,
330                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
331                    throws PortalException;
332    }