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