001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.wiki.service;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
020    import com.liferay.portal.kernel.transaction.Isolation;
021    import com.liferay.portal.kernel.transaction.Propagation;
022    import com.liferay.portal.kernel.transaction.Transactional;
023    import com.liferay.portal.security.ac.AccessControlled;
024    import com.liferay.portal.service.BaseService;
025    
026    /**
027     * The interface for the wiki page remote service.
028     *
029     * <p>
030     * 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.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see WikiPageServiceUtil
035     * @see com.liferay.portlet.wiki.service.base.WikiPageServiceBaseImpl
036     * @see com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface WikiPageService extends BaseService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. Always use {@link WikiPageServiceUtil} to access the wiki page remote service. Add custom service methods to {@link com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
048             */
049    
050            /**
051            * Returns the Spring bean ID for this bean.
052            *
053            * @return the Spring bean ID for this bean
054            */
055            public java.lang.String getBeanIdentifier();
056    
057            /**
058            * Sets the Spring bean ID for this bean.
059            *
060            * @param beanIdentifier the Spring bean ID for this bean
061            */
062            public void setBeanIdentifier(java.lang.String beanIdentifier);
063    
064            public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
065                    java.lang.String title, java.lang.String content,
066                    java.lang.String summary, boolean minorEdit,
067                    com.liferay.portal.service.ServiceContext serviceContext)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException;
070    
071            public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
072                    java.lang.String title, java.lang.String content,
073                    java.lang.String summary, boolean minorEdit, java.lang.String format,
074                    java.lang.String parentTitle, java.lang.String redirectTitle,
075                    com.liferay.portal.service.ServiceContext serviceContext)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
078    
079            public void addPageAttachment(long nodeId, java.lang.String title,
080                    java.lang.String fileName, java.io.File file, java.lang.String mimeType)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            public void addPageAttachment(long nodeId, java.lang.String title,
085                    java.lang.String fileName, java.io.InputStream inputStream,
086                    java.lang.String mimeType)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException;
089    
090            public void addPageAttachments(long nodeId, java.lang.String title,
091                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String, java.io.InputStream>> inputStreamOVPs)
092                    throws com.liferay.portal.kernel.exception.PortalException,
093                            com.liferay.portal.kernel.exception.SystemException;
094    
095            public void addTempPageAttachment(long nodeId, java.lang.String fileName,
096                    java.lang.String tempFolderName, java.io.InputStream inputStream,
097                    java.lang.String mimeType)
098                    throws com.liferay.portal.kernel.exception.PortalException,
099                            com.liferay.portal.kernel.exception.SystemException;
100    
101            public void changeParent(long nodeId, java.lang.String title,
102                    java.lang.String newParentTitle,
103                    com.liferay.portal.service.ServiceContext serviceContext)
104                    throws com.liferay.portal.kernel.exception.PortalException,
105                            com.liferay.portal.kernel.exception.SystemException;
106    
107            public void deletePage(long nodeId, java.lang.String title)
108                    throws com.liferay.portal.kernel.exception.PortalException,
109                            com.liferay.portal.kernel.exception.SystemException;
110    
111            /**
112            * @deprecated As of 6.2.0 replaced by {@link #discardDraft(long, String,
113            double)}
114            */
115            public void deletePage(long nodeId, java.lang.String title, double version)
116                    throws com.liferay.portal.kernel.exception.PortalException,
117                            com.liferay.portal.kernel.exception.SystemException;
118    
119            public void deletePageAttachment(long nodeId, java.lang.String title,
120                    java.lang.String fileName)
121                    throws com.liferay.portal.kernel.exception.PortalException,
122                            com.liferay.portal.kernel.exception.SystemException;
123    
124            public void deletePageAttachments(long nodeId, java.lang.String title)
125                    throws com.liferay.portal.kernel.exception.PortalException,
126                            com.liferay.portal.kernel.exception.SystemException;
127    
128            public void deleteTempPageAttachment(long nodeId,
129                    java.lang.String fileName, java.lang.String tempFolderName)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            public void deleteTrashPageAttachments(long nodeId, java.lang.String title)
134                    throws com.liferay.portal.kernel.exception.PortalException,
135                            com.liferay.portal.kernel.exception.SystemException;
136    
137            public void discardDraft(long nodeId, java.lang.String title, double version)
138                    throws com.liferay.portal.kernel.exception.PortalException,
139                            com.liferay.portal.kernel.exception.SystemException;
140    
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
143                    long groupId, long nodeId, boolean head, java.lang.String parentTitle)
144                    throws com.liferay.portal.kernel.exception.PortalException,
145                            com.liferay.portal.kernel.exception.SystemException;
146    
147            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
148            public com.liferay.portlet.wiki.model.WikiPage getDraftPage(long nodeId,
149                    java.lang.String title)
150                    throws com.liferay.portal.kernel.exception.PortalException,
151                            com.liferay.portal.kernel.exception.SystemException;
152    
153            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
155                    long nodeId, int max)
156                    throws com.liferay.portal.kernel.exception.PortalException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            /**
160            * @deprecated As of 6.2.0, replaced by {@link #getNodePagesRSS(long, int,
161            String, double, String, String, String, String)}
162            */
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public java.lang.String getNodePagesRSS(long nodeId, int max,
165                    java.lang.String type, double version, java.lang.String displayStyle,
166                    java.lang.String feedURL, java.lang.String entryURL)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public java.lang.String getNodePagesRSS(long nodeId, int max,
172                    java.lang.String type, double version, java.lang.String displayStyle,
173                    java.lang.String feedURL, java.lang.String entryURL,
174                    java.lang.String attachmentURLPrefix)
175                    throws com.liferay.portal.kernel.exception.PortalException,
176                            com.liferay.portal.kernel.exception.SystemException;
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
180                    long groupId, long nodeId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            public com.liferay.portlet.wiki.model.WikiPage getPage(long groupId,
185                    long nodeId, java.lang.String title)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
190                    java.lang.String title)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException;
193    
194            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
195                    java.lang.String title, java.lang.Boolean head)
196                    throws com.liferay.portal.kernel.exception.PortalException,
197                            com.liferay.portal.kernel.exception.SystemException;
198    
199            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
200                    java.lang.String title, double version)
201                    throws com.liferay.portal.kernel.exception.PortalException,
202                            com.liferay.portal.kernel.exception.SystemException;
203    
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
206                    long groupId, long nodeId, boolean head, int status, int start,
207                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException;
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
213                    long groupId, long userId, long nodeId, int status, int start, int end)
214                    throws com.liferay.portal.kernel.exception.PortalException,
215                            com.liferay.portal.kernel.exception.SystemException;
216    
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public int getPagesCount(long groupId, long nodeId, boolean head)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223            public int getPagesCount(long groupId, long userId, long nodeId, int status)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * @deprecated As of 6.2.0, replaced by {@link #getPagesRSS(long, long,
229            String, int, String, double, String, String, String, String,
230            java.util.Locale)}
231            */
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public java.lang.String getPagesRSS(long companyId, long nodeId,
234                    java.lang.String title, int max, java.lang.String type, double version,
235                    java.lang.String displayStyle, java.lang.String feedURL,
236                    java.lang.String entryURL, java.util.Locale locale)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException;
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public java.lang.String getPagesRSS(long companyId, long nodeId,
242                    java.lang.String title, int max, java.lang.String type, double version,
243                    java.lang.String displayStyle, java.lang.String feedURL,
244                    java.lang.String entryURL, java.lang.String attachmentURLPrefix,
245                    java.util.Locale locale)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException;
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
251                    long groupId, long nodeId, int start, int end)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256            public int getRecentChangesCount(long groupId, long nodeId)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public java.lang.String[] getTempPageAttachmentNames(long nodeId,
262                    java.lang.String tempFolderName)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void movePage(long nodeId, java.lang.String title,
267                    java.lang.String newTitle,
268                    com.liferay.portal.service.ServiceContext serviceContext)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException;
271    
272            public long movePageAttachmentToTrash(long nodeId, java.lang.String title,
273                    java.lang.String fileName)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void movePageToTrash(long nodeId, java.lang.String title)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            public void movePageToTrash(long nodeId, java.lang.String title,
282                    double version)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            public void restorePageAttachmentFromTrash(long nodeId,
287                    java.lang.String title, java.lang.String fileName)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void restorePageFromTrash(long resourcePrimKey)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public com.liferay.portlet.wiki.model.WikiPage revertPage(long nodeId,
296                    java.lang.String title, double version,
297                    com.liferay.portal.service.ServiceContext serviceContext)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            public void subscribePage(long nodeId, java.lang.String title)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException;
304    
305            public void unsubscribePage(long nodeId, java.lang.String title)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            public com.liferay.portlet.wiki.model.WikiPage updatePage(long nodeId,
310                    java.lang.String title, double version, java.lang.String content,
311                    java.lang.String summary, boolean minorEdit, java.lang.String format,
312                    java.lang.String parentTitle, java.lang.String redirectTitle,
313                    com.liferay.portal.service.ServiceContext serviceContext)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException;
316    }