001    /**
002     * Copyright (c) 2000-present 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 com.liferay.portal.service.persistence.impl.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            */
047            public java.util.List<PasswordPolicyRel> findByPasswordPolicyId(
048                    long passwordPolicyId);
049    
050            /**
051            * Returns a range of all the password policy rels where passwordPolicyId = &#63;.
052            *
053            * <p>
054            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
055            * </p>
056            *
057            * @param passwordPolicyId the password policy ID
058            * @param start the lower bound of the range of password policy rels
059            * @param end the upper bound of the range of password policy rels (not inclusive)
060            * @return the range of matching password policy rels
061            */
062            public java.util.List<PasswordPolicyRel> findByPasswordPolicyId(
063                    long passwordPolicyId, int start, int end);
064    
065            /**
066            * Returns an ordered range of all the password policy rels where passwordPolicyId = &#63;.
067            *
068            * <p>
069            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
070            * </p>
071            *
072            * @param passwordPolicyId the password policy ID
073            * @param start the lower bound of the range of password policy rels
074            * @param end the upper bound of the range of password policy rels (not inclusive)
075            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
076            * @return the ordered range of matching password policy rels
077            */
078            public java.util.List<PasswordPolicyRel> findByPasswordPolicyId(
079                    long passwordPolicyId, int start, int end,
080                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator);
081    
082            /**
083            * Returns an ordered range of all the password policy rels where passwordPolicyId = &#63;.
084            *
085            * <p>
086            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
087            * </p>
088            *
089            * @param passwordPolicyId the password policy ID
090            * @param start the lower bound of the range of password policy rels
091            * @param end the upper bound of the range of password policy rels (not inclusive)
092            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
093            * @param retrieveFromCache whether to retrieve from the finder cache
094            * @return the ordered range of matching password policy rels
095            */
096            public java.util.List<PasswordPolicyRel> findByPasswordPolicyId(
097                    long passwordPolicyId, int start, int end,
098                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator,
099                    boolean retrieveFromCache);
100    
101            /**
102            * Returns the first password policy rel in the ordered set where passwordPolicyId = &#63;.
103            *
104            * @param passwordPolicyId the password policy ID
105            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
106            * @return the first matching password policy rel
107            * @throws NoSuchPasswordPolicyRelException if a matching password policy rel could not be found
108            */
109            public PasswordPolicyRel findByPasswordPolicyId_First(
110                    long passwordPolicyId,
111                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator)
112                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
113    
114            /**
115            * Returns the first password policy rel in the ordered set where passwordPolicyId = &#63;.
116            *
117            * @param passwordPolicyId the password policy ID
118            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
119            * @return the first matching password policy rel, or <code>null</code> if a matching password policy rel could not be found
120            */
121            public PasswordPolicyRel fetchByPasswordPolicyId_First(
122                    long passwordPolicyId,
123                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator);
124    
125            /**
126            * Returns the last password policy rel in the ordered set where passwordPolicyId = &#63;.
127            *
128            * @param passwordPolicyId the password policy ID
129            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
130            * @return the last matching password policy rel
131            * @throws NoSuchPasswordPolicyRelException if a matching password policy rel could not be found
132            */
133            public PasswordPolicyRel findByPasswordPolicyId_Last(
134                    long passwordPolicyId,
135                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator)
136                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
137    
138            /**
139            * Returns the last password policy rel in the ordered set where passwordPolicyId = &#63;.
140            *
141            * @param passwordPolicyId the password policy ID
142            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
143            * @return the last matching password policy rel, or <code>null</code> if a matching password policy rel could not be found
144            */
145            public PasswordPolicyRel fetchByPasswordPolicyId_Last(
146                    long passwordPolicyId,
147                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator);
148    
149            /**
150            * Returns the password policy rels before and after the current password policy rel in the ordered set where passwordPolicyId = &#63;.
151            *
152            * @param passwordPolicyRelId the primary key of the current password policy rel
153            * @param passwordPolicyId the password policy ID
154            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
155            * @return the previous, current, and next password policy rel
156            * @throws NoSuchPasswordPolicyRelException if a password policy rel with the primary key could not be found
157            */
158            public PasswordPolicyRel[] findByPasswordPolicyId_PrevAndNext(
159                    long passwordPolicyRelId, long passwordPolicyId,
160                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator)
161                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
162    
163            /**
164            * Removes all the password policy rels where passwordPolicyId = &#63; from the database.
165            *
166            * @param passwordPolicyId the password policy ID
167            */
168            public void removeByPasswordPolicyId(long passwordPolicyId);
169    
170            /**
171            * Returns the number of password policy rels where passwordPolicyId = &#63;.
172            *
173            * @param passwordPolicyId the password policy ID
174            * @return the number of matching password policy rels
175            */
176            public int countByPasswordPolicyId(long passwordPolicyId);
177    
178            /**
179            * Returns the password policy rel where classNameId = &#63; and classPK = &#63; or throws a {@link NoSuchPasswordPolicyRelException} if it could not be found.
180            *
181            * @param classNameId the class name ID
182            * @param classPK the class p k
183            * @return the matching password policy rel
184            * @throws NoSuchPasswordPolicyRelException if a matching password policy rel could not be found
185            */
186            public PasswordPolicyRel findByC_C(long classNameId, long classPK)
187                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
188    
189            /**
190            * 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.
191            *
192            * @param classNameId the class name ID
193            * @param classPK the class p k
194            * @return the matching password policy rel, or <code>null</code> if a matching password policy rel could not be found
195            */
196            public PasswordPolicyRel fetchByC_C(long classNameId, long classPK);
197    
198            /**
199            * 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.
200            *
201            * @param classNameId the class name ID
202            * @param classPK the class p k
203            * @param retrieveFromCache whether to retrieve from the finder cache
204            * @return the matching password policy rel, or <code>null</code> if a matching password policy rel could not be found
205            */
206            public PasswordPolicyRel fetchByC_C(long classNameId, long classPK,
207                    boolean retrieveFromCache);
208    
209            /**
210            * Removes the password policy rel where classNameId = &#63; and classPK = &#63; from the database.
211            *
212            * @param classNameId the class name ID
213            * @param classPK the class p k
214            * @return the password policy rel that was removed
215            */
216            public PasswordPolicyRel removeByC_C(long classNameId, long classPK)
217                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
218    
219            /**
220            * Returns the number of password policy rels where classNameId = &#63; and classPK = &#63;.
221            *
222            * @param classNameId the class name ID
223            * @param classPK the class p k
224            * @return the number of matching password policy rels
225            */
226            public int countByC_C(long classNameId, long classPK);
227    
228            /**
229            * Caches the password policy rel in the entity cache if it is enabled.
230            *
231            * @param passwordPolicyRel the password policy rel
232            */
233            public void cacheResult(PasswordPolicyRel passwordPolicyRel);
234    
235            /**
236            * Caches the password policy rels in the entity cache if it is enabled.
237            *
238            * @param passwordPolicyRels the password policy rels
239            */
240            public void cacheResult(
241                    java.util.List<PasswordPolicyRel> passwordPolicyRels);
242    
243            /**
244            * Creates a new password policy rel with the primary key. Does not add the password policy rel to the database.
245            *
246            * @param passwordPolicyRelId the primary key for the new password policy rel
247            * @return the new password policy rel
248            */
249            public PasswordPolicyRel create(long passwordPolicyRelId);
250    
251            /**
252            * Removes the password policy rel with the primary key from the database. Also notifies the appropriate model listeners.
253            *
254            * @param passwordPolicyRelId the primary key of the password policy rel
255            * @return the password policy rel that was removed
256            * @throws NoSuchPasswordPolicyRelException if a password policy rel with the primary key could not be found
257            */
258            public PasswordPolicyRel remove(long passwordPolicyRelId)
259                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
260    
261            public PasswordPolicyRel updateImpl(PasswordPolicyRel passwordPolicyRel);
262    
263            /**
264            * Returns the password policy rel with the primary key or throws a {@link NoSuchPasswordPolicyRelException} if it could not be found.
265            *
266            * @param passwordPolicyRelId the primary key of the password policy rel
267            * @return the password policy rel
268            * @throws NoSuchPasswordPolicyRelException if a password policy rel with the primary key could not be found
269            */
270            public PasswordPolicyRel findByPrimaryKey(long passwordPolicyRelId)
271                    throws com.liferay.portal.exception.NoSuchPasswordPolicyRelException;
272    
273            /**
274            * Returns the password policy rel with the primary key or returns <code>null</code> if it could not be found.
275            *
276            * @param passwordPolicyRelId the primary key of the password policy rel
277            * @return the password policy rel, or <code>null</code> if a password policy rel with the primary key could not be found
278            */
279            public PasswordPolicyRel fetchByPrimaryKey(long passwordPolicyRelId);
280    
281            @Override
282            public java.util.Map<java.io.Serializable, PasswordPolicyRel> fetchByPrimaryKeys(
283                    java.util.Set<java.io.Serializable> primaryKeys);
284    
285            /**
286            * Returns all the password policy rels.
287            *
288            * @return the password policy rels
289            */
290            public java.util.List<PasswordPolicyRel> findAll();
291    
292            /**
293            * Returns a range of all the password policy rels.
294            *
295            * <p>
296            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
297            * </p>
298            *
299            * @param start the lower bound of the range of password policy rels
300            * @param end the upper bound of the range of password policy rels (not inclusive)
301            * @return the range of password policy rels
302            */
303            public java.util.List<PasswordPolicyRel> findAll(int start, int end);
304    
305            /**
306            * Returns an ordered range of all the password policy rels.
307            *
308            * <p>
309            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
310            * </p>
311            *
312            * @param start the lower bound of the range of password policy rels
313            * @param end the upper bound of the range of password policy rels (not inclusive)
314            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
315            * @return the ordered range of password policy rels
316            */
317            public java.util.List<PasswordPolicyRel> findAll(int start, int end,
318                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator);
319    
320            /**
321            * Returns an ordered range of all the password policy rels.
322            *
323            * <p>
324            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
325            * </p>
326            *
327            * @param start the lower bound of the range of password policy rels
328            * @param end the upper bound of the range of password policy rels (not inclusive)
329            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
330            * @param retrieveFromCache whether to retrieve from the finder cache
331            * @return the ordered range of password policy rels
332            */
333            public java.util.List<PasswordPolicyRel> findAll(int start, int end,
334                    com.liferay.portal.kernel.util.OrderByComparator<PasswordPolicyRel> orderByComparator,
335                    boolean retrieveFromCache);
336    
337            /**
338            * Removes all the password policy rels from the database.
339            */
340            public void removeAll();
341    
342            /**
343            * Returns the number of password policy rels.
344            *
345            * @return the number of password policy rels
346            */
347            public int countAll();
348    }