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