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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.security.ac.AccessControlled;
026    import com.liferay.portal.service.BaseService;
027    
028    /**
029     * Provides the remote service interface for WikiPage. Methods of this
030     * service are expected to have security checks based on the propagated JAAS
031     * credentials because this service can be accessed remotely.
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    @ProviderType
040    @AccessControlled
041    @JSONWebService
042    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
043            PortalException.class, SystemException.class})
044    public interface WikiPageService extends BaseService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * 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.
049             */
050    
051            /**
052            * Returns the Spring bean ID for this bean.
053            *
054            * @return the Spring bean ID for this bean
055            */
056            public java.lang.String getBeanIdentifier();
057    
058            /**
059            * Sets the Spring bean ID for this bean.
060            *
061            * @param beanIdentifier the Spring bean ID for this bean
062            */
063            public void setBeanIdentifier(java.lang.String beanIdentifier);
064    
065            public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
066                    java.lang.String title, java.lang.String content,
067                    java.lang.String summary, boolean minorEdit,
068                    com.liferay.portal.service.ServiceContext serviceContext)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException;
071    
072            public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
073                    java.lang.String title, java.lang.String content,
074                    java.lang.String summary, boolean minorEdit, java.lang.String format,
075                    java.lang.String parentTitle, java.lang.String redirectTitle,
076                    com.liferay.portal.service.ServiceContext serviceContext)
077                    throws com.liferay.portal.kernel.exception.PortalException,
078                            com.liferay.portal.kernel.exception.SystemException;
079    
080            public void addPageAttachment(long nodeId, java.lang.String title,
081                    java.lang.String fileName, java.io.File file, java.lang.String mimeType)
082                    throws com.liferay.portal.kernel.exception.PortalException,
083                            com.liferay.portal.kernel.exception.SystemException;
084    
085            public void addPageAttachment(long nodeId, java.lang.String title,
086                    java.lang.String fileName, java.io.InputStream inputStream,
087                    java.lang.String mimeType)
088                    throws com.liferay.portal.kernel.exception.PortalException,
089                            com.liferay.portal.kernel.exception.SystemException;
090    
091            public void addPageAttachments(long nodeId, java.lang.String title,
092                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String, java.io.InputStream>> inputStreamOVPs)
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException;
095    
096            public void addTempPageAttachment(long nodeId, java.lang.String fileName,
097                    java.lang.String tempFolderName, java.io.InputStream inputStream,
098                    java.lang.String mimeType)
099                    throws com.liferay.portal.kernel.exception.PortalException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            public void changeParent(long nodeId, java.lang.String title,
103                    java.lang.String newParentTitle,
104                    com.liferay.portal.service.ServiceContext serviceContext)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException;
107    
108            public void copyPageAttachments(long templateNodeId,
109                    java.lang.String templateTitle, long nodeId, java.lang.String title)
110                    throws com.liferay.portal.kernel.exception.PortalException,
111                            com.liferay.portal.kernel.exception.SystemException;
112    
113            public void deletePage(long nodeId, java.lang.String title)
114                    throws com.liferay.portal.kernel.exception.PortalException,
115                            com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * @deprecated As of 6.2.0 replaced by {@link #discardDraft(long, String,
119            double)}
120            */
121            public void deletePage(long nodeId, java.lang.String title, double version)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException;
124    
125            public void deletePageAttachment(long nodeId, java.lang.String title,
126                    java.lang.String fileName)
127                    throws com.liferay.portal.kernel.exception.PortalException,
128                            com.liferay.portal.kernel.exception.SystemException;
129    
130            public void deletePageAttachments(long nodeId, java.lang.String title)
131                    throws com.liferay.portal.kernel.exception.PortalException,
132                            com.liferay.portal.kernel.exception.SystemException;
133    
134            public void deleteTempPageAttachment(long nodeId,
135                    java.lang.String fileName, java.lang.String tempFolderName)
136                    throws com.liferay.portal.kernel.exception.PortalException,
137                            com.liferay.portal.kernel.exception.SystemException;
138    
139            public void deleteTrashPageAttachments(long nodeId, java.lang.String title)
140                    throws com.liferay.portal.kernel.exception.PortalException,
141                            com.liferay.portal.kernel.exception.SystemException;
142    
143            public void discardDraft(long nodeId, java.lang.String title, double version)
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 java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
149                    long groupId, long nodeId, boolean head, java.lang.String parentTitle)
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 com.liferay.portlet.wiki.model.WikiPage getDraftPage(long nodeId,
155                    java.lang.String title)
156                    throws com.liferay.portal.kernel.exception.PortalException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
161                    long nodeId, int max)
162                    throws com.liferay.portal.kernel.exception.PortalException,
163                            com.liferay.portal.kernel.exception.SystemException;
164    
165            /**
166            * @deprecated As of 6.2.0, replaced by {@link #getNodePagesRSS(long, int,
167            String, double, String, String, String, String)}
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public java.lang.String getNodePagesRSS(long nodeId, int max,
171                    java.lang.String type, double version, java.lang.String displayStyle,
172                    java.lang.String feedURL, java.lang.String entryURL)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException;
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public java.lang.String getNodePagesRSS(long nodeId, int max,
178                    java.lang.String type, double version, java.lang.String displayStyle,
179                    java.lang.String feedURL, java.lang.String entryURL,
180                    java.lang.String attachmentURLPrefix)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
186                    long groupId, long nodeId)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException;
189    
190            public com.liferay.portlet.wiki.model.WikiPage getPage(long groupId,
191                    long nodeId, java.lang.String title)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
196                    java.lang.String title)
197                    throws com.liferay.portal.kernel.exception.PortalException,
198                            com.liferay.portal.kernel.exception.SystemException;
199    
200            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
201                    java.lang.String title, java.lang.Boolean head)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException;
204    
205            public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
206                    java.lang.String title, double version)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException;
209    
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
212                    long groupId, long nodeId, boolean head, int status, int start,
213                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
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 java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
219                    long groupId, long nodeId, boolean head, long userId,
220                    boolean includeOwner, int status, int start, int end,
221                    com.liferay.portal.kernel.util.OrderByComparator obc)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
227                    long groupId, long userId, long nodeId, int status, int start, int end)
228                    throws com.liferay.portal.kernel.exception.PortalException,
229                            com.liferay.portal.kernel.exception.SystemException;
230    
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public int getPagesCount(long groupId, long nodeId, boolean head)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException;
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public int getPagesCount(long groupId, long nodeId, boolean head,
238                    long userId, boolean includeOwner, int status)
239                    throws com.liferay.portal.kernel.exception.PortalException,
240                            com.liferay.portal.kernel.exception.SystemException;
241    
242            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
243            public int getPagesCount(long groupId, long userId, long nodeId, int status)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            /**
248            * @deprecated As of 6.2.0, replaced by {@link #getPagesRSS(long, long,
249            String, int, String, double, String, String, String, String,
250            java.util.Locale)}
251            */
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public java.lang.String getPagesRSS(long companyId, long nodeId,
254                    java.lang.String title, int max, java.lang.String type, double version,
255                    java.lang.String displayStyle, java.lang.String feedURL,
256                    java.lang.String entryURL, java.util.Locale locale)
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 getPagesRSS(long companyId, long nodeId,
262                    java.lang.String title, int max, java.lang.String type, double version,
263                    java.lang.String displayStyle, java.lang.String feedURL,
264                    java.lang.String entryURL, java.lang.String attachmentURLPrefix,
265                    java.util.Locale locale)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
271                    long groupId, long nodeId, int start, int end)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public int getRecentChangesCount(long groupId, long nodeId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException;
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.lang.String[] getTempPageAttachmentNames(long nodeId,
282                    java.lang.String tempFolderName)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            public void movePage(long nodeId, java.lang.String title,
287                    java.lang.String newTitle,
288                    com.liferay.portal.service.ServiceContext serviceContext)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public com.liferay.portal.kernel.repository.model.FileEntry movePageAttachmentToTrash(
293                    long nodeId, java.lang.String title, java.lang.String fileName)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException;
296    
297            public com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
298                    long nodeId, java.lang.String title)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
303                    long nodeId, java.lang.String title, double version)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            public void restorePageAttachmentFromTrash(long nodeId,
308                    java.lang.String title, java.lang.String fileName)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            public void restorePageFromTrash(long resourcePrimKey)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            public com.liferay.portlet.wiki.model.WikiPage revertPage(long nodeId,
317                    java.lang.String title, double version,
318                    com.liferay.portal.service.ServiceContext serviceContext)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            public void subscribePage(long nodeId, java.lang.String title)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public void unsubscribePage(long nodeId, java.lang.String title)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            public com.liferay.portlet.wiki.model.WikiPage updatePage(long nodeId,
331                    java.lang.String title, double version, java.lang.String content,
332                    java.lang.String summary, boolean minorEdit, java.lang.String format,
333                    java.lang.String parentTitle, java.lang.String redirectTitle,
334                    com.liferay.portal.service.ServiceContext serviceContext)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    }