1   /**
2    * Copyright (c) 2000-2009 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          com.liferay.portal.service.ServiceContext serviceContext)
98          throws com.liferay.portal.PortalException,
99              com.liferay.portal.SystemException;
100 
101     public com.liferay.portlet.wiki.model.WikiPage addPage(
102         java.lang.String uuid, long userId, long nodeId,
103         java.lang.String title, double version, java.lang.String content,
104         java.lang.String summary, boolean minorEdit, java.lang.String format,
105         boolean head, java.lang.String parentTitle,
106         java.lang.String redirectTitle,
107         com.liferay.portal.service.ServiceContext serviceContext)
108         throws com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException;
110 
111     public void addPageAttachments(long nodeId, java.lang.String title,
112         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
113         throws com.liferay.portal.PortalException,
114             com.liferay.portal.SystemException;
115 
116     public void addPageResources(long nodeId, java.lang.String title,
117         boolean addCommunityPermissions, boolean addGuestPermissions)
118         throws com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException;
120 
121     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
122         com.liferay.portlet.wiki.model.WikiPage page,
123         boolean addCommunityPermissions, boolean addGuestPermissions)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void addPageResources(long nodeId, java.lang.String title,
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 addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
134         com.liferay.portlet.wiki.model.WikiPage page,
135         java.lang.String[] communityPermissions,
136         java.lang.String[] guestPermissions)
137         throws com.liferay.portal.PortalException,
138             com.liferay.portal.SystemException;
139 
140     public void changeParent(long userId, long nodeId, java.lang.String title,
141         java.lang.String newParentTitle,
142         com.liferay.portal.service.ServiceContext serviceContext)
143         throws com.liferay.portal.PortalException,
144             com.liferay.portal.SystemException;
145 
146     public void deletePage(long nodeId, java.lang.String title)
147         throws com.liferay.portal.PortalException,
148             com.liferay.portal.SystemException;
149 
150     public void deletePage(com.liferay.portlet.wiki.model.WikiPage page)
151         throws com.liferay.portal.PortalException,
152             com.liferay.portal.SystemException;
153 
154     public void deletePageAttachment(long nodeId, java.lang.String title,
155         java.lang.String fileName)
156         throws com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException;
158 
159     public void deletePages(long nodeId)
160         throws com.liferay.portal.PortalException,
161             com.liferay.portal.SystemException;
162 
163     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
165         long nodeId, boolean head, java.lang.String parentTitle)
166         throws com.liferay.portal.SystemException;
167 
168     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getIncomingLinks(
170         long nodeId, java.lang.String title)
171         throws com.liferay.portal.PortalException,
172             com.liferay.portal.SystemException;
173 
174     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNoAssetPages()
176         throws com.liferay.portal.SystemException;
177 
178     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
180         long nodeId)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException;
183 
184     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOutgoingLinks(
186         long nodeId, java.lang.String title)
187         throws com.liferay.portal.PortalException,
188             com.liferay.portal.SystemException;
189 
190     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
191         java.lang.String title)
192         throws com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException;
194 
195     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
196         java.lang.String title, double version)
197         throws com.liferay.portal.PortalException,
198             com.liferay.portal.SystemException;
199 
200     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201     public com.liferay.portlet.wiki.model.WikiPageDisplay getPageDisplay(
202         long nodeId, java.lang.String title,
203         javax.portlet.PortletURL viewPageURL,
204         javax.portlet.PortletURL editPageURL,
205         java.lang.String attachmentURLPrefix)
206         throws com.liferay.portal.PortalException,
207             com.liferay.portal.SystemException;
208 
209     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
211         long nodeId, int start, int end)
212         throws com.liferay.portal.SystemException;
213 
214     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
216         java.lang.String format) throws com.liferay.portal.SystemException;
217 
218     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
220         long nodeId, java.lang.String title, int start, int end)
221         throws com.liferay.portal.SystemException;
222 
223     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
224     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
225         long nodeId, java.lang.String title, int start, int end,
226         com.liferay.portal.kernel.util.OrderByComparator obc)
227         throws com.liferay.portal.SystemException;
228 
229     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
231         long nodeId, boolean head, int start, int end)
232         throws com.liferay.portal.SystemException;
233 
234     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
236         long nodeId, java.lang.String title, boolean head, int start, int end)
237         throws com.liferay.portal.SystemException;
238 
239     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240     public int getPagesCount(long nodeId)
241         throws com.liferay.portal.SystemException;
242 
243     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244     public int getPagesCount(long nodeId, java.lang.String title)
245         throws com.liferay.portal.SystemException;
246 
247     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248     public int getPagesCount(long nodeId, boolean head)
249         throws com.liferay.portal.SystemException;
250 
251     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252     public int getPagesCount(long nodeId, java.lang.String title, boolean head)
253         throws com.liferay.portal.SystemException;
254 
255     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256     public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
257         long nodeId, int start, int end)
258         throws com.liferay.portal.SystemException;
259 
260     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261     public int getRecentChangesCount(long nodeId)
262         throws com.liferay.portal.SystemException;
263 
264     public void movePage(long userId, long nodeId, java.lang.String title,
265         java.lang.String newTitle,
266         com.liferay.portal.service.ServiceContext serviceContext)
267         throws com.liferay.portal.PortalException,
268             com.liferay.portal.SystemException;
269 
270     public void movePage(long userId, long nodeId, java.lang.String title,
271         java.lang.String newTitle, boolean strict,
272         com.liferay.portal.service.ServiceContext serviceContext)
273         throws com.liferay.portal.PortalException,
274             com.liferay.portal.SystemException;
275 
276     public void reIndex(long resourcePrimKey)
277         throws com.liferay.portal.SystemException;
278 
279     public com.liferay.portlet.wiki.model.WikiPage revertPage(long userId,
280         long nodeId, java.lang.String title, double version,
281         com.liferay.portal.service.ServiceContext serviceContext)
282         throws com.liferay.portal.PortalException,
283             com.liferay.portal.SystemException;
284 
285     public void subscribePage(long userId, long nodeId, java.lang.String title)
286         throws com.liferay.portal.PortalException,
287             com.liferay.portal.SystemException;
288 
289     public void unsubscribePage(long userId, long nodeId, java.lang.String title)
290         throws com.liferay.portal.PortalException,
291             com.liferay.portal.SystemException;
292 
293     public com.liferay.portlet.wiki.model.WikiPage updatePage(long userId,
294         long nodeId, java.lang.String title, double version,
295         java.lang.String content, java.lang.String summary, boolean minorEdit,
296         java.lang.String format, java.lang.String parentTitle,
297         java.lang.String redirectTitle,
298         com.liferay.portal.service.ServiceContext serviceContext)
299         throws com.liferay.portal.PortalException,
300             com.liferay.portal.SystemException;
301 
302     public void updateTagsAsset(long userId,
303         com.liferay.portlet.wiki.model.WikiPage page,
304         java.lang.String[] tagsCategories, java.lang.String[] tagsEntries)
305         throws com.liferay.portal.PortalException,
306             com.liferay.portal.SystemException;
307 
308     public void validateTitle(java.lang.String title)
309         throws com.liferay.portal.PortalException;
310 }