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