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