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  
26  /**
27   * <a href="WikiPageLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portlet.wiki.service.impl.WikiPageLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.wiki.service.WikiPageLocalServiceFactory
48   * @see com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil
49   *
50   */
51  public interface WikiPageLocalService {
52      public com.liferay.portlet.wiki.model.WikiPage addWikiPage(
53          com.liferay.portlet.wiki.model.WikiPage wikiPage)
54          throws com.liferay.portal.SystemException;
55  
56      public void deleteWikiPage(long pageId)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deleteWikiPage(com.liferay.portlet.wiki.model.WikiPage wikiPage)
61          throws com.liferay.portal.SystemException;
62  
63      public java.util.List<Object> dynamicQuery(
64          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
65          throws com.liferay.portal.SystemException;
66  
67      public java.util.List<Object> dynamicQuery(
68          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
69          int end) throws com.liferay.portal.SystemException;
70  
71      public com.liferay.portlet.wiki.model.WikiPage getWikiPage(long pageId)
72          throws com.liferay.portal.SystemException,
73              com.liferay.portal.PortalException;
74  
75      public com.liferay.portlet.wiki.model.WikiPage updateWikiPage(
76          com.liferay.portlet.wiki.model.WikiPage wikiPage)
77          throws com.liferay.portal.SystemException;
78  
79      public com.liferay.portlet.wiki.model.WikiPage addPage(long userId,
80          long nodeId, java.lang.String title, java.lang.String content,
81          java.lang.String summary, boolean minorEdit,
82          javax.portlet.PortletPreferences prefs,
83          com.liferay.portal.theme.ThemeDisplay themeDisplay)
84          throws com.liferay.portal.PortalException,
85              com.liferay.portal.SystemException;
86  
87      public com.liferay.portlet.wiki.model.WikiPage addPage(
88          java.lang.String uuid, long userId, long nodeId,
89          java.lang.String title, double version, java.lang.String content,
90          java.lang.String summary, boolean minorEdit, java.lang.String format,
91          boolean head, java.lang.String parentTitle,
92          java.lang.String redirectTitle, java.lang.String[] tagsEntries,
93          javax.portlet.PortletPreferences prefs,
94          com.liferay.portal.theme.ThemeDisplay themeDisplay)
95          throws com.liferay.portal.PortalException,
96              com.liferay.portal.SystemException;
97  
98      public void addPageAttachments(long nodeId, java.lang.String title,
99          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException;
102 
103     public void addPageResources(long nodeId, java.lang.String title,
104         boolean addCommunityPermissions, boolean addGuestPermissions)
105         throws com.liferay.portal.PortalException,
106             com.liferay.portal.SystemException;
107 
108     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
109         com.liferay.portlet.wiki.model.WikiPage page,
110         boolean addCommunityPermissions, boolean addGuestPermissions)
111         throws com.liferay.portal.PortalException,
112             com.liferay.portal.SystemException;
113 
114     public void addPageResources(long nodeId, java.lang.String title,
115         java.lang.String[] communityPermissions,
116         java.lang.String[] guestPermissions)
117         throws com.liferay.portal.PortalException,
118             com.liferay.portal.SystemException;
119 
120     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
121         com.liferay.portlet.wiki.model.WikiPage page,
122         java.lang.String[] communityPermissions,
123         java.lang.String[] guestPermissions)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void changeParent(long userId, long nodeId, java.lang.String title,
128         java.lang.String newParentTitle,
129         javax.portlet.PortletPreferences prefs,
130         com.liferay.portal.theme.ThemeDisplay themeDisplay)
131         throws com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException;
133 
134     public void deletePage(long nodeId, java.lang.String title)
135         throws com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public void deletePage(com.liferay.portlet.wiki.model.WikiPage page)
139         throws com.liferay.portal.PortalException,
140             com.liferay.portal.SystemException;
141 
142     public void deletePageAttachment(long nodeId, java.lang.String title,
143         java.lang.String fileName)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 
147     public void deletePages(long nodeId)
148         throws com.liferay.portal.PortalException,
149             com.liferay.portal.SystemException;
150 
151     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
152         long nodeId, boolean head, java.lang.String parentTitle)
153         throws com.liferay.portal.SystemException;
154 
155     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getIncomingLinks(
156         long nodeId, java.lang.String title)
157         throws com.liferay.portal.PortalException,
158             com.liferay.portal.SystemException;
159 
160     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNoAssetPages()
161         throws com.liferay.portal.SystemException;
162 
163     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
164         long nodeId)
165         throws com.liferay.portal.PortalException,
166             com.liferay.portal.SystemException;
167 
168     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOutgoingLinks(
169         long nodeId, java.lang.String title)
170         throws com.liferay.portal.PortalException,
171             com.liferay.portal.SystemException;
172 
173     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
174         java.lang.String title)
175         throws com.liferay.portal.PortalException,
176             com.liferay.portal.SystemException;
177 
178     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
179         java.lang.String title, double version)
180         throws com.liferay.portal.PortalException,
181             com.liferay.portal.SystemException;
182 
183     public com.liferay.portlet.wiki.model.WikiPageDisplay getPageDisplay(
184         long nodeId, java.lang.String title,
185         javax.portlet.PortletURL viewPageURL,
186         javax.portlet.PortletURL editPageURL,
187         java.lang.String attachmentURLPrefix)
188         throws com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException;
190 
191     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
192         long nodeId, int start, int end)
193         throws com.liferay.portal.SystemException;
194 
195     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
196         java.lang.String format) throws com.liferay.portal.SystemException;
197 
198     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
199         long nodeId, java.lang.String title, int start, int end)
200         throws com.liferay.portal.SystemException;
201 
202     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
203         long nodeId, java.lang.String title, int start, int end,
204         com.liferay.portal.kernel.util.OrderByComparator obc)
205         throws com.liferay.portal.SystemException;
206 
207     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
208         long nodeId, boolean head, int start, int end)
209         throws com.liferay.portal.SystemException;
210 
211     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
212         long nodeId, java.lang.String title, boolean head, int start, int end)
213         throws com.liferay.portal.SystemException;
214 
215     public int getPagesCount(long nodeId)
216         throws com.liferay.portal.SystemException;
217 
218     public int getPagesCount(long nodeId, java.lang.String title)
219         throws com.liferay.portal.SystemException;
220 
221     public int getPagesCount(long nodeId, boolean head)
222         throws com.liferay.portal.SystemException;
223 
224     public int getPagesCount(long nodeId, java.lang.String title, boolean head)
225         throws com.liferay.portal.SystemException;
226 
227     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
228         long nodeId, int start, int end)
229         throws com.liferay.portal.SystemException;
230 
231     public int getRecentChangesCount(long nodeId)
232         throws com.liferay.portal.SystemException;
233 
234     public void movePage(long userId, long nodeId, java.lang.String title,
235         java.lang.String newTitle, javax.portlet.PortletPreferences prefs,
236         com.liferay.portal.theme.ThemeDisplay themeDisplay)
237         throws com.liferay.portal.PortalException,
238             com.liferay.portal.SystemException;
239 
240     public void movePage(long userId, long nodeId, java.lang.String title,
241         java.lang.String newTitle, boolean strict,
242         javax.portlet.PortletPreferences prefs,
243         com.liferay.portal.theme.ThemeDisplay themeDisplay)
244         throws com.liferay.portal.PortalException,
245             com.liferay.portal.SystemException;
246 
247     public com.liferay.portlet.wiki.model.WikiPage revertPage(long userId,
248         long nodeId, java.lang.String title, double version,
249         javax.portlet.PortletPreferences prefs,
250         com.liferay.portal.theme.ThemeDisplay themeDisplay)
251         throws com.liferay.portal.PortalException,
252             com.liferay.portal.SystemException;
253 
254     public void subscribePage(long userId, long nodeId, java.lang.String title)
255         throws com.liferay.portal.PortalException,
256             com.liferay.portal.SystemException;
257 
258     public void unsubscribePage(long userId, long nodeId, java.lang.String title)
259         throws com.liferay.portal.PortalException,
260             com.liferay.portal.SystemException;
261 
262     public com.liferay.portlet.wiki.model.WikiPage updatePage(long userId,
263         long nodeId, java.lang.String title, double version,
264         java.lang.String content, java.lang.String summary, boolean minorEdit,
265         java.lang.String format, java.lang.String parentTitle,
266         java.lang.String redirectTitle, java.lang.String[] tagsEntries,
267         javax.portlet.PortletPreferences prefs,
268         com.liferay.portal.theme.ThemeDisplay themeDisplay)
269         throws com.liferay.portal.PortalException,
270             com.liferay.portal.SystemException;
271 
272     public void updateTagsAsset(long userId,
273         com.liferay.portlet.wiki.model.WikiPage page,
274         java.lang.String[] tagsEntries)
275         throws com.liferay.portal.PortalException,
276             com.liferay.portal.SystemException;
277 
278     public void validateTitle(java.lang.String title)
279         throws com.liferay.portal.PortalException;
280 }