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.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the remote service utility for WikiPage. This utility wraps
024     * {@link com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on a remote server. Methods of this service are expected to have security
027     * checks based on the propagated JAAS credentials because this service can be
028     * accessed remotely.
029     *
030     * @author Brian Wing Shun Chan
031     * @see WikiPageService
032     * @see com.liferay.portlet.wiki.service.base.WikiPageServiceBaseImpl
033     * @see com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class WikiPageServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Returns the Spring bean ID for this bean.
046            *
047            * @return the Spring bean ID for this bean
048            */
049            public static java.lang.String getBeanIdentifier() {
050                    return getService().getBeanIdentifier();
051            }
052    
053            /**
054            * Sets the Spring bean ID for this bean.
055            *
056            * @param beanIdentifier the Spring bean ID for this bean
057            */
058            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
059                    getService().setBeanIdentifier(beanIdentifier);
060            }
061    
062            public static 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                    return getService()
069                                       .addPage(nodeId, title, content, summary, minorEdit,
070                            serviceContext);
071            }
072    
073            public static com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
074                    java.lang.String title, java.lang.String content,
075                    java.lang.String summary, boolean minorEdit, java.lang.String format,
076                    java.lang.String parentTitle, java.lang.String redirectTitle,
077                    com.liferay.portal.service.ServiceContext serviceContext)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService()
081                                       .addPage(nodeId, title, content, summary, minorEdit, format,
082                            parentTitle, redirectTitle, serviceContext);
083            }
084    
085            public static void addPageAttachment(long nodeId, java.lang.String title,
086                    java.lang.String fileName, java.io.File file, java.lang.String mimeType)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException {
089                    getService().addPageAttachment(nodeId, title, fileName, file, mimeType);
090            }
091    
092            public static void addPageAttachment(long nodeId, java.lang.String title,
093                    java.lang.String fileName, java.io.InputStream inputStream,
094                    java.lang.String mimeType)
095                    throws com.liferay.portal.kernel.exception.PortalException,
096                            com.liferay.portal.kernel.exception.SystemException {
097                    getService()
098                            .addPageAttachment(nodeId, title, fileName, inputStream, mimeType);
099            }
100    
101            public static void addPageAttachments(long nodeId, java.lang.String title,
102                    java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String, java.io.InputStream>> inputStreamOVPs)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException {
105                    getService().addPageAttachments(nodeId, title, inputStreamOVPs);
106            }
107    
108            public static void addTempPageAttachment(long nodeId,
109                    java.lang.String fileName, java.lang.String tempFolderName,
110                    java.io.InputStream inputStream, java.lang.String mimeType)
111                    throws com.liferay.portal.kernel.exception.PortalException,
112                            com.liferay.portal.kernel.exception.SystemException {
113                    getService()
114                            .addTempPageAttachment(nodeId, fileName, tempFolderName,
115                            inputStream, mimeType);
116            }
117    
118            public static void changeParent(long nodeId, java.lang.String title,
119                    java.lang.String newParentTitle,
120                    com.liferay.portal.service.ServiceContext serviceContext)
121                    throws com.liferay.portal.kernel.exception.PortalException,
122                            com.liferay.portal.kernel.exception.SystemException {
123                    getService().changeParent(nodeId, title, newParentTitle, serviceContext);
124            }
125    
126            public static void copyPageAttachments(long templateNodeId,
127                    java.lang.String templateTitle, long nodeId, java.lang.String title)
128                    throws com.liferay.portal.kernel.exception.PortalException,
129                            com.liferay.portal.kernel.exception.SystemException {
130                    getService()
131                            .copyPageAttachments(templateNodeId, templateTitle, nodeId, title);
132            }
133    
134            public static void deletePage(long nodeId, java.lang.String title)
135                    throws com.liferay.portal.kernel.exception.PortalException,
136                            com.liferay.portal.kernel.exception.SystemException {
137                    getService().deletePage(nodeId, title);
138            }
139    
140            /**
141            * @deprecated As of 6.2.0 replaced by {@link #discardDraft(long, String,
142            double)}
143            */
144            public static void deletePage(long nodeId, java.lang.String title,
145                    double version)
146                    throws com.liferay.portal.kernel.exception.PortalException,
147                            com.liferay.portal.kernel.exception.SystemException {
148                    getService().deletePage(nodeId, title, version);
149            }
150    
151            public static void deletePageAttachment(long nodeId,
152                    java.lang.String title, java.lang.String fileName)
153                    throws com.liferay.portal.kernel.exception.PortalException,
154                            com.liferay.portal.kernel.exception.SystemException {
155                    getService().deletePageAttachment(nodeId, title, fileName);
156            }
157    
158            public static void deletePageAttachments(long nodeId, java.lang.String title)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException {
161                    getService().deletePageAttachments(nodeId, title);
162            }
163    
164            public static void deleteTempPageAttachment(long nodeId,
165                    java.lang.String fileName, java.lang.String tempFolderName)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException {
168                    getService().deleteTempPageAttachment(nodeId, fileName, tempFolderName);
169            }
170    
171            public static void deleteTrashPageAttachments(long nodeId,
172                    java.lang.String title)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException {
175                    getService().deleteTrashPageAttachments(nodeId, title);
176            }
177    
178            public static void discardDraft(long nodeId, java.lang.String title,
179                    double version)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException {
182                    getService().discardDraft(nodeId, title, version);
183            }
184    
185            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
186                    long groupId, long nodeId, boolean head, java.lang.String parentTitle)
187                    throws com.liferay.portal.kernel.exception.PortalException,
188                            com.liferay.portal.kernel.exception.SystemException {
189                    return getService().getChildren(groupId, nodeId, head, parentTitle);
190            }
191    
192            public static com.liferay.portlet.wiki.model.WikiPage getDraftPage(
193                    long nodeId, java.lang.String title)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException {
196                    return getService().getDraftPage(nodeId, title);
197            }
198    
199            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
200                    long nodeId, int max)
201                    throws com.liferay.portal.kernel.exception.PortalException,
202                            com.liferay.portal.kernel.exception.SystemException {
203                    return getService().getNodePages(nodeId, max);
204            }
205    
206            /**
207            * @deprecated As of 6.2.0, replaced by {@link #getNodePagesRSS(long, int,
208            String, double, String, String, String, String)}
209            */
210            public static java.lang.String getNodePagesRSS(long nodeId, int max,
211                    java.lang.String type, double version, java.lang.String displayStyle,
212                    java.lang.String feedURL, java.lang.String entryURL)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException {
215                    return getService()
216                                       .getNodePagesRSS(nodeId, max, type, version, displayStyle,
217                            feedURL, entryURL);
218            }
219    
220            public static java.lang.String getNodePagesRSS(long nodeId, int max,
221                    java.lang.String type, double version, java.lang.String displayStyle,
222                    java.lang.String feedURL, java.lang.String entryURL,
223                    java.lang.String attachmentURLPrefix)
224                    throws com.liferay.portal.kernel.exception.PortalException,
225                            com.liferay.portal.kernel.exception.SystemException {
226                    return getService()
227                                       .getNodePagesRSS(nodeId, max, type, version, displayStyle,
228                            feedURL, entryURL, attachmentURLPrefix);
229            }
230    
231            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
232                    long groupId, long nodeId)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException {
235                    return getService().getOrphans(groupId, nodeId);
236            }
237    
238            public static com.liferay.portlet.wiki.model.WikiPage getPage(
239                    long groupId, long nodeId, java.lang.String title)
240                    throws com.liferay.portal.kernel.exception.PortalException,
241                            com.liferay.portal.kernel.exception.SystemException {
242                    return getService().getPage(groupId, nodeId, title);
243            }
244    
245            public static com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
246                    java.lang.String title)
247                    throws com.liferay.portal.kernel.exception.PortalException,
248                            com.liferay.portal.kernel.exception.SystemException {
249                    return getService().getPage(nodeId, title);
250            }
251    
252            public static com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
253                    java.lang.String title, java.lang.Boolean head)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException {
256                    return getService().getPage(nodeId, title, head);
257            }
258    
259            public static com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
260                    java.lang.String title, double version)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException {
263                    return getService().getPage(nodeId, title, version);
264            }
265    
266            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
267                    long groupId, long nodeId, boolean head, int status, int start,
268                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
269                    throws com.liferay.portal.kernel.exception.PortalException,
270                            com.liferay.portal.kernel.exception.SystemException {
271                    return getService()
272                                       .getPages(groupId, nodeId, head, status, start, end, obc);
273            }
274    
275            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
276                    long groupId, long userId, long nodeId, int status, int start, int end)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService().getPages(groupId, userId, nodeId, status, start, end);
280            }
281    
282            public static int getPagesCount(long groupId, long nodeId, boolean head)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService().getPagesCount(groupId, nodeId, head);
286            }
287    
288            public static int getPagesCount(long groupId, long userId, long nodeId,
289                    int status)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    return getService().getPagesCount(groupId, userId, nodeId, status);
293            }
294    
295            /**
296            * @deprecated As of 6.2.0, replaced by {@link #getPagesRSS(long, long,
297            String, int, String, double, String, String, String, String,
298            java.util.Locale)}
299            */
300            public static java.lang.String getPagesRSS(long companyId, long nodeId,
301                    java.lang.String title, int max, java.lang.String type, double version,
302                    java.lang.String displayStyle, java.lang.String feedURL,
303                    java.lang.String entryURL, java.util.Locale locale)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return getService()
307                                       .getPagesRSS(companyId, nodeId, title, max, type, version,
308                            displayStyle, feedURL, entryURL, locale);
309            }
310    
311            public static java.lang.String getPagesRSS(long companyId, long nodeId,
312                    java.lang.String title, int max, java.lang.String type, double version,
313                    java.lang.String displayStyle, java.lang.String feedURL,
314                    java.lang.String entryURL, java.lang.String attachmentURLPrefix,
315                    java.util.Locale locale)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    return getService()
319                                       .getPagesRSS(companyId, nodeId, title, max, type, version,
320                            displayStyle, feedURL, entryURL, attachmentURLPrefix, locale);
321            }
322    
323            public static java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
324                    long groupId, long nodeId, int start, int end)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getRecentChanges(groupId, nodeId, start, end);
328            }
329    
330            public static int getRecentChangesCount(long groupId, long nodeId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getRecentChangesCount(groupId, nodeId);
334            }
335    
336            public static java.lang.String[] getTempPageAttachmentNames(long nodeId,
337                    java.lang.String tempFolderName)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getTempPageAttachmentNames(nodeId, tempFolderName);
341            }
342    
343            public static void movePage(long nodeId, java.lang.String title,
344                    java.lang.String newTitle,
345                    com.liferay.portal.service.ServiceContext serviceContext)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService().movePage(nodeId, title, newTitle, serviceContext);
349            }
350    
351            public static com.liferay.portal.kernel.repository.model.FileEntry movePageAttachmentToTrash(
352                    long nodeId, java.lang.String title, java.lang.String fileName)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService().movePageAttachmentToTrash(nodeId, title, fileName);
356            }
357    
358            public static com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
359                    long nodeId, java.lang.String title)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService().movePageToTrash(nodeId, title);
363            }
364    
365            public static com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
366                    long nodeId, java.lang.String title, double version)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException {
369                    return getService().movePageToTrash(nodeId, title, version);
370            }
371    
372            public static void restorePageAttachmentFromTrash(long nodeId,
373                    java.lang.String title, java.lang.String fileName)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    getService().restorePageAttachmentFromTrash(nodeId, title, fileName);
377            }
378    
379            public static void restorePageFromTrash(long resourcePrimKey)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    getService().restorePageFromTrash(resourcePrimKey);
383            }
384    
385            public static com.liferay.portlet.wiki.model.WikiPage revertPage(
386                    long nodeId, java.lang.String title, double version,
387                    com.liferay.portal.service.ServiceContext serviceContext)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService().revertPage(nodeId, title, version, serviceContext);
391            }
392    
393            public static void subscribePage(long nodeId, java.lang.String title)
394                    throws com.liferay.portal.kernel.exception.PortalException,
395                            com.liferay.portal.kernel.exception.SystemException {
396                    getService().subscribePage(nodeId, title);
397            }
398    
399            public static void unsubscribePage(long nodeId, java.lang.String title)
400                    throws com.liferay.portal.kernel.exception.PortalException,
401                            com.liferay.portal.kernel.exception.SystemException {
402                    getService().unsubscribePage(nodeId, title);
403            }
404    
405            public static com.liferay.portlet.wiki.model.WikiPage updatePage(
406                    long nodeId, java.lang.String title, double version,
407                    java.lang.String content, java.lang.String summary, boolean minorEdit,
408                    java.lang.String format, java.lang.String parentTitle,
409                    java.lang.String redirectTitle,
410                    com.liferay.portal.service.ServiceContext serviceContext)
411                    throws com.liferay.portal.kernel.exception.PortalException,
412                            com.liferay.portal.kernel.exception.SystemException {
413                    return getService()
414                                       .updatePage(nodeId, title, version, content, summary,
415                            minorEdit, format, parentTitle, redirectTitle, serviceContext);
416            }
417    
418            public static WikiPageService getService() {
419                    if (_service == null) {
420                            _service = (WikiPageService)PortalBeanLocatorUtil.locate(WikiPageService.class.getName());
421    
422                            ReferenceRegistry.registerReference(WikiPageServiceUtil.class,
423                                    "_service");
424                    }
425    
426                    return _service;
427            }
428    
429            /**
430             * @deprecated As of 6.2.0
431             */
432            public void setService(WikiPageService service) {
433            }
434    
435            private static WikiPageService _service;
436    }