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