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