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