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