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.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 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 &gt; &#63;.
045            *
046            * @param modifiedTime the modified time
047            * @return the matching d l sync events
048            * @throws SystemException if a system exception occurred
049            */
050            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findByModifiedTime(
051                    long modifiedTime)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Returns a range of all the d l sync events where modifiedTime &gt; &#63;.
056            *
057            * <p>
058            * 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.portlet.documentlibrary.model.impl.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.
059            * </p>
060            *
061            * @param modifiedTime the modified time
062            * @param start the lower bound of the range of d l sync events
063            * @param end the upper bound of the range of d l sync events (not inclusive)
064            * @return the range of matching d l sync events
065            * @throws SystemException if a system exception occurred
066            */
067            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findByModifiedTime(
068                    long modifiedTime, int start, int end)
069                    throws com.liferay.portal.kernel.exception.SystemException;
070    
071            /**
072            * Returns an ordered range of all the d l sync events where modifiedTime &gt; &#63;.
073            *
074            * <p>
075            * 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.portlet.documentlibrary.model.impl.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.
076            * </p>
077            *
078            * @param modifiedTime the modified time
079            * @param start the lower bound of the range of d l sync events
080            * @param end the upper bound of the range of d l sync events (not inclusive)
081            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
082            * @return the ordered range of matching d l sync events
083            * @throws SystemException if a system exception occurred
084            */
085            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findByModifiedTime(
086                    long modifiedTime, int start, int end,
087                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
088                    throws com.liferay.portal.kernel.exception.SystemException;
089    
090            /**
091            * Returns the first d l sync event in the ordered set where modifiedTime &gt; &#63;.
092            *
093            * @param modifiedTime the modified time
094            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
095            * @return the first matching d l sync event
096            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a matching d l sync event could not be found
097            * @throws SystemException if a system exception occurred
098            */
099            public com.liferay.portlet.documentlibrary.model.DLSyncEvent findByModifiedTime_First(
100                    long modifiedTime,
101                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
102                    throws com.liferay.portal.kernel.exception.SystemException,
103                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
104    
105            /**
106            * Returns the first d l sync event in the ordered set where modifiedTime &gt; &#63;.
107            *
108            * @param modifiedTime the modified time
109            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
110            * @return the first matching d l sync event, or <code>null</code> if a matching d l sync event could not be found
111            * @throws SystemException if a system exception occurred
112            */
113            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchByModifiedTime_First(
114                    long modifiedTime,
115                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
116                    throws com.liferay.portal.kernel.exception.SystemException;
117    
118            /**
119            * Returns the last d l sync event in the ordered set where modifiedTime &gt; &#63;.
120            *
121            * @param modifiedTime the modified time
122            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
123            * @return the last matching d l sync event
124            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a matching d l sync event could not be found
125            * @throws SystemException if a system exception occurred
126            */
127            public com.liferay.portlet.documentlibrary.model.DLSyncEvent findByModifiedTime_Last(
128                    long modifiedTime,
129                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
130                    throws com.liferay.portal.kernel.exception.SystemException,
131                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
132    
133            /**
134            * Returns the last d l sync event in the ordered set where modifiedTime &gt; &#63;.
135            *
136            * @param modifiedTime the modified time
137            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
138            * @return the last matching d l sync event, or <code>null</code> if a matching d l sync event could not be found
139            * @throws SystemException if a system exception occurred
140            */
141            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchByModifiedTime_Last(
142                    long modifiedTime,
143                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Returns the d l sync events before and after the current d l sync event in the ordered set where modifiedTime &gt; &#63;.
148            *
149            * @param syncEventId the primary key of the current d l sync event
150            * @param modifiedTime the modified time
151            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
152            * @return the previous, current, and next d l sync event
153            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a d l sync event with the primary key could not be found
154            * @throws SystemException if a system exception occurred
155            */
156            public com.liferay.portlet.documentlibrary.model.DLSyncEvent[] findByModifiedTime_PrevAndNext(
157                    long syncEventId, long modifiedTime,
158                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
159                    throws com.liferay.portal.kernel.exception.SystemException,
160                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
161    
162            /**
163            * Removes all the d l sync events where modifiedTime &gt; &#63; from the database.
164            *
165            * @param modifiedTime the modified time
166            * @throws SystemException if a system exception occurred
167            */
168            public void removeByModifiedTime(long modifiedTime)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            /**
172            * Returns the number of d l sync events where modifiedTime &gt; &#63;.
173            *
174            * @param modifiedTime the modified time
175            * @return the number of matching d l sync events
176            * @throws SystemException if a system exception occurred
177            */
178            public int countByModifiedTime(long modifiedTime)
179                    throws com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns the d l sync event where typePK = &#63; or throws a {@link com.liferay.portlet.documentlibrary.NoSuchSyncEventException} if it could not be found.
183            *
184            * @param typePK the type p k
185            * @return the matching d l sync event
186            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a matching d l sync event could not be found
187            * @throws SystemException if a system exception occurred
188            */
189            public com.liferay.portlet.documentlibrary.model.DLSyncEvent findByTypePK(
190                    long typePK)
191                    throws com.liferay.portal.kernel.exception.SystemException,
192                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
193    
194            /**
195            * Returns the d l sync event where typePK = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
196            *
197            * @param typePK the type p k
198            * @return the matching d l sync event, or <code>null</code> if a matching d l sync event could not be found
199            * @throws SystemException if a system exception occurred
200            */
201            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchByTypePK(
202                    long typePK) throws com.liferay.portal.kernel.exception.SystemException;
203    
204            /**
205            * Returns the d l sync event where typePK = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
206            *
207            * @param typePK the type p k
208            * @param retrieveFromCache whether to use the finder cache
209            * @return the matching d l sync event, or <code>null</code> if a matching d l sync event could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchByTypePK(
213                    long typePK, boolean retrieveFromCache)
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Removes the d l sync event where typePK = &#63; from the database.
218            *
219            * @param typePK the type p k
220            * @return the d l sync event that was removed
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.documentlibrary.model.DLSyncEvent removeByTypePK(
224                    long typePK)
225                    throws com.liferay.portal.kernel.exception.SystemException,
226                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
227    
228            /**
229            * Returns the number of d l sync events where typePK = &#63;.
230            *
231            * @param typePK the type p k
232            * @return the number of matching d l sync events
233            * @throws SystemException if a system exception occurred
234            */
235            public int countByTypePK(long typePK)
236                    throws com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * Caches the d l sync event in the entity cache if it is enabled.
240            *
241            * @param dlSyncEvent the d l sync event
242            */
243            public void cacheResult(
244                    com.liferay.portlet.documentlibrary.model.DLSyncEvent dlSyncEvent);
245    
246            /**
247            * Caches the d l sync events in the entity cache if it is enabled.
248            *
249            * @param dlSyncEvents the d l sync events
250            */
251            public void cacheResult(
252                    java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> dlSyncEvents);
253    
254            /**
255            * Creates a new d l sync event with the primary key. Does not add the d l sync event to the database.
256            *
257            * @param syncEventId the primary key for the new d l sync event
258            * @return the new d l sync event
259            */
260            public com.liferay.portlet.documentlibrary.model.DLSyncEvent create(
261                    long syncEventId);
262    
263            /**
264            * Removes the d l sync event with the primary key from the database. Also notifies the appropriate model listeners.
265            *
266            * @param syncEventId the primary key of the d l sync event
267            * @return the d l sync event that was removed
268            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a d l sync event with the primary key could not be found
269            * @throws SystemException if a system exception occurred
270            */
271            public com.liferay.portlet.documentlibrary.model.DLSyncEvent remove(
272                    long syncEventId)
273                    throws com.liferay.portal.kernel.exception.SystemException,
274                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
275    
276            public com.liferay.portlet.documentlibrary.model.DLSyncEvent updateImpl(
277                    com.liferay.portlet.documentlibrary.model.DLSyncEvent dlSyncEvent)
278                    throws com.liferay.portal.kernel.exception.SystemException;
279    
280            /**
281            * Returns the d l sync event with the primary key or throws a {@link com.liferay.portlet.documentlibrary.NoSuchSyncEventException} if it could not be found.
282            *
283            * @param syncEventId the primary key of the d l sync event
284            * @return the d l sync event
285            * @throws com.liferay.portlet.documentlibrary.NoSuchSyncEventException if a d l sync event with the primary key could not be found
286            * @throws SystemException if a system exception occurred
287            */
288            public com.liferay.portlet.documentlibrary.model.DLSyncEvent findByPrimaryKey(
289                    long syncEventId)
290                    throws com.liferay.portal.kernel.exception.SystemException,
291                            com.liferay.portlet.documentlibrary.NoSuchSyncEventException;
292    
293            /**
294            * Returns the d l sync event with the primary key or returns <code>null</code> if it could not be found.
295            *
296            * @param syncEventId the primary key of the d l sync event
297            * @return the d l sync event, or <code>null</code> if a d l sync event with the primary key could not be found
298            * @throws SystemException if a system exception occurred
299            */
300            public com.liferay.portlet.documentlibrary.model.DLSyncEvent fetchByPrimaryKey(
301                    long syncEventId)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            /**
305            * Returns all the d l sync events.
306            *
307            * @return the d l sync events
308            * @throws SystemException if a system exception occurred
309            */
310            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findAll()
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            /**
314            * Returns a range of all the d l sync events.
315            *
316            * <p>
317            * 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.portlet.documentlibrary.model.impl.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.
318            * </p>
319            *
320            * @param start the lower bound of the range of d l sync events
321            * @param end the upper bound of the range of d l sync events (not inclusive)
322            * @return the range of d l sync events
323            * @throws SystemException if a system exception occurred
324            */
325            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findAll(
326                    int start, int end)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            /**
330            * Returns an ordered range of all the d l sync events.
331            *
332            * <p>
333            * 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.portlet.documentlibrary.model.impl.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.
334            * </p>
335            *
336            * @param start the lower bound of the range of d l sync events
337            * @param end the upper bound of the range of d l sync events (not inclusive)
338            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
339            * @return the ordered range of d l sync events
340            * @throws SystemException if a system exception occurred
341            */
342            public java.util.List<com.liferay.portlet.documentlibrary.model.DLSyncEvent> findAll(
343                    int start, int end,
344                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    
347            /**
348            * Removes all the d l sync events from the database.
349            *
350            * @throws SystemException if a system exception occurred
351            */
352            public void removeAll()
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            /**
356            * Returns the number of d l sync events.
357            *
358            * @return the number of d l sync events
359            * @throws SystemException if a system exception occurred
360            */
361            public int countAll()
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    }