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