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