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