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 com.liferay.portal.service.persistence.impl.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<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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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<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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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<UserTrackerPath> findByUserTrackerId(
079                    long userTrackerId, int start, int end,
080                    com.liferay.portal.kernel.util.OrderByComparator<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 NoSuchUserTrackerPathException if a matching user tracker path could not be found
089            */
090            public UserTrackerPath findByUserTrackerId_First(long userTrackerId,
091                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator)
092                    throws com.liferay.portal.NoSuchUserTrackerPathException;
093    
094            /**
095            * Returns the first user tracker path in the ordered set where userTrackerId = &#63;.
096            *
097            * @param userTrackerId the user tracker ID
098            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
099            * @return the first matching user tracker path, or <code>null</code> if a matching user tracker path could not be found
100            */
101            public UserTrackerPath fetchByUserTrackerId_First(long userTrackerId,
102                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator);
103    
104            /**
105            * Returns the last user tracker path in the ordered set where userTrackerId = &#63;.
106            *
107            * @param userTrackerId the user tracker ID
108            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
109            * @return the last matching user tracker path
110            * @throws NoSuchUserTrackerPathException if a matching user tracker path could not be found
111            */
112            public UserTrackerPath findByUserTrackerId_Last(long userTrackerId,
113                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator)
114                    throws com.liferay.portal.NoSuchUserTrackerPathException;
115    
116            /**
117            * Returns the last user tracker path in the ordered set where userTrackerId = &#63;.
118            *
119            * @param userTrackerId the user tracker ID
120            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
121            * @return the last matching user tracker path, or <code>null</code> if a matching user tracker path could not be found
122            */
123            public UserTrackerPath fetchByUserTrackerId_Last(long userTrackerId,
124                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator);
125    
126            /**
127            * Returns the user tracker paths before and after the current user tracker path in the ordered set where userTrackerId = &#63;.
128            *
129            * @param userTrackerPathId the primary key of the current user tracker path
130            * @param userTrackerId the user tracker ID
131            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
132            * @return the previous, current, and next user tracker path
133            * @throws NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
134            */
135            public UserTrackerPath[] findByUserTrackerId_PrevAndNext(
136                    long userTrackerPathId, long userTrackerId,
137                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator)
138                    throws com.liferay.portal.NoSuchUserTrackerPathException;
139    
140            /**
141            * Removes all the user tracker paths where userTrackerId = &#63; from the database.
142            *
143            * @param userTrackerId the user tracker ID
144            */
145            public void removeByUserTrackerId(long userTrackerId);
146    
147            /**
148            * Returns the number of user tracker paths where userTrackerId = &#63;.
149            *
150            * @param userTrackerId the user tracker ID
151            * @return the number of matching user tracker paths
152            */
153            public int countByUserTrackerId(long userTrackerId);
154    
155            /**
156            * Caches the user tracker path in the entity cache if it is enabled.
157            *
158            * @param userTrackerPath the user tracker path
159            */
160            public void cacheResult(UserTrackerPath userTrackerPath);
161    
162            /**
163            * Caches the user tracker paths in the entity cache if it is enabled.
164            *
165            * @param userTrackerPaths the user tracker paths
166            */
167            public void cacheResult(java.util.List<UserTrackerPath> userTrackerPaths);
168    
169            /**
170            * Creates a new user tracker path with the primary key. Does not add the user tracker path to the database.
171            *
172            * @param userTrackerPathId the primary key for the new user tracker path
173            * @return the new user tracker path
174            */
175            public UserTrackerPath create(long userTrackerPathId);
176    
177            /**
178            * Removes the user tracker path with the primary key from the database. Also notifies the appropriate model listeners.
179            *
180            * @param userTrackerPathId the primary key of the user tracker path
181            * @return the user tracker path that was removed
182            * @throws NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
183            */
184            public UserTrackerPath remove(long userTrackerPathId)
185                    throws com.liferay.portal.NoSuchUserTrackerPathException;
186    
187            public UserTrackerPath updateImpl(UserTrackerPath userTrackerPath);
188    
189            /**
190            * Returns the user tracker path with the primary key or throws a {@link NoSuchUserTrackerPathException} if it could not be found.
191            *
192            * @param userTrackerPathId the primary key of the user tracker path
193            * @return the user tracker path
194            * @throws NoSuchUserTrackerPathException if a user tracker path with the primary key could not be found
195            */
196            public UserTrackerPath findByPrimaryKey(long userTrackerPathId)
197                    throws com.liferay.portal.NoSuchUserTrackerPathException;
198    
199            /**
200            * Returns the user tracker path with the primary key or returns <code>null</code> if it could not be found.
201            *
202            * @param userTrackerPathId the primary key of the user tracker path
203            * @return the user tracker path, or <code>null</code> if a user tracker path with the primary key could not be found
204            */
205            public UserTrackerPath fetchByPrimaryKey(long userTrackerPathId);
206    
207            @Override
208            public java.util.Map<java.io.Serializable, UserTrackerPath> fetchByPrimaryKeys(
209                    java.util.Set<java.io.Serializable> primaryKeys);
210    
211            /**
212            * Returns all the user tracker paths.
213            *
214            * @return the user tracker paths
215            */
216            public java.util.List<UserTrackerPath> findAll();
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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
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            */
229            public java.util.List<UserTrackerPath> findAll(int start, int end);
230    
231            /**
232            * Returns an ordered range of all the user tracker paths.
233            *
234            * <p>
235            * 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 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 QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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.
236            * </p>
237            *
238            * @param start the lower bound of the range of user tracker paths
239            * @param end the upper bound of the range of user tracker paths (not inclusive)
240            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
241            * @return the ordered range of user tracker paths
242            */
243            public java.util.List<UserTrackerPath> findAll(int start, int end,
244                    com.liferay.portal.kernel.util.OrderByComparator<UserTrackerPath> orderByComparator);
245    
246            /**
247            * Removes all the user tracker paths from the database.
248            */
249            public void removeAll();
250    
251            /**
252            * Returns the number of user tracker paths.
253            *
254            * @return the number of user tracker paths
255            */
256            public int countAll();
257    }