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