1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service.persistence;
24  
25  /**
26   * <a href="LayoutPersistence.java.html"><b><i>View Source</i></b></a>
27   *
28   * @author Brian Wing Shun Chan
29   *
30   */
31  public interface LayoutPersistence extends BasePersistence {
32      public void cacheResult(com.liferay.portal.model.Layout layout);
33  
34      public void cacheResult(
35          java.util.List<com.liferay.portal.model.Layout> layouts);
36  
37      public void clearCache();
38  
39      public com.liferay.portal.model.Layout create(long plid);
40  
41      public com.liferay.portal.model.Layout remove(long plid)
42          throws com.liferay.portal.NoSuchLayoutException,
43              com.liferay.portal.SystemException;
44  
45      public com.liferay.portal.model.Layout remove(
46          com.liferay.portal.model.Layout layout)
47          throws com.liferay.portal.SystemException;
48  
49      /**
50       * @deprecated Use <code>update(Layout layout, boolean merge)</code>.
51       */
52      public com.liferay.portal.model.Layout update(
53          com.liferay.portal.model.Layout layout)
54          throws com.liferay.portal.SystemException;
55  
56      /**
57       * Add, update, or merge, the entity. This method also calls the model
58       * listeners to trigger the proper events associated with adding, deleting,
59       * or updating an entity.
60       *
61       * @param        layout the entity to add, update, or merge
62       * @param        merge boolean value for whether to merge the entity. The
63       *                default value is false. Setting merge to true is more
64       *                expensive and should only be true when layout is
65       *                transient. See LEP-5473 for a detailed discussion of this
66       *                method.
67       * @return        true if the portlet can be displayed via Ajax
68       */
69      public com.liferay.portal.model.Layout update(
70          com.liferay.portal.model.Layout layout, boolean merge)
71          throws com.liferay.portal.SystemException;
72  
73      public com.liferay.portal.model.Layout updateImpl(
74          com.liferay.portal.model.Layout layout, boolean merge)
75          throws com.liferay.portal.SystemException;
76  
77      public com.liferay.portal.model.Layout findByPrimaryKey(long plid)
78          throws com.liferay.portal.NoSuchLayoutException,
79              com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.Layout fetchByPrimaryKey(long plid)
82          throws com.liferay.portal.SystemException;
83  
84      public java.util.List<com.liferay.portal.model.Layout> findByGroupId(
85          long groupId) throws com.liferay.portal.SystemException;
86  
87      public java.util.List<com.liferay.portal.model.Layout> findByGroupId(
88          long groupId, int start, int end)
89          throws com.liferay.portal.SystemException;
90  
91      public java.util.List<com.liferay.portal.model.Layout> findByGroupId(
92          long groupId, int start, int end,
93          com.liferay.portal.kernel.util.OrderByComparator obc)
94          throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Layout findByGroupId_First(long groupId,
97          com.liferay.portal.kernel.util.OrderByComparator obc)
98          throws com.liferay.portal.NoSuchLayoutException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portal.model.Layout findByGroupId_Last(long groupId,
102         com.liferay.portal.kernel.util.OrderByComparator obc)
103         throws com.liferay.portal.NoSuchLayoutException,
104             com.liferay.portal.SystemException;
105 
106     public com.liferay.portal.model.Layout[] findByGroupId_PrevAndNext(
107         long plid, long groupId,
108         com.liferay.portal.kernel.util.OrderByComparator obc)
109         throws com.liferay.portal.NoSuchLayoutException,
110             com.liferay.portal.SystemException;
111 
112     public java.util.List<com.liferay.portal.model.Layout> findByCompanyId(
113         long companyId) throws com.liferay.portal.SystemException;
114 
115     public java.util.List<com.liferay.portal.model.Layout> findByCompanyId(
116         long companyId, int start, int end)
117         throws com.liferay.portal.SystemException;
118 
119     public java.util.List<com.liferay.portal.model.Layout> findByCompanyId(
120         long companyId, int start, int end,
121         com.liferay.portal.kernel.util.OrderByComparator obc)
122         throws com.liferay.portal.SystemException;
123 
124     public com.liferay.portal.model.Layout findByCompanyId_First(
125         long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
126         throws com.liferay.portal.NoSuchLayoutException,
127             com.liferay.portal.SystemException;
128 
129     public com.liferay.portal.model.Layout findByCompanyId_Last(
130         long companyId, com.liferay.portal.kernel.util.OrderByComparator obc)
131         throws com.liferay.portal.NoSuchLayoutException,
132             com.liferay.portal.SystemException;
133 
134     public com.liferay.portal.model.Layout[] findByCompanyId_PrevAndNext(
135         long plid, long companyId,
136         com.liferay.portal.kernel.util.OrderByComparator obc)
137         throws com.liferay.portal.NoSuchLayoutException,
138             com.liferay.portal.SystemException;
139 
140     public com.liferay.portal.model.Layout findByDLFolderId(long dlFolderId)
141         throws com.liferay.portal.NoSuchLayoutException,
142             com.liferay.portal.SystemException;
143 
144     public com.liferay.portal.model.Layout fetchByDLFolderId(long dlFolderId)
145         throws com.liferay.portal.SystemException;
146 
147     public com.liferay.portal.model.Layout fetchByDLFolderId(long dlFolderId,
148         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
149 
150     public com.liferay.portal.model.Layout findByIconImageId(long iconImageId)
151         throws com.liferay.portal.NoSuchLayoutException,
152             com.liferay.portal.SystemException;
153 
154     public com.liferay.portal.model.Layout fetchByIconImageId(long iconImageId)
155         throws com.liferay.portal.SystemException;
156 
157     public com.liferay.portal.model.Layout fetchByIconImageId(
158         long iconImageId, boolean retrieveFromCache)
159         throws com.liferay.portal.SystemException;
160 
161     public java.util.List<com.liferay.portal.model.Layout> findByG_P(
162         long groupId, boolean privateLayout)
163         throws com.liferay.portal.SystemException;
164 
165     public java.util.List<com.liferay.portal.model.Layout> findByG_P(
166         long groupId, boolean privateLayout, int start, int end)
167         throws com.liferay.portal.SystemException;
168 
169     public java.util.List<com.liferay.portal.model.Layout> findByG_P(
170         long groupId, boolean privateLayout, int start, int end,
171         com.liferay.portal.kernel.util.OrderByComparator obc)
172         throws com.liferay.portal.SystemException;
173 
174     public com.liferay.portal.model.Layout findByG_P_First(long groupId,
175         boolean privateLayout,
176         com.liferay.portal.kernel.util.OrderByComparator obc)
177         throws com.liferay.portal.NoSuchLayoutException,
178             com.liferay.portal.SystemException;
179 
180     public com.liferay.portal.model.Layout findByG_P_Last(long groupId,
181         boolean privateLayout,
182         com.liferay.portal.kernel.util.OrderByComparator obc)
183         throws com.liferay.portal.NoSuchLayoutException,
184             com.liferay.portal.SystemException;
185 
186     public com.liferay.portal.model.Layout[] findByG_P_PrevAndNext(long plid,
187         long groupId, boolean privateLayout,
188         com.liferay.portal.kernel.util.OrderByComparator obc)
189         throws com.liferay.portal.NoSuchLayoutException,
190             com.liferay.portal.SystemException;
191 
192     public com.liferay.portal.model.Layout findByG_P_L(long groupId,
193         boolean privateLayout, long layoutId)
194         throws com.liferay.portal.NoSuchLayoutException,
195             com.liferay.portal.SystemException;
196 
197     public com.liferay.portal.model.Layout fetchByG_P_L(long groupId,
198         boolean privateLayout, long layoutId)
199         throws com.liferay.portal.SystemException;
200 
201     public com.liferay.portal.model.Layout fetchByG_P_L(long groupId,
202         boolean privateLayout, long layoutId, boolean retrieveFromCache)
203         throws com.liferay.portal.SystemException;
204 
205     public java.util.List<com.liferay.portal.model.Layout> findByG_P_P(
206         long groupId, boolean privateLayout, long parentLayoutId)
207         throws com.liferay.portal.SystemException;
208 
209     public java.util.List<com.liferay.portal.model.Layout> findByG_P_P(
210         long groupId, boolean privateLayout, long parentLayoutId, int start,
211         int end) throws com.liferay.portal.SystemException;
212 
213     public java.util.List<com.liferay.portal.model.Layout> findByG_P_P(
214         long groupId, boolean privateLayout, long parentLayoutId, int start,
215         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
216         throws com.liferay.portal.SystemException;
217 
218     public com.liferay.portal.model.Layout findByG_P_P_First(long groupId,
219         boolean privateLayout, long parentLayoutId,
220         com.liferay.portal.kernel.util.OrderByComparator obc)
221         throws com.liferay.portal.NoSuchLayoutException,
222             com.liferay.portal.SystemException;
223 
224     public com.liferay.portal.model.Layout findByG_P_P_Last(long groupId,
225         boolean privateLayout, long parentLayoutId,
226         com.liferay.portal.kernel.util.OrderByComparator obc)
227         throws com.liferay.portal.NoSuchLayoutException,
228             com.liferay.portal.SystemException;
229 
230     public com.liferay.portal.model.Layout[] findByG_P_P_PrevAndNext(
231         long plid, long groupId, boolean privateLayout, long parentLayoutId,
232         com.liferay.portal.kernel.util.OrderByComparator obc)
233         throws com.liferay.portal.NoSuchLayoutException,
234             com.liferay.portal.SystemException;
235 
236     public com.liferay.portal.model.Layout findByG_P_F(long groupId,
237         boolean privateLayout, java.lang.String friendlyURL)
238         throws com.liferay.portal.NoSuchLayoutException,
239             com.liferay.portal.SystemException;
240 
241     public com.liferay.portal.model.Layout fetchByG_P_F(long groupId,
242         boolean privateLayout, java.lang.String friendlyURL)
243         throws com.liferay.portal.SystemException;
244 
245     public com.liferay.portal.model.Layout fetchByG_P_F(long groupId,
246         boolean privateLayout, java.lang.String friendlyURL,
247         boolean retrieveFromCache) throws com.liferay.portal.SystemException;
248 
249     public java.util.List<com.liferay.portal.model.Layout> findByG_P_T(
250         long groupId, boolean privateLayout, java.lang.String type)
251         throws com.liferay.portal.SystemException;
252 
253     public java.util.List<com.liferay.portal.model.Layout> findByG_P_T(
254         long groupId, boolean privateLayout, java.lang.String type, int start,
255         int end) throws com.liferay.portal.SystemException;
256 
257     public java.util.List<com.liferay.portal.model.Layout> findByG_P_T(
258         long groupId, boolean privateLayout, java.lang.String type, int start,
259         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
260         throws com.liferay.portal.SystemException;
261 
262     public com.liferay.portal.model.Layout findByG_P_T_First(long groupId,
263         boolean privateLayout, java.lang.String type,
264         com.liferay.portal.kernel.util.OrderByComparator obc)
265         throws com.liferay.portal.NoSuchLayoutException,
266             com.liferay.portal.SystemException;
267 
268     public com.liferay.portal.model.Layout findByG_P_T_Last(long groupId,
269         boolean privateLayout, java.lang.String type,
270         com.liferay.portal.kernel.util.OrderByComparator obc)
271         throws com.liferay.portal.NoSuchLayoutException,
272             com.liferay.portal.SystemException;
273 
274     public com.liferay.portal.model.Layout[] findByG_P_T_PrevAndNext(
275         long plid, long groupId, boolean privateLayout, java.lang.String type,
276         com.liferay.portal.kernel.util.OrderByComparator obc)
277         throws com.liferay.portal.NoSuchLayoutException,
278             com.liferay.portal.SystemException;
279 
280     public java.util.List<Object> findWithDynamicQuery(
281         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
282         throws com.liferay.portal.SystemException;
283 
284     public java.util.List<Object> findWithDynamicQuery(
285         com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
286         int end) throws com.liferay.portal.SystemException;
287 
288     public java.util.List<com.liferay.portal.model.Layout> findAll()
289         throws com.liferay.portal.SystemException;
290 
291     public java.util.List<com.liferay.portal.model.Layout> findAll(int start,
292         int end) throws com.liferay.portal.SystemException;
293 
294     public java.util.List<com.liferay.portal.model.Layout> findAll(int start,
295         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
296         throws com.liferay.portal.SystemException;
297 
298     public void removeByGroupId(long groupId)
299         throws com.liferay.portal.SystemException;
300 
301     public void removeByCompanyId(long companyId)
302         throws com.liferay.portal.SystemException;
303 
304     public void removeByDLFolderId(long dlFolderId)
305         throws com.liferay.portal.NoSuchLayoutException,
306             com.liferay.portal.SystemException;
307 
308     public void removeByIconImageId(long iconImageId)
309         throws com.liferay.portal.NoSuchLayoutException,
310             com.liferay.portal.SystemException;
311 
312     public void removeByG_P(long groupId, boolean privateLayout)
313         throws com.liferay.portal.SystemException;
314 
315     public void removeByG_P_L(long groupId, boolean privateLayout, long layoutId)
316         throws com.liferay.portal.NoSuchLayoutException,
317             com.liferay.portal.SystemException;
318 
319     public void removeByG_P_P(long groupId, boolean privateLayout,
320         long parentLayoutId) throws com.liferay.portal.SystemException;
321 
322     public void removeByG_P_F(long groupId, boolean privateLayout,
323         java.lang.String friendlyURL)
324         throws com.liferay.portal.NoSuchLayoutException,
325             com.liferay.portal.SystemException;
326 
327     public void removeByG_P_T(long groupId, boolean privateLayout,
328         java.lang.String type) throws com.liferay.portal.SystemException;
329 
330     public void removeAll() throws com.liferay.portal.SystemException;
331 
332     public int countByGroupId(long groupId)
333         throws com.liferay.portal.SystemException;
334 
335     public int countByCompanyId(long companyId)
336         throws com.liferay.portal.SystemException;
337 
338     public int countByDLFolderId(long dlFolderId)
339         throws com.liferay.portal.SystemException;
340 
341     public int countByIconImageId(long iconImageId)
342         throws com.liferay.portal.SystemException;
343 
344     public int countByG_P(long groupId, boolean privateLayout)
345         throws com.liferay.portal.SystemException;
346 
347     public int countByG_P_L(long groupId, boolean privateLayout, long layoutId)
348         throws com.liferay.portal.SystemException;
349 
350     public int countByG_P_P(long groupId, boolean privateLayout,
351         long parentLayoutId) throws com.liferay.portal.SystemException;
352 
353     public int countByG_P_F(long groupId, boolean privateLayout,
354         java.lang.String friendlyURL) throws com.liferay.portal.SystemException;
355 
356     public int countByG_P_T(long groupId, boolean privateLayout,
357         java.lang.String type) throws com.liferay.portal.SystemException;
358 
359     public int countAll() throws com.liferay.portal.SystemException;
360 }