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