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