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.document.library.kernel.service.persistence; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.document.library.kernel.exception.NoSuchSyncEventException; 020 import com.liferay.document.library.kernel.model.DLSyncEvent; 021 022 import com.liferay.portal.kernel.service.persistence.BasePersistence; 023 024 /** 025 * The persistence interface for the d l sync event service. 026 * 027 * <p> 028 * Caching information and settings can be found in <code>portal.properties</code> 029 * </p> 030 * 031 * @author Brian Wing Shun Chan 032 * @see com.liferay.portlet.documentlibrary.service.persistence.impl.DLSyncEventPersistenceImpl 033 * @see DLSyncEventUtil 034 * @generated 035 */ 036 @ProviderType 037 public interface DLSyncEventPersistence extends BasePersistence<DLSyncEvent> { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify or reference this interface directly. Always use {@link DLSyncEventUtil} to access the d l sync event persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 042 */ 043 044 /** 045 * Returns all the d l sync events where modifiedTime > ?. 046 * 047 * @param modifiedTime the modified time 048 * @return the matching d l sync events 049 */ 050 public java.util.List<DLSyncEvent> findByModifiedTime(long modifiedTime); 051 052 /** 053 * Returns a range of all the d l sync events where modifiedTime > ?. 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 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 DLSyncEventModelImpl}. 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 modifiedTime the modified time 060 * @param start the lower bound of the range of d l sync events 061 * @param end the upper bound of the range of d l sync events (not inclusive) 062 * @return the range of matching d l sync events 063 */ 064 public java.util.List<DLSyncEvent> findByModifiedTime(long modifiedTime, 065 int start, int end); 066 067 /** 068 * Returns an ordered range of all the d l sync events where modifiedTime > ?. 069 * 070 * <p> 071 * 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 DLSyncEventModelImpl}. 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. 072 * </p> 073 * 074 * @param modifiedTime the modified time 075 * @param start the lower bound of the range of d l sync events 076 * @param end the upper bound of the range of d l sync events (not inclusive) 077 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 078 * @return the ordered range of matching d l sync events 079 */ 080 public java.util.List<DLSyncEvent> findByModifiedTime(long modifiedTime, 081 int start, int end, 082 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator); 083 084 /** 085 * Returns an ordered range of all the d l sync events where modifiedTime > ?. 086 * 087 * <p> 088 * 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 DLSyncEventModelImpl}. 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. 089 * </p> 090 * 091 * @param modifiedTime the modified time 092 * @param start the lower bound of the range of d l sync events 093 * @param end the upper bound of the range of d l sync events (not inclusive) 094 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 095 * @param retrieveFromCache whether to retrieve from the finder cache 096 * @return the ordered range of matching d l sync events 097 */ 098 public java.util.List<DLSyncEvent> findByModifiedTime(long modifiedTime, 099 int start, int end, 100 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator, 101 boolean retrieveFromCache); 102 103 /** 104 * Returns the first d l sync event in the ordered set where modifiedTime > ?. 105 * 106 * @param modifiedTime the modified time 107 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 108 * @return the first matching d l sync event 109 * @throws NoSuchSyncEventException if a matching d l sync event could not be found 110 */ 111 public DLSyncEvent findByModifiedTime_First(long modifiedTime, 112 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator) 113 throws NoSuchSyncEventException; 114 115 /** 116 * Returns the first d l sync event in the ordered set where modifiedTime > ?. 117 * 118 * @param modifiedTime the modified time 119 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 120 * @return the first matching d l sync event, or <code>null</code> if a matching d l sync event could not be found 121 */ 122 public DLSyncEvent fetchByModifiedTime_First(long modifiedTime, 123 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator); 124 125 /** 126 * Returns the last d l sync event in the ordered set where modifiedTime > ?. 127 * 128 * @param modifiedTime the modified time 129 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 130 * @return the last matching d l sync event 131 * @throws NoSuchSyncEventException if a matching d l sync event could not be found 132 */ 133 public DLSyncEvent findByModifiedTime_Last(long modifiedTime, 134 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator) 135 throws NoSuchSyncEventException; 136 137 /** 138 * Returns the last d l sync event in the ordered set where modifiedTime > ?. 139 * 140 * @param modifiedTime the modified time 141 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 142 * @return the last matching d l sync event, or <code>null</code> if a matching d l sync event could not be found 143 */ 144 public DLSyncEvent fetchByModifiedTime_Last(long modifiedTime, 145 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator); 146 147 /** 148 * Returns the d l sync events before and after the current d l sync event in the ordered set where modifiedTime > ?. 149 * 150 * @param syncEventId the primary key of the current d l sync event 151 * @param modifiedTime the modified time 152 * @param orderByComparator the comparator to order the set by (optionally <code>null</code>) 153 * @return the previous, current, and next d l sync event 154 * @throws NoSuchSyncEventException if a d l sync event with the primary key could not be found 155 */ 156 public DLSyncEvent[] findByModifiedTime_PrevAndNext(long syncEventId, 157 long modifiedTime, 158 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator) 159 throws NoSuchSyncEventException; 160 161 /** 162 * Removes all the d l sync events where modifiedTime > ? from the database. 163 * 164 * @param modifiedTime the modified time 165 */ 166 public void removeByModifiedTime(long modifiedTime); 167 168 /** 169 * Returns the number of d l sync events where modifiedTime > ?. 170 * 171 * @param modifiedTime the modified time 172 * @return the number of matching d l sync events 173 */ 174 public int countByModifiedTime(long modifiedTime); 175 176 /** 177 * Returns the d l sync event where typePK = ? or throws a {@link NoSuchSyncEventException} if it could not be found. 178 * 179 * @param typePK the type p k 180 * @return the matching d l sync event 181 * @throws NoSuchSyncEventException if a matching d l sync event could not be found 182 */ 183 public DLSyncEvent findByTypePK(long typePK) 184 throws NoSuchSyncEventException; 185 186 /** 187 * Returns the d l sync event where typePK = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 188 * 189 * @param typePK the type p k 190 * @return the matching d l sync event, or <code>null</code> if a matching d l sync event could not be found 191 */ 192 public DLSyncEvent fetchByTypePK(long typePK); 193 194 /** 195 * Returns the d l sync event where typePK = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 196 * 197 * @param typePK the type p k 198 * @param retrieveFromCache whether to retrieve from the finder cache 199 * @return the matching d l sync event, or <code>null</code> if a matching d l sync event could not be found 200 */ 201 public DLSyncEvent fetchByTypePK(long typePK, boolean retrieveFromCache); 202 203 /** 204 * Removes the d l sync event where typePK = ? from the database. 205 * 206 * @param typePK the type p k 207 * @return the d l sync event that was removed 208 */ 209 public DLSyncEvent removeByTypePK(long typePK) 210 throws NoSuchSyncEventException; 211 212 /** 213 * Returns the number of d l sync events where typePK = ?. 214 * 215 * @param typePK the type p k 216 * @return the number of matching d l sync events 217 */ 218 public int countByTypePK(long typePK); 219 220 /** 221 * Caches the d l sync event in the entity cache if it is enabled. 222 * 223 * @param dlSyncEvent the d l sync event 224 */ 225 public void cacheResult(DLSyncEvent dlSyncEvent); 226 227 /** 228 * Caches the d l sync events in the entity cache if it is enabled. 229 * 230 * @param dlSyncEvents the d l sync events 231 */ 232 public void cacheResult(java.util.List<DLSyncEvent> dlSyncEvents); 233 234 /** 235 * Creates a new d l sync event with the primary key. Does not add the d l sync event to the database. 236 * 237 * @param syncEventId the primary key for the new d l sync event 238 * @return the new d l sync event 239 */ 240 public DLSyncEvent create(long syncEventId); 241 242 /** 243 * Removes the d l sync event with the primary key from the database. Also notifies the appropriate model listeners. 244 * 245 * @param syncEventId the primary key of the d l sync event 246 * @return the d l sync event that was removed 247 * @throws NoSuchSyncEventException if a d l sync event with the primary key could not be found 248 */ 249 public DLSyncEvent remove(long syncEventId) throws NoSuchSyncEventException; 250 251 public DLSyncEvent updateImpl(DLSyncEvent dlSyncEvent); 252 253 /** 254 * Returns the d l sync event with the primary key or throws a {@link NoSuchSyncEventException} if it could not be found. 255 * 256 * @param syncEventId the primary key of the d l sync event 257 * @return the d l sync event 258 * @throws NoSuchSyncEventException if a d l sync event with the primary key could not be found 259 */ 260 public DLSyncEvent findByPrimaryKey(long syncEventId) 261 throws NoSuchSyncEventException; 262 263 /** 264 * Returns the d l sync event with the primary key or returns <code>null</code> if it could not be found. 265 * 266 * @param syncEventId the primary key of the d l sync event 267 * @return the d l sync event, or <code>null</code> if a d l sync event with the primary key could not be found 268 */ 269 public DLSyncEvent fetchByPrimaryKey(long syncEventId); 270 271 @Override 272 public java.util.Map<java.io.Serializable, DLSyncEvent> fetchByPrimaryKeys( 273 java.util.Set<java.io.Serializable> primaryKeys); 274 275 /** 276 * Returns all the d l sync events. 277 * 278 * @return the d l sync events 279 */ 280 public java.util.List<DLSyncEvent> findAll(); 281 282 /** 283 * Returns a range of all the d l sync events. 284 * 285 * <p> 286 * 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 DLSyncEventModelImpl}. 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. 287 * </p> 288 * 289 * @param start the lower bound of the range of d l sync events 290 * @param end the upper bound of the range of d l sync events (not inclusive) 291 * @return the range of d l sync events 292 */ 293 public java.util.List<DLSyncEvent> findAll(int start, int end); 294 295 /** 296 * Returns an ordered range of all the d l sync events. 297 * 298 * <p> 299 * 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 DLSyncEventModelImpl}. 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. 300 * </p> 301 * 302 * @param start the lower bound of the range of d l sync events 303 * @param end the upper bound of the range of d l sync events (not inclusive) 304 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 305 * @return the ordered range of d l sync events 306 */ 307 public java.util.List<DLSyncEvent> findAll(int start, int end, 308 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator); 309 310 /** 311 * Returns an ordered range of all the d l sync events. 312 * 313 * <p> 314 * 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 DLSyncEventModelImpl}. 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. 315 * </p> 316 * 317 * @param start the lower bound of the range of d l sync events 318 * @param end the upper bound of the range of d l sync events (not inclusive) 319 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 320 * @param retrieveFromCache whether to retrieve from the finder cache 321 * @return the ordered range of d l sync events 322 */ 323 public java.util.List<DLSyncEvent> findAll(int start, int end, 324 com.liferay.portal.kernel.util.OrderByComparator<DLSyncEvent> orderByComparator, 325 boolean retrieveFromCache); 326 327 /** 328 * Removes all the d l sync events from the database. 329 */ 330 public void removeAll(); 331 332 /** 333 * Returns the number of d l sync events. 334 * 335 * @return the number of d l sync events 336 */ 337 public int countAll(); 338 339 @Override 340 public java.util.Set<java.lang.String> getBadColumnNames(); 341 }