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