001    /**
002     * Copyright (c) 2000-2010 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.UserTrackerPath;
018    
019    /**
020     * The persistence interface for the user tracker path service.
021     *
022     * <p>
023     * Never modify this interface directly. Modify <code>service.xml</code> and rerun ServiceBuilder to regnerate this interface.
024     * </p>
025     *
026     * @author Brian Wing Shun Chan
027     * @see UserTrackerPathPersistenceImpl
028     * @see UserTrackerPathUtil
029     * @generated
030     */
031    public interface UserTrackerPathPersistence extends BasePersistence<UserTrackerPath> {
032            /**
033            * Caches the user tracker path in the entity cache if it is enabled.
034            *
035            * @param userTrackerPath the user tracker path to cache
036            */
037            public void cacheResult(
038                    com.liferay.portal.model.UserTrackerPath userTrackerPath);
039    
040            /**
041            * Caches the user tracker paths in the entity cache if it is enabled.
042            *
043            * @param userTrackerPaths the user tracker paths to cache
044            */
045            public void cacheResult(
046                    java.util.List<com.liferay.portal.model.UserTrackerPath> userTrackerPaths);
047    
048            /**
049            * Creates a new user tracker path with the primary key.
050            *
051            * @param userTrackerPathId the primary key for the new user tracker path
052            * @return the new user tracker path
053            */
054            public com.liferay.portal.model.UserTrackerPath create(
055                    long userTrackerPathId);
056    
057            /**
058            * Removes the user tracker path with the primary key from the database. Also notifies the appropriate model listeners.
059            *
060            * @param userTrackerPathId the primary key of the user tracker path to remove
061            * @return the user tracker path that was removed
062            * @throws com.liferay.portal.NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
063            * @throws SystemException if a system exception occurred
064            */
065            public com.liferay.portal.model.UserTrackerPath remove(
066                    long userTrackerPathId)
067                    throws com.liferay.portal.NoSuchUserTrackerPathException,
068                            com.liferay.portal.kernel.exception.SystemException;
069    
070            public com.liferay.portal.model.UserTrackerPath updateImpl(
071                    com.liferay.portal.model.UserTrackerPath userTrackerPath, boolean merge)
072                    throws com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Finds the user tracker path with the primary key or throws a {@link com.liferay.portal.NoSuchUserTrackerPathException} if it could not be found.
076            *
077            * @param userTrackerPathId the primary key of the user tracker path to find
078            * @return the user tracker path
079            * @throws com.liferay.portal.NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
080            * @throws SystemException if a system exception occurred
081            */
082            public com.liferay.portal.model.UserTrackerPath findByPrimaryKey(
083                    long userTrackerPathId)
084                    throws com.liferay.portal.NoSuchUserTrackerPathException,
085                            com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Finds the user tracker path with the primary key or returns <code>null</code> if it could not be found.
089            *
090            * @param userTrackerPathId the primary key of the user tracker path to find
091            * @return the user tracker path, or <code>null</code> if a user tracker path with the primary key could not be found
092            * @throws SystemException if a system exception occurred
093            */
094            public com.liferay.portal.model.UserTrackerPath fetchByPrimaryKey(
095                    long userTrackerPathId)
096                    throws com.liferay.portal.kernel.exception.SystemException;
097    
098            /**
099            * Finds all the user tracker paths where userTrackerId = &#63;.
100            *
101            * @param userTrackerId the user tracker id to search with
102            * @return the matching user tracker paths
103            * @throws SystemException if a system exception occurred
104            */
105            public java.util.List<com.liferay.portal.model.UserTrackerPath> findByUserTrackerId(
106                    long userTrackerId)
107                    throws com.liferay.portal.kernel.exception.SystemException;
108    
109            /**
110            * Finds a range of all the user tracker paths where userTrackerId = &#63;.
111            *
112            * <p>
113            * 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.
114            * </p>
115            *
116            * @param userTrackerId the user tracker id to search with
117            * @param start the lower bound of the range of user tracker paths to return
118            * @param end the upper bound of the range of user tracker paths to return (not inclusive)
119            * @return the range of matching user tracker paths
120            * @throws SystemException if a system exception occurred
121            */
122            public java.util.List<com.liferay.portal.model.UserTrackerPath> findByUserTrackerId(
123                    long userTrackerId, int start, int end)
124                    throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Finds an ordered range of all the user tracker paths where userTrackerId = &#63;.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param userTrackerId the user tracker id to search with
134            * @param start the lower bound of the range of user tracker paths to return
135            * @param end the upper bound of the range of user tracker paths to return (not inclusive)
136            * @param orderByComparator the comparator to order the results by
137            * @return the ordered range of matching user tracker paths
138            * @throws SystemException if a system exception occurred
139            */
140            public java.util.List<com.liferay.portal.model.UserTrackerPath> findByUserTrackerId(
141                    long userTrackerId, int start, int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Finds the first user tracker path in the ordered set where userTrackerId = &#63;.
147            *
148            * <p>
149            * 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.
150            * </p>
151            *
152            * @param userTrackerId the user tracker id to search with
153            * @param orderByComparator the comparator to order the set by
154            * @return the first matching user tracker path
155            * @throws com.liferay.portal.NoSuchUserTrackerPathException if a matching user tracker path could not be found
156            * @throws SystemException if a system exception occurred
157            */
158            public com.liferay.portal.model.UserTrackerPath findByUserTrackerId_First(
159                    long userTrackerId,
160                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
161                    throws com.liferay.portal.NoSuchUserTrackerPathException,
162                            com.liferay.portal.kernel.exception.SystemException;
163    
164            /**
165            * Finds the last user tracker path in the ordered set where userTrackerId = &#63;.
166            *
167            * <p>
168            * 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.
169            * </p>
170            *
171            * @param userTrackerId the user tracker id to search with
172            * @param orderByComparator the comparator to order the set by
173            * @return the last matching user tracker path
174            * @throws com.liferay.portal.NoSuchUserTrackerPathException if a matching user tracker path could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            public com.liferay.portal.model.UserTrackerPath findByUserTrackerId_Last(
178                    long userTrackerId,
179                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
180                    throws com.liferay.portal.NoSuchUserTrackerPathException,
181                            com.liferay.portal.kernel.exception.SystemException;
182    
183            /**
184            * Finds the user tracker paths before and after the current user tracker path in the ordered set where userTrackerId = &#63;.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param userTrackerPathId the primary key of the current user tracker path
191            * @param userTrackerId the user tracker id to search with
192            * @param orderByComparator the comparator to order the set by
193            * @return the previous, current, and next user tracker path
194            * @throws com.liferay.portal.NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public com.liferay.portal.model.UserTrackerPath[] findByUserTrackerId_PrevAndNext(
198                    long userTrackerPathId, long userTrackerId,
199                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
200                    throws com.liferay.portal.NoSuchUserTrackerPathException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            /**
204            * Finds all the user tracker paths.
205            *
206            * @return the user tracker paths
207            * @throws SystemException if a system exception occurred
208            */
209            public java.util.List<com.liferay.portal.model.UserTrackerPath> findAll()
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Finds a range of all the user tracker paths.
214            *
215            * <p>
216            * 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.
217            * </p>
218            *
219            * @param start the lower bound of the range of user tracker paths to return
220            * @param end the upper bound of the range of user tracker paths to return (not inclusive)
221            * @return the range of user tracker paths
222            * @throws SystemException if a system exception occurred
223            */
224            public java.util.List<com.liferay.portal.model.UserTrackerPath> findAll(
225                    int start, int end)
226                    throws com.liferay.portal.kernel.exception.SystemException;
227    
228            /**
229            * Finds an ordered range of all the user tracker paths.
230            *
231            * <p>
232            * 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.
233            * </p>
234            *
235            * @param start the lower bound of the range of user tracker paths to return
236            * @param end the upper bound of the range of user tracker paths to return (not inclusive)
237            * @param orderByComparator the comparator to order the results by
238            * @return the ordered range of user tracker paths
239            * @throws SystemException if a system exception occurred
240            */
241            public java.util.List<com.liferay.portal.model.UserTrackerPath> findAll(
242                    int start, int end,
243                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
244                    throws com.liferay.portal.kernel.exception.SystemException;
245    
246            /**
247            * Removes all the user tracker paths where userTrackerId = &#63; from the database.
248            *
249            * @param userTrackerId the user tracker id to search with
250            * @throws SystemException if a system exception occurred
251            */
252            public void removeByUserTrackerId(long userTrackerId)
253                    throws com.liferay.portal.kernel.exception.SystemException;
254    
255            /**
256            * Removes all the user tracker paths from the database.
257            *
258            * @throws SystemException if a system exception occurred
259            */
260            public void removeAll()
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            /**
264            * Counts all the user tracker paths where userTrackerId = &#63;.
265            *
266            * @param userTrackerId the user tracker id to search with
267            * @return the number of matching user tracker paths
268            * @throws SystemException if a system exception occurred
269            */
270            public int countByUserTrackerId(long userTrackerId)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Counts all the user tracker paths.
275            *
276            * @return the number of user tracker paths
277            * @throws SystemException if a system exception occurred
278            */
279            public int countAll()
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    }