1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.wiki.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="WikiPageLocalService.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This interface defines the service. The default implementation is
37   * <code>com.liferay.portlet.wiki.service.impl.WikiPageLocalServiceImpl</code>.
38   * Modify methods in that class and rerun ServiceBuilder to populate this class
39   * and all other generated classes.
40   * </p>
41   *
42   * <p>
43   * 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.
44   * </p>
45   *
46   * @author Brian Wing Shun Chan
47   *
48   * @see com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil
49   *
50   */
51  @Transactional(rollbackFor =  {
52      PortalException.class, SystemException.class})
53  public interface WikiPageLocalService {
54      public com.liferay.portlet.wiki.model.WikiPage addWikiPage(
55          com.liferay.portlet.wiki.model.WikiPage wikiPage)
56          throws com.liferay.portal.SystemException;
57  
58      public com.liferay.portlet.wiki.model.WikiPage createWikiPage(long pageId);
59  
60      public void deleteWikiPage(long pageId)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public void deleteWikiPage(com.liferay.portlet.wiki.model.WikiPage wikiPage)
65          throws com.liferay.portal.SystemException;
66  
67      public java.util.List<Object> dynamicQuery(
68          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
69          throws com.liferay.portal.SystemException;
70  
71      public java.util.List<Object> dynamicQuery(
72          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
73          int end) throws com.liferay.portal.SystemException;
74  
75      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
76      public com.liferay.portlet.wiki.model.WikiPage getWikiPage(long pageId)
77          throws com.liferay.portal.SystemException,
78              com.liferay.portal.PortalException;
79  
80      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
81      public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getWikiPages(
82          int start, int end) throws com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public int getWikiPagesCount() throws com.liferay.portal.SystemException;
86  
87      public com.liferay.portlet.wiki.model.WikiPage updateWikiPage(
88          com.liferay.portlet.wiki.model.WikiPage wikiPage)
89          throws com.liferay.portal.SystemException;
90  
91      public com.liferay.portlet.wiki.model.WikiPage addPage(long userId,
92          long nodeId, java.lang.String title, java.lang.String content,
93          java.lang.String summary, boolean minorEdit,
94          javax.portlet.PortletPreferences prefs,
95          com.liferay.portal.theme.ThemeDisplay themeDisplay)
96          throws com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public com.liferay.portlet.wiki.model.WikiPage addPage(
100         java.lang.String uuid, long userId, long nodeId,
101         java.lang.String title, double version, java.lang.String content,
102         java.lang.String summary, boolean minorEdit, java.lang.String format,
103         boolean head, java.lang.String parentTitle,
104         java.lang.String redirectTitle, java.lang.String[] tagsEntries,
105         javax.portlet.PortletPreferences prefs,
106         com.liferay.portal.theme.ThemeDisplay themeDisplay)
107         throws com.liferay.portal.PortalException,
108             com.liferay.portal.SystemException;
109 
110     public void addPageAttachments(long nodeId, java.lang.String title,
111         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public void addPageResources(long nodeId, java.lang.String title,
116         boolean addCommunityPermissions, boolean addGuestPermissions)
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         boolean addCommunityPermissions, boolean addGuestPermissions)
123         throws com.liferay.portal.PortalException,
124             com.liferay.portal.SystemException;
125 
126     public void addPageResources(long nodeId, java.lang.String title,
127         java.lang.String[] communityPermissions,
128         java.lang.String[] guestPermissions)
129         throws com.liferay.portal.PortalException,
130             com.liferay.portal.SystemException;
131 
132     public void addPageResources(com.liferay.portlet.wiki.model.WikiNode node,
133         com.liferay.portlet.wiki.model.WikiPage page,
134         java.lang.String[] communityPermissions,
135         java.lang.String[] guestPermissions)
136         throws com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException;
138 
139     public void changeParent(long userId, long nodeId, java.lang.String title,
140         java.lang.String newParentTitle,
141         javax.portlet.PortletPreferences prefs,
142         com.liferay.portal.theme.ThemeDisplay themeDisplay)
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, javax.portlet.PortletPreferences prefs,
266         com.liferay.portal.theme.ThemeDisplay themeDisplay)
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         javax.portlet.PortletPreferences prefs,
273         com.liferay.portal.theme.ThemeDisplay themeDisplay)
274         throws com.liferay.portal.PortalException,
275             com.liferay.portal.SystemException;
276 
277     public com.liferay.portlet.wiki.model.WikiPage revertPage(long userId,
278         long nodeId, java.lang.String title, double version,
279         javax.portlet.PortletPreferences prefs,
280         com.liferay.portal.theme.ThemeDisplay themeDisplay)
281         throws com.liferay.portal.PortalException,
282             com.liferay.portal.SystemException;
283 
284     public void subscribePage(long userId, long nodeId, java.lang.String title)
285         throws com.liferay.portal.PortalException,
286             com.liferay.portal.SystemException;
287 
288     public void unsubscribePage(long userId, long nodeId, java.lang.String title)
289         throws com.liferay.portal.PortalException,
290             com.liferay.portal.SystemException;
291 
292     public com.liferay.portlet.wiki.model.WikiPage updatePage(long userId,
293         long nodeId, java.lang.String title, double version,
294         java.lang.String content, java.lang.String summary, boolean minorEdit,
295         java.lang.String format, java.lang.String parentTitle,
296         java.lang.String redirectTitle, java.lang.String[] tagsEntries,
297         javax.portlet.PortletPreferences prefs,
298         com.liferay.portal.theme.ThemeDisplay themeDisplay)
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[] 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 }