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