1   /**
2    * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.wiki.service;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="WikiPageLocalService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portlet.wiki.service.impl.WikiPageLocalServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface WikiPageLocalService {
57      public com.liferay.portlet.wiki.model.WikiPage addWikiPage(
58          com.liferay.portlet.wiki.model.WikiPage wikiPage)
59          throws com.liferay.portal.SystemException;
60  
61      public com.liferay.portlet.wiki.model.WikiPage createWikiPage(long pageId);
62  
63      public void deleteWikiPage(long pageId)
64          throws com.liferay.portal.SystemException,
65              com.liferay.portal.PortalException;
66  
67      public void deleteWikiPage(com.liferay.portlet.wiki.model.WikiPage wikiPage)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
72          throws com.liferay.portal.SystemException;
73  
74      public java.util.List<Object> dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portlet.wiki.model.WikiPage getWikiPage(long pageId)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getWikiPages(
85          int start, int end) throws com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getWikiPagesCount() throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portlet.wiki.model.WikiPage updateWikiPage(
91          com.liferay.portlet.wiki.model.WikiPage wikiPage)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portlet.wiki.model.WikiPage addPage(long userId,
95          long nodeId, java.lang.String title, java.lang.String content,
96          java.lang.String summary, boolean minorEdit,
97          javax.portlet.PortletPreferences prefs,
98          com.liferay.portal.theme.ThemeDisplay themeDisplay)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException;
101 
102     public com.liferay.portlet.wiki.model.WikiPage addPage(
103         java.lang.String uuid, long userId, long nodeId,
104         java.lang.String title, double version, java.lang.String content,
105         java.lang.String summary, boolean minorEdit, java.lang.String format,
106         boolean head, java.lang.String parentTitle,
107         java.lang.String redirectTitle, java.lang.String[] tagsEntries,
108         javax.portlet.PortletPreferences prefs,
109         com.liferay.portal.theme.ThemeDisplay themeDisplay)
110         throws com.liferay.portal.PortalException,
111             com.liferay.portal.SystemException;
112 
113     public void addPageAttachments(long nodeId, java.lang.String title,
114         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
115         throws com.liferay.portal.PortalException,
116             com.liferay.portal.SystemException;
117 
118     public void addPageResources(long nodeId, java.lang.String title,
119         boolean addCommunityPermissions, boolean addGuestPermissions)
120         throws com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException;
122 
123     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
124         com.liferay.portlet.wiki.model.WikiPage page,
125         boolean addCommunityPermissions, boolean addGuestPermissions)
126         throws com.liferay.portal.PortalException,
127             com.liferay.portal.SystemException;
128 
129     public void addPageResources(long nodeId, java.lang.String title,
130         java.lang.String[] communityPermissions,
131         java.lang.String[] guestPermissions)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
136         com.liferay.portlet.wiki.model.WikiPage page,
137         java.lang.String[] communityPermissions,
138         java.lang.String[] guestPermissions)
139         throws com.liferay.portal.PortalException,
140             com.liferay.portal.SystemException;
141 
142     public void changeParent(long userId, long nodeId, java.lang.String title,
143         java.lang.String newParentTitle,
144         javax.portlet.PortletPreferences prefs,
145         com.liferay.portal.theme.ThemeDisplay themeDisplay)
146         throws com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException;
148 
149     public void deletePage(long nodeId, java.lang.String title)
150         throws com.liferay.portal.PortalException,
151             com.liferay.portal.SystemException;
152 
153     public void deletePage(com.liferay.portlet.wiki.model.WikiPage page)
154         throws com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException;
156 
157     public void deletePageAttachment(long nodeId, java.lang.String title,
158         java.lang.String fileName)
159         throws com.liferay.portal.PortalException,
160             com.liferay.portal.SystemException;
161 
162     public void deletePages(long nodeId)
163         throws com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException;
165 
166     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
168         long nodeId, boolean head, java.lang.String parentTitle)
169         throws com.liferay.portal.SystemException;
170 
171     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getIncomingLinks(
173         long nodeId, java.lang.String title)
174         throws com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException;
176 
177     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNoAssetPages()
179         throws com.liferay.portal.SystemException;
180 
181     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
183         long nodeId)
184         throws com.liferay.portal.PortalException,
185             com.liferay.portal.SystemException;
186 
187     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOutgoingLinks(
189         long nodeId, java.lang.String title)
190         throws com.liferay.portal.PortalException,
191             com.liferay.portal.SystemException;
192 
193     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
194         java.lang.String title)
195         throws com.liferay.portal.PortalException,
196             com.liferay.portal.SystemException;
197 
198     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
199         java.lang.String title, double version)
200         throws com.liferay.portal.PortalException,
201             com.liferay.portal.SystemException;
202 
203     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204     public com.liferay.portlet.wiki.model.WikiPageDisplay getPageDisplay(
205         long nodeId, java.lang.String title,
206         javax.portlet.PortletURL viewPageURL,
207         javax.portlet.PortletURL editPageURL,
208         java.lang.String attachmentURLPrefix)
209         throws com.liferay.portal.PortalException,
210             com.liferay.portal.SystemException;
211 
212     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
214         long nodeId, int start, int end)
215         throws com.liferay.portal.SystemException;
216 
217     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
219         java.lang.String format) throws com.liferay.portal.SystemException;
220 
221     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
223         long nodeId, java.lang.String title, int start, int end)
224         throws com.liferay.portal.SystemException;
225 
226     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
228         long nodeId, java.lang.String title, int start, int end,
229         com.liferay.portal.kernel.util.OrderByComparator obc)
230         throws com.liferay.portal.SystemException;
231 
232     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
234         long nodeId, boolean head, int start, int end)
235         throws com.liferay.portal.SystemException;
236 
237     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
239         long nodeId, java.lang.String title, boolean head, int start, int end)
240         throws com.liferay.portal.SystemException;
241 
242     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243     public int getPagesCount(long nodeId)
244         throws com.liferay.portal.SystemException;
245 
246     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247     public int getPagesCount(long nodeId, java.lang.String title)
248         throws com.liferay.portal.SystemException;
249 
250     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251     public int getPagesCount(long nodeId, boolean head)
252         throws com.liferay.portal.SystemException;
253 
254     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255     public int getPagesCount(long nodeId, java.lang.String title, boolean head)
256         throws com.liferay.portal.SystemException;
257 
258     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
260         long nodeId, int start, int end)
261         throws com.liferay.portal.SystemException;
262 
263     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264     public int getRecentChangesCount(long nodeId)
265         throws com.liferay.portal.SystemException;
266 
267     public void movePage(long userId, long nodeId, java.lang.String title,
268         java.lang.String newTitle, javax.portlet.PortletPreferences prefs,
269         com.liferay.portal.theme.ThemeDisplay themeDisplay)
270         throws com.liferay.portal.PortalException,
271             com.liferay.portal.SystemException;
272 
273     public void movePage(long userId, long nodeId, java.lang.String title,
274         java.lang.String newTitle, boolean strict,
275         javax.portlet.PortletPreferences prefs,
276         com.liferay.portal.theme.ThemeDisplay themeDisplay)
277         throws com.liferay.portal.PortalException,
278             com.liferay.portal.SystemException;
279 
280     public com.liferay.portlet.wiki.model.WikiPage revertPage(long userId,
281         long nodeId, java.lang.String title, double version,
282         javax.portlet.PortletPreferences prefs,
283         com.liferay.portal.theme.ThemeDisplay themeDisplay)
284         throws com.liferay.portal.PortalException,
285             com.liferay.portal.SystemException;
286 
287     public void subscribePage(long userId, long nodeId, java.lang.String title)
288         throws com.liferay.portal.PortalException,
289             com.liferay.portal.SystemException;
290 
291     public void unsubscribePage(long userId, long nodeId, java.lang.String title)
292         throws com.liferay.portal.PortalException,
293             com.liferay.portal.SystemException;
294 
295     public com.liferay.portlet.wiki.model.WikiPage updatePage(long userId,
296         long nodeId, java.lang.String title, double version,
297         java.lang.String content, java.lang.String summary, boolean minorEdit,
298         java.lang.String format, java.lang.String parentTitle,
299         java.lang.String redirectTitle, java.lang.String[] tagsEntries,
300         javax.portlet.PortletPreferences prefs,
301         com.liferay.portal.theme.ThemeDisplay themeDisplay)
302         throws com.liferay.portal.PortalException,
303             com.liferay.portal.SystemException;
304 
305     public void updateTagsAsset(long userId,
306         com.liferay.portlet.wiki.model.WikiPage page,
307         java.lang.String[] tagsEntries)
308         throws com.liferay.portal.PortalException,
309             com.liferay.portal.SystemException;
310 
311     public void validateTitle(java.lang.String title)
312         throws com.liferay.portal.PortalException;
313 }