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