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