001    /**
002     * Copyright (c) 2000-2010 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.persistence;
016    
017    import com.liferay.portal.model.LayoutSetPrototype;
018    
019    /**
020     * The persistence interface for the layout set prototype service.
021     *
022     * <p>
023     * Never modify this interface directly. Modify <code>service.xml</code> and rerun ServiceBuilder to regnerate this interface.
024     * </p>
025     *
026     * @author Brian Wing Shun Chan
027     * @see LayoutSetPrototypePersistenceImpl
028     * @see LayoutSetPrototypeUtil
029     * @generated
030     */
031    public interface LayoutSetPrototypePersistence extends BasePersistence<LayoutSetPrototype> {
032            /**
033            * Caches the layout set prototype in the entity cache if it is enabled.
034            *
035            * @param layoutSetPrototype the layout set prototype to cache
036            */
037            public void cacheResult(
038                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype);
039    
040            /**
041            * Caches the layout set prototypes in the entity cache if it is enabled.
042            *
043            * @param layoutSetPrototypes the layout set prototypes to cache
044            */
045            public void cacheResult(
046                    java.util.List<com.liferay.portal.model.LayoutSetPrototype> layoutSetPrototypes);
047    
048            /**
049            * Creates a new layout set prototype with the primary key.
050            *
051            * @param layoutSetPrototypeId the primary key for the new layout set prototype
052            * @return the new layout set prototype
053            */
054            public com.liferay.portal.model.LayoutSetPrototype create(
055                    long layoutSetPrototypeId);
056    
057            /**
058            * Removes the layout set prototype with the primary key from the database. Also notifies the appropriate model listeners.
059            *
060            * @param layoutSetPrototypeId the primary key of the layout set prototype to remove
061            * @return the layout set prototype that was removed
062            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a layout set prototype with the primary key could not be found
063            * @throws SystemException if a system exception occurred
064            */
065            public com.liferay.portal.model.LayoutSetPrototype remove(
066                    long layoutSetPrototypeId)
067                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
068                            com.liferay.portal.kernel.exception.SystemException;
069    
070            public com.liferay.portal.model.LayoutSetPrototype updateImpl(
071                    com.liferay.portal.model.LayoutSetPrototype layoutSetPrototype,
072                    boolean merge)
073                    throws com.liferay.portal.kernel.exception.SystemException;
074    
075            /**
076            * Finds the layout set prototype with the primary key or throws a {@link com.liferay.portal.NoSuchLayoutSetPrototypeException} if it could not be found.
077            *
078            * @param layoutSetPrototypeId the primary key of the layout set prototype to find
079            * @return the layout set prototype
080            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a layout set prototype with the primary key could not be found
081            * @throws SystemException if a system exception occurred
082            */
083            public com.liferay.portal.model.LayoutSetPrototype findByPrimaryKey(
084                    long layoutSetPrototypeId)
085                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
086                            com.liferay.portal.kernel.exception.SystemException;
087    
088            /**
089            * Finds the layout set prototype with the primary key or returns <code>null</code> if it could not be found.
090            *
091            * @param layoutSetPrototypeId the primary key of the layout set prototype to find
092            * @return the layout set prototype, or <code>null</code> if a layout set prototype with the primary key could not be found
093            * @throws SystemException if a system exception occurred
094            */
095            public com.liferay.portal.model.LayoutSetPrototype fetchByPrimaryKey(
096                    long layoutSetPrototypeId)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Finds all the layout set prototypes where companyId = &#63;.
101            *
102            * @param companyId the company id to search with
103            * @return the matching layout set prototypes
104            * @throws SystemException if a system exception occurred
105            */
106            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByCompanyId(
107                    long companyId)
108                    throws com.liferay.portal.kernel.exception.SystemException;
109    
110            /**
111            * Finds a range of all the layout set prototypes where companyId = &#63;.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param companyId the company id to search with
118            * @param start the lower bound of the range of layout set prototypes to return
119            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
120            * @return the range of matching layout set prototypes
121            * @throws SystemException if a system exception occurred
122            */
123            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByCompanyId(
124                    long companyId, int start, int end)
125                    throws com.liferay.portal.kernel.exception.SystemException;
126    
127            /**
128            * Finds an ordered range of all the layout set prototypes where companyId = &#63;.
129            *
130            * <p>
131            * 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.
132            * </p>
133            *
134            * @param companyId the company id to search with
135            * @param start the lower bound of the range of layout set prototypes to return
136            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
137            * @param orderByComparator the comparator to order the results by
138            * @return the ordered range of matching layout set prototypes
139            * @throws SystemException if a system exception occurred
140            */
141            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByCompanyId(
142                    long companyId, int start, int end,
143                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Finds the first layout set prototype in the ordered set where companyId = &#63;.
148            *
149            * <p>
150            * 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.
151            * </p>
152            *
153            * @param companyId the company id to search with
154            * @param orderByComparator the comparator to order the set by
155            * @return the first matching layout set prototype
156            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a matching layout set prototype could not be found
157            * @throws SystemException if a system exception occurred
158            */
159            public com.liferay.portal.model.LayoutSetPrototype findByCompanyId_First(
160                    long companyId,
161                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
162                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            /**
166            * Finds the last layout set prototype in the ordered set where companyId = &#63;.
167            *
168            * <p>
169            * 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.
170            * </p>
171            *
172            * @param companyId the company id to search with
173            * @param orderByComparator the comparator to order the set by
174            * @return the last matching layout set prototype
175            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a matching layout set prototype could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            public com.liferay.portal.model.LayoutSetPrototype findByCompanyId_Last(
179                    long companyId,
180                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
181                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Finds the layout set prototypes before and after the current layout set prototype in the ordered set where companyId = &#63;.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param layoutSetPrototypeId the primary key of the current layout set prototype
192            * @param companyId the company id to search with
193            * @param orderByComparator the comparator to order the set by
194            * @return the previous, current, and next layout set prototype
195            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a layout set prototype with the primary key could not be found
196            * @throws SystemException if a system exception occurred
197            */
198            public com.liferay.portal.model.LayoutSetPrototype[] findByCompanyId_PrevAndNext(
199                    long layoutSetPrototypeId, long companyId,
200                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
201                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
202                            com.liferay.portal.kernel.exception.SystemException;
203    
204            /**
205            * Finds all the layout set prototypes where companyId = &#63; and active = &#63;.
206            *
207            * @param companyId the company id to search with
208            * @param active the active to search with
209            * @return the matching layout set prototypes
210            * @throws SystemException if a system exception occurred
211            */
212            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByC_A(
213                    long companyId, boolean active)
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Finds a range of all the layout set prototypes where companyId = &#63; and active = &#63;.
218            *
219            * <p>
220            * 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.
221            * </p>
222            *
223            * @param companyId the company id to search with
224            * @param active the active to search with
225            * @param start the lower bound of the range of layout set prototypes to return
226            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
227            * @return the range of matching layout set prototypes
228            * @throws SystemException if a system exception occurred
229            */
230            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByC_A(
231                    long companyId, boolean active, int start, int end)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Finds an ordered range of all the layout set prototypes where companyId = &#63; and active = &#63;.
236            *
237            * <p>
238            * 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.
239            * </p>
240            *
241            * @param companyId the company id to search with
242            * @param active the active to search with
243            * @param start the lower bound of the range of layout set prototypes to return
244            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
245            * @param orderByComparator the comparator to order the results by
246            * @return the ordered range of matching layout set prototypes
247            * @throws SystemException if a system exception occurred
248            */
249            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findByC_A(
250                    long companyId, boolean active, int start, int end,
251                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            /**
255            * Finds the first layout set prototype in the ordered set where companyId = &#63; and active = &#63;.
256            *
257            * <p>
258            * 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.
259            * </p>
260            *
261            * @param companyId the company id to search with
262            * @param active the active to search with
263            * @param orderByComparator the comparator to order the set by
264            * @return the first matching layout set prototype
265            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a matching layout set prototype could not be found
266            * @throws SystemException if a system exception occurred
267            */
268            public com.liferay.portal.model.LayoutSetPrototype findByC_A_First(
269                    long companyId, boolean active,
270                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
271                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            /**
275            * Finds the last layout set prototype in the ordered set where companyId = &#63; and active = &#63;.
276            *
277            * <p>
278            * 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.
279            * </p>
280            *
281            * @param companyId the company id to search with
282            * @param active the active to search with
283            * @param orderByComparator the comparator to order the set by
284            * @return the last matching layout set prototype
285            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a matching layout set prototype could not be found
286            * @throws SystemException if a system exception occurred
287            */
288            public com.liferay.portal.model.LayoutSetPrototype findByC_A_Last(
289                    long companyId, boolean active,
290                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
291                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            /**
295            * Finds the layout set prototypes before and after the current layout set prototype in the ordered set where companyId = &#63; and active = &#63;.
296            *
297            * <p>
298            * 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.
299            * </p>
300            *
301            * @param layoutSetPrototypeId the primary key of the current layout set prototype
302            * @param companyId the company id to search with
303            * @param active the active to search with
304            * @param orderByComparator the comparator to order the set by
305            * @return the previous, current, and next layout set prototype
306            * @throws com.liferay.portal.NoSuchLayoutSetPrototypeException if a layout set prototype with the primary key could not be found
307            * @throws SystemException if a system exception occurred
308            */
309            public com.liferay.portal.model.LayoutSetPrototype[] findByC_A_PrevAndNext(
310                    long layoutSetPrototypeId, long companyId, boolean active,
311                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
312                    throws com.liferay.portal.NoSuchLayoutSetPrototypeException,
313                            com.liferay.portal.kernel.exception.SystemException;
314    
315            /**
316            * Finds all the layout set prototypes.
317            *
318            * @return the layout set prototypes
319            * @throws SystemException if a system exception occurred
320            */
321            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findAll()
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            /**
325            * Finds a range of all the layout set prototypes.
326            *
327            * <p>
328            * 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.
329            * </p>
330            *
331            * @param start the lower bound of the range of layout set prototypes to return
332            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
333            * @return the range of layout set prototypes
334            * @throws SystemException if a system exception occurred
335            */
336            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findAll(
337                    int start, int end)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            /**
341            * Finds an ordered range of all the layout set prototypes.
342            *
343            * <p>
344            * 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.
345            * </p>
346            *
347            * @param start the lower bound of the range of layout set prototypes to return
348            * @param end the upper bound of the range of layout set prototypes to return (not inclusive)
349            * @param orderByComparator the comparator to order the results by
350            * @return the ordered range of layout set prototypes
351            * @throws SystemException if a system exception occurred
352            */
353            public java.util.List<com.liferay.portal.model.LayoutSetPrototype> findAll(
354                    int start, int end,
355                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            /**
359            * Removes all the layout set prototypes where companyId = &#63; from the database.
360            *
361            * @param companyId the company id to search with
362            * @throws SystemException if a system exception occurred
363            */
364            public void removeByCompanyId(long companyId)
365                    throws com.liferay.portal.kernel.exception.SystemException;
366    
367            /**
368            * Removes all the layout set prototypes where companyId = &#63; and active = &#63; from the database.
369            *
370            * @param companyId the company id to search with
371            * @param active the active to search with
372            * @throws SystemException if a system exception occurred
373            */
374            public void removeByC_A(long companyId, boolean active)
375                    throws com.liferay.portal.kernel.exception.SystemException;
376    
377            /**
378            * Removes all the layout set prototypes from the database.
379            *
380            * @throws SystemException if a system exception occurred
381            */
382            public void removeAll()
383                    throws com.liferay.portal.kernel.exception.SystemException;
384    
385            /**
386            * Counts all the layout set prototypes where companyId = &#63;.
387            *
388            * @param companyId the company id to search with
389            * @return the number of matching layout set prototypes
390            * @throws SystemException if a system exception occurred
391            */
392            public int countByCompanyId(long companyId)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            /**
396            * Counts all the layout set prototypes where companyId = &#63; and active = &#63;.
397            *
398            * @param companyId the company id to search with
399            * @param active the active to search with
400            * @return the number of matching layout set prototypes
401            * @throws SystemException if a system exception occurred
402            */
403            public int countByC_A(long companyId, boolean active)
404                    throws com.liferay.portal.kernel.exception.SystemException;
405    
406            /**
407            * Counts all the layout set prototypes.
408            *
409            * @return the number of layout set prototypes
410            * @throws SystemException if a system exception occurred
411            */
412            public int countAll()
413                    throws com.liferay.portal.kernel.exception.SystemException;
414    }