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