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.PasswordTracker;
020    
021    /**
022     * The persistence interface for the password tracker 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 PasswordTrackerPersistenceImpl
030     * @see PasswordTrackerUtil
031     * @generated
032     */
033    @ProviderType
034    public interface PasswordTrackerPersistence extends BasePersistence<PasswordTracker> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link PasswordTrackerUtil} to access the password tracker persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Returns all the password trackers where userId = &#63;.
043            *
044            * @param userId the user ID
045            * @return the matching password trackers
046            * @throws SystemException if a system exception occurred
047            */
048            public java.util.List<com.liferay.portal.model.PasswordTracker> findByUserId(
049                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
050    
051            /**
052            * Returns a range of all the password trackers where userId = &#63;.
053            *
054            * <p>
055            * 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.PasswordTrackerModelImpl}. 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.
056            * </p>
057            *
058            * @param userId the user ID
059            * @param start the lower bound of the range of password trackers
060            * @param end the upper bound of the range of password trackers (not inclusive)
061            * @return the range of matching password trackers
062            * @throws SystemException if a system exception occurred
063            */
064            public java.util.List<com.liferay.portal.model.PasswordTracker> findByUserId(
065                    long userId, int start, int end)
066                    throws com.liferay.portal.kernel.exception.SystemException;
067    
068            /**
069            * Returns an ordered range of all the password trackers where userId = &#63;.
070            *
071            * <p>
072            * 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.PasswordTrackerModelImpl}. 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.
073            * </p>
074            *
075            * @param userId the user ID
076            * @param start the lower bound of the range of password trackers
077            * @param end the upper bound of the range of password trackers (not inclusive)
078            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
079            * @return the ordered range of matching password trackers
080            * @throws SystemException if a system exception occurred
081            */
082            public java.util.List<com.liferay.portal.model.PasswordTracker> findByUserId(
083                    long userId, int start, int end,
084                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Returns the first password tracker in the ordered set where userId = &#63;.
089            *
090            * @param userId the user ID
091            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
092            * @return the first matching password tracker
093            * @throws com.liferay.portal.NoSuchPasswordTrackerException if a matching password tracker could not be found
094            * @throws SystemException if a system exception occurred
095            */
096            public com.liferay.portal.model.PasswordTracker findByUserId_First(
097                    long userId,
098                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
099                    throws com.liferay.portal.NoSuchPasswordTrackerException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            /**
103            * Returns the first password tracker in the ordered set where userId = &#63;.
104            *
105            * @param userId the user ID
106            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
107            * @return the first matching password tracker, or <code>null</code> if a matching password tracker could not be found
108            * @throws SystemException if a system exception occurred
109            */
110            public com.liferay.portal.model.PasswordTracker fetchByUserId_First(
111                    long userId,
112                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
113                    throws com.liferay.portal.kernel.exception.SystemException;
114    
115            /**
116            * Returns the last password tracker in the ordered set where userId = &#63;.
117            *
118            * @param userId the user ID
119            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
120            * @return the last matching password tracker
121            * @throws com.liferay.portal.NoSuchPasswordTrackerException if a matching password tracker could not be found
122            * @throws SystemException if a system exception occurred
123            */
124            public com.liferay.portal.model.PasswordTracker findByUserId_Last(
125                    long userId,
126                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
127                    throws com.liferay.portal.NoSuchPasswordTrackerException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            /**
131            * Returns the last password tracker in the ordered set where userId = &#63;.
132            *
133            * @param userId the user ID
134            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
135            * @return the last matching password tracker, or <code>null</code> if a matching password tracker could not be found
136            * @throws SystemException if a system exception occurred
137            */
138            public com.liferay.portal.model.PasswordTracker fetchByUserId_Last(
139                    long userId,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            /**
144            * Returns the password trackers before and after the current password tracker in the ordered set where userId = &#63;.
145            *
146            * @param passwordTrackerId the primary key of the current password tracker
147            * @param userId the user ID
148            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
149            * @return the previous, current, and next password tracker
150            * @throws com.liferay.portal.NoSuchPasswordTrackerException if a password tracker with the primary key could not be found
151            * @throws SystemException if a system exception occurred
152            */
153            public com.liferay.portal.model.PasswordTracker[] findByUserId_PrevAndNext(
154                    long passwordTrackerId, long userId,
155                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
156                    throws com.liferay.portal.NoSuchPasswordTrackerException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            /**
160            * Removes all the password trackers where userId = &#63; from the database.
161            *
162            * @param userId the user ID
163            * @throws SystemException if a system exception occurred
164            */
165            public void removeByUserId(long userId)
166                    throws com.liferay.portal.kernel.exception.SystemException;
167    
168            /**
169            * Returns the number of password trackers where userId = &#63;.
170            *
171            * @param userId the user ID
172            * @return the number of matching password trackers
173            * @throws SystemException if a system exception occurred
174            */
175            public int countByUserId(long userId)
176                    throws com.liferay.portal.kernel.exception.SystemException;
177    
178            /**
179            * Caches the password tracker in the entity cache if it is enabled.
180            *
181            * @param passwordTracker the password tracker
182            */
183            public void cacheResult(
184                    com.liferay.portal.model.PasswordTracker passwordTracker);
185    
186            /**
187            * Caches the password trackers in the entity cache if it is enabled.
188            *
189            * @param passwordTrackers the password trackers
190            */
191            public void cacheResult(
192                    java.util.List<com.liferay.portal.model.PasswordTracker> passwordTrackers);
193    
194            /**
195            * Creates a new password tracker with the primary key. Does not add the password tracker to the database.
196            *
197            * @param passwordTrackerId the primary key for the new password tracker
198            * @return the new password tracker
199            */
200            public com.liferay.portal.model.PasswordTracker create(
201                    long passwordTrackerId);
202    
203            /**
204            * Removes the password tracker with the primary key from the database. Also notifies the appropriate model listeners.
205            *
206            * @param passwordTrackerId the primary key of the password tracker
207            * @return the password tracker that was removed
208            * @throws com.liferay.portal.NoSuchPasswordTrackerException if a password tracker with the primary key could not be found
209            * @throws SystemException if a system exception occurred
210            */
211            public com.liferay.portal.model.PasswordTracker remove(
212                    long passwordTrackerId)
213                    throws com.liferay.portal.NoSuchPasswordTrackerException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            public com.liferay.portal.model.PasswordTracker updateImpl(
217                    com.liferay.portal.model.PasswordTracker passwordTracker)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the password tracker with the primary key or throws a {@link com.liferay.portal.NoSuchPasswordTrackerException} if it could not be found.
222            *
223            * @param passwordTrackerId the primary key of the password tracker
224            * @return the password tracker
225            * @throws com.liferay.portal.NoSuchPasswordTrackerException if a password tracker with the primary key could not be found
226            * @throws SystemException if a system exception occurred
227            */
228            public com.liferay.portal.model.PasswordTracker findByPrimaryKey(
229                    long passwordTrackerId)
230                    throws com.liferay.portal.NoSuchPasswordTrackerException,
231                            com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Returns the password tracker with the primary key or returns <code>null</code> if it could not be found.
235            *
236            * @param passwordTrackerId the primary key of the password tracker
237            * @return the password tracker, or <code>null</code> if a password tracker with the primary key could not be found
238            * @throws SystemException if a system exception occurred
239            */
240            public com.liferay.portal.model.PasswordTracker fetchByPrimaryKey(
241                    long passwordTrackerId)
242                    throws com.liferay.portal.kernel.exception.SystemException;
243    
244            /**
245            * Returns all the password trackers.
246            *
247            * @return the password trackers
248            * @throws SystemException if a system exception occurred
249            */
250            public java.util.List<com.liferay.portal.model.PasswordTracker> findAll()
251                    throws com.liferay.portal.kernel.exception.SystemException;
252    
253            /**
254            * Returns a range of all the password trackers.
255            *
256            * <p>
257            * 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.PasswordTrackerModelImpl}. 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.
258            * </p>
259            *
260            * @param start the lower bound of the range of password trackers
261            * @param end the upper bound of the range of password trackers (not inclusive)
262            * @return the range of password trackers
263            * @throws SystemException if a system exception occurred
264            */
265            public java.util.List<com.liferay.portal.model.PasswordTracker> findAll(
266                    int start, int end)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            /**
270            * Returns an ordered range of all the password trackers.
271            *
272            * <p>
273            * 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.PasswordTrackerModelImpl}. 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.
274            * </p>
275            *
276            * @param start the lower bound of the range of password trackers
277            * @param end the upper bound of the range of password trackers (not inclusive)
278            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
279            * @return the ordered range of password trackers
280            * @throws SystemException if a system exception occurred
281            */
282            public java.util.List<com.liferay.portal.model.PasswordTracker> findAll(
283                    int start, int end,
284                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            /**
288            * Removes all the password trackers from the database.
289            *
290            * @throws SystemException if a system exception occurred
291            */
292            public void removeAll()
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            /**
296            * Returns the number of password trackers.
297            *
298            * @return the number of password trackers
299            * @throws SystemException if a system exception occurred
300            */
301            public int countAll()
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    }