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