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