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  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="WikiPageService.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.WikiPageServiceImpl</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 remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portlet.wiki.service.WikiPageServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface WikiPageService {
57      public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
58          java.lang.String title, java.lang.String content,
59          java.lang.String summary, boolean minorEdit,
60          javax.portlet.PortletPreferences prefs,
61          com.liferay.portal.theme.ThemeDisplay themeDisplay)
62          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
63              com.liferay.portal.SystemException;
64  
65      public void addPageAttachments(long nodeId, java.lang.String title,
66          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
67          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
68              com.liferay.portal.SystemException;
69  
70      public void changeParent(long nodeId, java.lang.String title,
71          java.lang.String newParentTitle,
72          javax.portlet.PortletPreferences prefs,
73          com.liferay.portal.theme.ThemeDisplay themeDisplay)
74          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
75              com.liferay.portal.SystemException;
76  
77      public void deletePage(long nodeId, java.lang.String title)
78          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
79              com.liferay.portal.SystemException;
80  
81      public void deletePageAttachment(long nodeId, java.lang.String title,
82          java.lang.String fileName)
83          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
84              com.liferay.portal.SystemException;
85  
86      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
87      public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
88          long nodeId, int max)
89          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException;
91  
92      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
93      public java.lang.String getNodePagesRSS(long nodeId, int max,
94          java.lang.String type, double version, java.lang.String displayStyle,
95          java.lang.String feedURL, java.lang.String entryURL)
96          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
97              com.liferay.portal.SystemException;
98  
99      public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
100         java.lang.String title)
101         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
102             com.liferay.portal.SystemException;
103 
104     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
105         java.lang.String title, double version)
106         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
107             com.liferay.portal.SystemException;
108 
109     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110     public java.lang.String getPagesRSS(long companyId, long nodeId,
111         java.lang.String title, int max, java.lang.String type, double version,
112         java.lang.String displayStyle, java.lang.String feedURL,
113         java.lang.String entryURL, java.util.Locale locale)
114         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
115             com.liferay.portal.SystemException;
116 
117     public void movePage(long nodeId, java.lang.String title,
118         java.lang.String newTitle, javax.portlet.PortletPreferences prefs,
119         com.liferay.portal.theme.ThemeDisplay themeDisplay)
120         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
121             com.liferay.portal.SystemException;
122 
123     public com.liferay.portlet.wiki.model.WikiPage revertPage(long nodeId,
124         java.lang.String title, double version,
125         javax.portlet.PortletPreferences prefs,
126         com.liferay.portal.theme.ThemeDisplay themeDisplay)
127         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
128             com.liferay.portal.SystemException;
129 
130     public void subscribePage(long nodeId, java.lang.String title)
131         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
132             com.liferay.portal.SystemException;
133 
134     public void unsubscribePage(long nodeId, java.lang.String title)
135         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException;
137 
138     public com.liferay.portlet.wiki.model.WikiPage updatePage(long nodeId,
139         java.lang.String title, double version, java.lang.String content,
140         java.lang.String summary, boolean minorEdit, java.lang.String format,
141         java.lang.String parentTitle, java.lang.String redirectTitle,
142         java.lang.String[] tagsEntries, javax.portlet.PortletPreferences prefs,
143         com.liferay.portal.theme.ThemeDisplay themeDisplay)
144         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException;
146 }