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.journal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the journal article remote service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and is the primary access point for service operations in application layer code running on a remote server.
022     *
023     * <p>
024     * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see JournalArticleService
029     * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl
030     * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl
031     * @generated
032     */
033    public class JournalArticleServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Returns the Spring bean ID for this bean.
042            *
043            * @return the Spring bean ID for this bean
044            */
045            public static java.lang.String getBeanIdentifier() {
046                    return getService().getBeanIdentifier();
047            }
048    
049            /**
050            * Sets the Spring bean ID for this bean.
051            *
052            * @param beanIdentifier the Spring bean ID for this bean
053            */
054            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
055                    getService().setBeanIdentifier(beanIdentifier);
056            }
057    
058            public static com.liferay.portlet.journal.model.JournalArticle addArticle(
059                    long groupId, long classNameId, long classPK,
060                    java.lang.String articleId, boolean autoArticleId,
061                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
062                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
063                    java.lang.String content, java.lang.String type,
064                    java.lang.String structureId, java.lang.String templateId,
065                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
066                    int displayDateYear, int displayDateHour, int displayDateMinute,
067                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
068                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
069                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
070                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
071                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
072                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
073                    java.lang.String articleURL,
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                                       .addArticle(groupId, classNameId, classPK, articleId,
079                            autoArticleId, titleMap, descriptionMap, content, type,
080                            structureId, templateId, layoutUuid, displayDateMonth,
081                            displayDateDay, displayDateYear, displayDateHour,
082                            displayDateMinute, expirationDateMonth, expirationDateDay,
083                            expirationDateYear, expirationDateHour, expirationDateMinute,
084                            neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear,
085                            reviewDateHour, reviewDateMinute, neverReview, indexable,
086                            smallImage, smallImageURL, smallFile, images, articleURL,
087                            serviceContext);
088            }
089    
090            public static com.liferay.portlet.journal.model.JournalArticle addArticle(
091                    long groupId, long classNameId, long classPK,
092                    java.lang.String articleId, boolean autoArticleId,
093                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
094                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
095                    java.lang.String content, java.lang.String type,
096                    java.lang.String structureId, java.lang.String templateId,
097                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
098                    int displayDateYear, int displayDateHour, int displayDateMinute,
099                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
100                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
101                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
102                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
103                    boolean indexable, java.lang.String articleURL,
104                    com.liferay.portal.service.ServiceContext serviceContext)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException {
107                    return getService()
108                                       .addArticle(groupId, classNameId, classPK, articleId,
109                            autoArticleId, titleMap, descriptionMap, content, type,
110                            structureId, templateId, layoutUuid, displayDateMonth,
111                            displayDateDay, displayDateYear, displayDateHour,
112                            displayDateMinute, expirationDateMonth, expirationDateDay,
113                            expirationDateYear, expirationDateHour, expirationDateMinute,
114                            neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear,
115                            reviewDateHour, reviewDateMinute, neverReview, indexable,
116                            articleURL, serviceContext);
117            }
118    
119            public static com.liferay.portlet.journal.model.JournalArticle copyArticle(
120                    long groupId, java.lang.String oldArticleId,
121                    java.lang.String newArticleId, boolean autoArticleId, double version)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException {
124                    return getService()
125                                       .copyArticle(groupId, oldArticleId, newArticleId,
126                            autoArticleId, version);
127            }
128    
129            public static void deleteArticle(long groupId, java.lang.String articleId,
130                    double version, java.lang.String articleURL,
131                    com.liferay.portal.service.ServiceContext serviceContext)
132                    throws com.liferay.portal.kernel.exception.PortalException,
133                            com.liferay.portal.kernel.exception.SystemException {
134                    getService()
135                            .deleteArticle(groupId, articleId, version, articleURL,
136                            serviceContext);
137            }
138    
139            public static void deleteArticle(long groupId, java.lang.String articleId,
140                    java.lang.String articleURL,
141                    com.liferay.portal.service.ServiceContext serviceContext)
142                    throws com.liferay.portal.kernel.exception.PortalException,
143                            com.liferay.portal.kernel.exception.SystemException {
144                    getService()
145                            .deleteArticle(groupId, articleId, articleURL, serviceContext);
146            }
147    
148            public static com.liferay.portlet.journal.model.JournalArticle expireArticle(
149                    long groupId, java.lang.String articleId, double version,
150                    java.lang.String articleURL,
151                    com.liferay.portal.service.ServiceContext serviceContext)
152                    throws com.liferay.portal.kernel.exception.PortalException,
153                            com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .expireArticle(groupId, articleId, version, articleURL,
156                            serviceContext);
157            }
158    
159            public static void expireArticle(long groupId, java.lang.String articleId,
160                    java.lang.String articleURL,
161                    com.liferay.portal.service.ServiceContext serviceContext)
162                    throws com.liferay.portal.kernel.exception.PortalException,
163                            com.liferay.portal.kernel.exception.SystemException {
164                    getService()
165                            .expireArticle(groupId, articleId, articleURL, serviceContext);
166            }
167    
168            public static com.liferay.portlet.journal.model.JournalArticle getArticle(
169                    long id)
170                    throws com.liferay.portal.kernel.exception.PortalException,
171                            com.liferay.portal.kernel.exception.SystemException {
172                    return getService().getArticle(id);
173            }
174    
175            public static com.liferay.portlet.journal.model.JournalArticle getArticle(
176                    long groupId, java.lang.String articleId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getArticle(groupId, articleId);
180            }
181    
182            public static com.liferay.portlet.journal.model.JournalArticle getArticle(
183                    long groupId, java.lang.String articleId, double version)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getArticle(groupId, articleId, version);
187            }
188    
189            public static com.liferay.portlet.journal.model.JournalArticle getArticle(
190                    long groupId, java.lang.String className, long classPK)
191                    throws com.liferay.portal.kernel.exception.PortalException,
192                            com.liferay.portal.kernel.exception.SystemException {
193                    return getService().getArticle(groupId, className, classPK);
194            }
195    
196            public static com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(
197                    long groupId, java.lang.String urlTitle)
198                    throws com.liferay.portal.kernel.exception.PortalException,
199                            com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getArticleByUrlTitle(groupId, urlTitle);
201            }
202    
203            public static java.lang.String getArticleContent(long groupId,
204                    java.lang.String articleId, double version,
205                    java.lang.String languageId,
206                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException {
209                    return getService()
210                                       .getArticleContent(groupId, articleId, version, languageId,
211                            themeDisplay);
212            }
213    
214            public static java.lang.String getArticleContent(long groupId,
215                    java.lang.String articleId, java.lang.String languageId,
216                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
217                    throws com.liferay.portal.kernel.exception.PortalException,
218                            com.liferay.portal.kernel.exception.SystemException {
219                    return getService()
220                                       .getArticleContent(groupId, articleId, languageId,
221                            themeDisplay);
222            }
223    
224            public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByArticleId(
225                    long groupId, java.lang.String articleId, int start, int end,
226                    com.liferay.portal.kernel.util.OrderByComparator obc)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService()
229                                       .getArticlesByArticleId(groupId, articleId, start, end, obc);
230            }
231    
232            public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByLayoutUuid(
233                    long groupId, java.lang.String layoutUuid)
234                    throws com.liferay.portal.kernel.exception.SystemException {
235                    return getService().getArticlesByLayoutUuid(groupId, layoutUuid);
236            }
237    
238            public static int getArticlesCountByArticleId(long groupId,
239                    java.lang.String articleId)
240                    throws com.liferay.portal.kernel.exception.SystemException {
241                    return getService().getArticlesCountByArticleId(groupId, articleId);
242            }
243    
244            public static com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle(
245                    long groupId, java.lang.String urlTitle)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    return getService().getDisplayArticleByUrlTitle(groupId, urlTitle);
249            }
250    
251            public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
252                    long resourcePrimKey)
253                    throws com.liferay.portal.kernel.exception.PortalException,
254                            com.liferay.portal.kernel.exception.SystemException {
255                    return getService().getLatestArticle(resourcePrimKey);
256            }
257    
258            public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
259                    long groupId, java.lang.String articleId, int status)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService().getLatestArticle(groupId, articleId, status);
263            }
264    
265            public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
266                    long groupId, java.lang.String className, long classPK)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException {
269                    return getService().getLatestArticle(groupId, className, classPK);
270            }
271    
272            public static void removeArticleLocale(long companyId,
273                    java.lang.String languageId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService().removeArticleLocale(companyId, languageId);
277            }
278    
279            public static com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
280                    long groupId, java.lang.String articleId, double version,
281                    java.lang.String languageId)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .removeArticleLocale(groupId, articleId, version, languageId);
286            }
287    
288            public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
289                    long companyId, long groupId, long classNameId,
290                    java.lang.String keywords, java.lang.Double version,
291                    java.lang.String type, java.lang.String structureId,
292                    java.lang.String templateId, java.util.Date displayDateGT,
293                    java.util.Date displayDateLT, int status, java.util.Date reviewDate,
294                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
295                    throws com.liferay.portal.kernel.exception.SystemException {
296                    return getService()
297                                       .search(companyId, groupId, classNameId, keywords, version,
298                            type, structureId, templateId, displayDateGT, displayDateLT,
299                            status, reviewDate, start, end, obc);
300            }
301    
302            public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
303                    long companyId, long groupId, long classNameId,
304                    java.lang.String articleId, java.lang.Double version,
305                    java.lang.String title, java.lang.String description,
306                    java.lang.String content, java.lang.String type,
307                    java.lang.String structureId, java.lang.String templateId,
308                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
309                    java.util.Date reviewDate, boolean andOperator, int start, int end,
310                    com.liferay.portal.kernel.util.OrderByComparator obc)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService()
313                                       .search(companyId, groupId, classNameId, articleId, version,
314                            title, description, content, type, structureId, templateId,
315                            displayDateGT, displayDateLT, status, reviewDate, andOperator,
316                            start, end, obc);
317            }
318    
319            public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
320                    long companyId, long groupId, long classNameId,
321                    java.lang.String articleId, java.lang.Double version,
322                    java.lang.String title, java.lang.String description,
323                    java.lang.String content, java.lang.String type,
324                    java.lang.String[] structureIds, java.lang.String[] templateIds,
325                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
326                    java.util.Date reviewDate, boolean andOperator, int start, int end,
327                    com.liferay.portal.kernel.util.OrderByComparator obc)
328                    throws com.liferay.portal.kernel.exception.SystemException {
329                    return getService()
330                                       .search(companyId, groupId, classNameId, articleId, version,
331                            title, description, content, type, structureIds, templateIds,
332                            displayDateGT, displayDateLT, status, reviewDate, andOperator,
333                            start, end, obc);
334            }
335    
336            public static int searchCount(long companyId, long groupId,
337                    long classNameId, java.lang.String keywords, java.lang.Double version,
338                    java.lang.String type, java.lang.String structureId,
339                    java.lang.String templateId, java.util.Date displayDateGT,
340                    java.util.Date displayDateLT, int status, java.util.Date reviewDate)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService()
343                                       .searchCount(companyId, groupId, classNameId, keywords,
344                            version, type, structureId, templateId, displayDateGT,
345                            displayDateLT, status, reviewDate);
346            }
347    
348            public static int searchCount(long companyId, long groupId,
349                    long classNameId, java.lang.String articleId, java.lang.Double version,
350                    java.lang.String title, java.lang.String description,
351                    java.lang.String content, java.lang.String type,
352                    java.lang.String structureId, java.lang.String templateId,
353                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
354                    java.util.Date reviewDate, boolean andOperator)
355                    throws com.liferay.portal.kernel.exception.SystemException {
356                    return getService()
357                                       .searchCount(companyId, groupId, classNameId, articleId,
358                            version, title, description, content, type, structureId,
359                            templateId, displayDateGT, displayDateLT, status, reviewDate,
360                            andOperator);
361            }
362    
363            public static int searchCount(long companyId, long groupId,
364                    long classNameId, java.lang.String articleId, java.lang.Double version,
365                    java.lang.String title, java.lang.String description,
366                    java.lang.String content, java.lang.String type,
367                    java.lang.String[] structureIds, java.lang.String[] templateIds,
368                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
369                    java.util.Date reviewDate, boolean andOperator)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService()
372                                       .searchCount(companyId, groupId, classNameId, articleId,
373                            version, title, description, content, type, structureIds,
374                            templateIds, displayDateGT, displayDateLT, status, reviewDate,
375                            andOperator);
376            }
377    
378            public static void subscribe(long groupId)
379                    throws com.liferay.portal.kernel.exception.PortalException,
380                            com.liferay.portal.kernel.exception.SystemException {
381                    getService().subscribe(groupId);
382            }
383    
384            public static void unsubscribe(long groupId)
385                    throws com.liferay.portal.kernel.exception.PortalException,
386                            com.liferay.portal.kernel.exception.SystemException {
387                    getService().unsubscribe(groupId);
388            }
389    
390            public static com.liferay.portlet.journal.model.JournalArticle updateArticle(
391                    long userId, long groupId, java.lang.String articleId, double version,
392                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
393                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
394                    java.lang.String content, java.lang.String layoutUuid,
395                    com.liferay.portal.service.ServiceContext serviceContext)
396                    throws com.liferay.portal.kernel.exception.PortalException,
397                            com.liferay.portal.kernel.exception.SystemException {
398                    return getService()
399                                       .updateArticle(userId, groupId, articleId, version,
400                            titleMap, descriptionMap, content, layoutUuid, serviceContext);
401            }
402    
403            public static com.liferay.portlet.journal.model.JournalArticle updateArticle(
404                    long groupId, java.lang.String articleId, double version,
405                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
406                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
407                    java.lang.String content, java.lang.String type,
408                    java.lang.String structureId, java.lang.String templateId,
409                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
410                    int displayDateYear, int displayDateHour, int displayDateMinute,
411                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
412                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
413                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
414                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
415                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
416                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
417                    java.lang.String articleURL,
418                    com.liferay.portal.service.ServiceContext serviceContext)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return getService()
422                                       .updateArticle(groupId, articleId, version, titleMap,
423                            descriptionMap, content, type, structureId, templateId, layoutUuid,
424                            displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
425                            displayDateMinute, expirationDateMonth, expirationDateDay,
426                            expirationDateYear, expirationDateHour, expirationDateMinute,
427                            neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear,
428                            reviewDateHour, reviewDateMinute, neverReview, indexable,
429                            smallImage, smallImageURL, smallFile, images, articleURL,
430                            serviceContext);
431            }
432    
433            public static com.liferay.portlet.journal.model.JournalArticle updateArticle(
434                    long groupId, java.lang.String articleId, double version,
435                    java.lang.String content,
436                    com.liferay.portal.service.ServiceContext serviceContext)
437                    throws com.liferay.portal.kernel.exception.PortalException,
438                            com.liferay.portal.kernel.exception.SystemException {
439                    return getService()
440                                       .updateArticle(groupId, articleId, version, content,
441                            serviceContext);
442            }
443    
444            /**
445            * @deprecated {@link #updateArticleTranslation(long, String, double,
446            Locale, String, String, String, Map, ServiceContext)}
447            */
448            public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
449                    long groupId, java.lang.String articleId, double version,
450                    java.util.Locale locale, java.lang.String title,
451                    java.lang.String description, java.lang.String content,
452                    java.util.Map<java.lang.String, byte[]> images)
453                    throws com.liferay.portal.kernel.exception.PortalException,
454                            com.liferay.portal.kernel.exception.SystemException {
455                    return getService()
456                                       .updateArticleTranslation(groupId, articleId, version,
457                            locale, title, description, content, images);
458            }
459    
460            public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
461                    long groupId, java.lang.String articleId, double version,
462                    java.util.Locale locale, java.lang.String title,
463                    java.lang.String description, java.lang.String content,
464                    java.util.Map<java.lang.String, byte[]> images,
465                    com.liferay.portal.service.ServiceContext serviceContext)
466                    throws com.liferay.portal.kernel.exception.PortalException,
467                            com.liferay.portal.kernel.exception.SystemException {
468                    return getService()
469                                       .updateArticleTranslation(groupId, articleId, version,
470                            locale, title, description, content, images, serviceContext);
471            }
472    
473            public static com.liferay.portlet.journal.model.JournalArticle updateContent(
474                    long groupId, java.lang.String articleId, double version,
475                    java.lang.String content)
476                    throws com.liferay.portal.kernel.exception.PortalException,
477                            com.liferay.portal.kernel.exception.SystemException {
478                    return getService().updateContent(groupId, articleId, version, content);
479            }
480    
481            public static com.liferay.portlet.journal.model.JournalArticle updateStatus(
482                    long groupId, java.lang.String articleId, double version, int status,
483                    java.lang.String articleURL,
484                    com.liferay.portal.service.ServiceContext serviceContext)
485                    throws com.liferay.portal.kernel.exception.PortalException,
486                            com.liferay.portal.kernel.exception.SystemException {
487                    return getService()
488                                       .updateStatus(groupId, articleId, version, status,
489                            articleURL, serviceContext);
490            }
491    
492            public static JournalArticleService getService() {
493                    if (_service == null) {
494                            _service = (JournalArticleService)PortalBeanLocatorUtil.locate(JournalArticleService.class.getName());
495    
496                            ReferenceRegistry.registerReference(JournalArticleServiceUtil.class,
497                                    "_service");
498                    }
499    
500                    return _service;
501            }
502    
503            /**
504             * @deprecated
505             */
506            public void setService(JournalArticleService service) {
507            }
508    
509            private static JournalArticleService _service;
510    }