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