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