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