001    /**
002     * Copyright (c) 2000-2012 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.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     * The interface for the journal article remote service.
028     *
029     * <p>
030     * 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.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see JournalArticleServiceUtil
035     * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl
036     * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl
037     * @generated
038     */
039    @AccessControlled
040    @JSONWebService
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface JournalArticleService extends BaseService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. Always use {@link JournalArticleServiceUtil} to access the journal article remote service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
048             */
049    
050            /**
051            * Returns the Spring bean ID for this bean.
052            *
053            * @return the Spring bean ID for this bean
054            */
055            public java.lang.String getBeanIdentifier();
056    
057            /**
058            * Sets the Spring bean ID for this bean.
059            *
060            * @param beanIdentifier the Spring bean ID for this bean
061            */
062            public void setBeanIdentifier(java.lang.String beanIdentifier);
063    
064            public com.liferay.portlet.journal.model.JournalArticle addArticle(
065                    long groupId, long folderId, long classNameId, long classPK,
066                    java.lang.String articleId, boolean autoArticleId,
067                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
068                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
069                    java.lang.String content, java.lang.String type,
070                    java.lang.String structureId, java.lang.String templateId,
071                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
072                    int displayDateYear, int displayDateHour, int displayDateMinute,
073                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
074                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
075                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
076                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
077                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
078                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
079                    java.lang.String articleURL,
080                    com.liferay.portal.service.ServiceContext serviceContext)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            public com.liferay.portlet.journal.model.JournalArticle addArticle(
085                    long groupId, long folderId, long classNameId, long classPK,
086                    java.lang.String articleId, boolean autoArticleId,
087                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
088                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
089                    java.lang.String content, java.lang.String type,
090                    java.lang.String structureId, java.lang.String templateId,
091                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
092                    int displayDateYear, int displayDateHour, int displayDateMinute,
093                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
094                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
095                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
096                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
097                    boolean indexable, java.lang.String articleURL,
098                    com.liferay.portal.service.ServiceContext serviceContext)
099                    throws com.liferay.portal.kernel.exception.PortalException,
100                            com.liferay.portal.kernel.exception.SystemException;
101    
102            public com.liferay.portlet.journal.model.JournalArticle copyArticle(
103                    long groupId, java.lang.String oldArticleId,
104                    java.lang.String newArticleId, boolean autoArticleId, double version)
105                    throws com.liferay.portal.kernel.exception.PortalException,
106                            com.liferay.portal.kernel.exception.SystemException;
107    
108            public void deleteArticle(long groupId, java.lang.String articleId,
109                    double version, java.lang.String articleURL,
110                    com.liferay.portal.service.ServiceContext serviceContext)
111                    throws com.liferay.portal.kernel.exception.PortalException,
112                            com.liferay.portal.kernel.exception.SystemException;
113    
114            public void deleteArticle(long groupId, java.lang.String articleId,
115                    java.lang.String articleURL,
116                    com.liferay.portal.service.ServiceContext serviceContext)
117                    throws com.liferay.portal.kernel.exception.PortalException,
118                            com.liferay.portal.kernel.exception.SystemException;
119    
120            public com.liferay.portlet.journal.model.JournalArticle expireArticle(
121                    long groupId, java.lang.String articleId, double version,
122                    java.lang.String articleURL,
123                    com.liferay.portal.service.ServiceContext serviceContext)
124                    throws com.liferay.portal.kernel.exception.PortalException,
125                            com.liferay.portal.kernel.exception.SystemException;
126    
127            public void expireArticle(long groupId, java.lang.String articleId,
128                    java.lang.String articleURL,
129                    com.liferay.portal.service.ServiceContext serviceContext)
130                    throws com.liferay.portal.kernel.exception.PortalException,
131                            com.liferay.portal.kernel.exception.SystemException;
132    
133            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
134            public com.liferay.portlet.journal.model.JournalArticle getArticle(long id)
135                    throws com.liferay.portal.kernel.exception.PortalException,
136                            com.liferay.portal.kernel.exception.SystemException;
137    
138            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139            public com.liferay.portlet.journal.model.JournalArticle getArticle(
140                    long groupId, java.lang.String articleId)
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 com.liferay.portlet.journal.model.JournalArticle getArticle(
146                    long groupId, java.lang.String articleId, double version)
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.journal.model.JournalArticle getArticle(
152                    long groupId, java.lang.String className, long classPK)
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 com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(
158                    long groupId, java.lang.String urlTitle)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public java.lang.String getArticleContent(long groupId,
164                    java.lang.String articleId, double version,
165                    java.lang.String languageId,
166                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public java.lang.String getArticleContent(long groupId,
172                    java.lang.String articleId, java.lang.String languageId,
173                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
174                    throws com.liferay.portal.kernel.exception.PortalException,
175                            com.liferay.portal.kernel.exception.SystemException;
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles(
179                    long groupId, long folderId)
180                    throws com.liferay.portal.kernel.exception.SystemException;
181    
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles(
184                    long groupId, long folderId, int start, int end,
185                    com.liferay.portal.kernel.util.OrderByComparator obc)
186                    throws com.liferay.portal.kernel.exception.SystemException;
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByArticleId(
190                    long groupId, java.lang.String articleId, int start, int end,
191                    com.liferay.portal.kernel.util.OrderByComparator obc)
192                    throws com.liferay.portal.kernel.exception.SystemException;
193    
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByLayoutUuid(
196                    long groupId, java.lang.String layoutUuid)
197                    throws com.liferay.portal.kernel.exception.SystemException;
198    
199            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
200            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByStructureId(
201                    long groupId, java.lang.String structureId, int start, int end,
202                    com.liferay.portal.kernel.util.OrderByComparator obc)
203                    throws com.liferay.portal.kernel.exception.SystemException;
204    
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByUserId(
207                    long groupId, long userId, long classNameId, int start, int end,
208                    com.liferay.portal.kernel.util.OrderByComparator obc)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public int getArticlesCount(long groupId, long folderId)
213                    throws com.liferay.portal.kernel.exception.SystemException;
214    
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public int getArticlesCountByArticleId(long groupId,
217                    java.lang.String articleId)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public int getArticlesCountByStructureId(long groupId,
222                    java.lang.String structureId)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public int getArticlesCountByUserId(long groupId, long userId,
227                    long classNameId)
228                    throws com.liferay.portal.kernel.exception.SystemException;
229    
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle(
232                    long groupId, java.lang.String urlTitle)
233                    throws com.liferay.portal.kernel.exception.PortalException,
234                            com.liferay.portal.kernel.exception.SystemException;
235    
236            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
237            public int getFoldersAndArticlesCount(long groupId,
238                    java.util.List<java.lang.Long> folderIds)
239                    throws com.liferay.portal.kernel.exception.SystemException;
240    
241            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
243                    long resourcePrimKey)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
249                    long groupId, java.lang.String articleId, int status)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
255                    long groupId, java.lang.String className, long classPK)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            public void moveArticle(long groupId, java.lang.String articleId,
260                    long newFolderId)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public void removeArticleLocale(long companyId, java.lang.String languageId)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
269                    long groupId, java.lang.String articleId, double version,
270                    java.lang.String languageId)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
276                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
277                    long classNameId, java.lang.String keywords, java.lang.Double version,
278                    java.lang.String type, java.lang.String structureId,
279                    java.lang.String templateId, java.util.Date displayDateGT,
280                    java.util.Date displayDateLT, int status, java.util.Date reviewDate,
281                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
282                    throws com.liferay.portal.kernel.exception.SystemException;
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
286                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
287                    long classNameId, java.lang.String articleId, java.lang.Double version,
288                    java.lang.String title, java.lang.String description,
289                    java.lang.String content, java.lang.String type,
290                    java.lang.String structureId, java.lang.String templateId,
291                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
292                    java.util.Date reviewDate, boolean andOperator, int start, int end,
293                    com.liferay.portal.kernel.util.OrderByComparator obc)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    
296            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
297            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
298                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
299                    long classNameId, java.lang.String articleId, java.lang.Double version,
300                    java.lang.String title, java.lang.String description,
301                    java.lang.String content, java.lang.String type,
302                    java.lang.String[] structureIds, java.lang.String[] templateIds,
303                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
304                    java.util.Date reviewDate, boolean andOperator, int start, int end,
305                    com.liferay.portal.kernel.util.OrderByComparator obc)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public int searchCount(long companyId, long groupId,
310                    java.util.List<java.lang.Long> folderIds, long classNameId,
311                    java.lang.String keywords, java.lang.Double version,
312                    java.lang.String type, java.lang.String structureId,
313                    java.lang.String templateId, java.util.Date displayDateGT,
314                    java.util.Date displayDateLT, int status, java.util.Date reviewDate)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public int searchCount(long companyId, long groupId,
319                    java.util.List<java.lang.Long> folderIds, long classNameId,
320                    java.lang.String articleId, java.lang.Double version,
321                    java.lang.String title, java.lang.String description,
322                    java.lang.String content, java.lang.String type,
323                    java.lang.String structureId, java.lang.String templateId,
324                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
325                    java.util.Date reviewDate, boolean andOperator)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public int searchCount(long companyId, long groupId,
330                    java.util.List<java.lang.Long> folderIds, long classNameId,
331                    java.lang.String articleId, java.lang.Double version,
332                    java.lang.String title, java.lang.String description,
333                    java.lang.String content, java.lang.String type,
334                    java.lang.String[] structureIds, java.lang.String[] templateIds,
335                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
336                    java.util.Date reviewDate, boolean andOperator)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            public void subscribe(long groupId)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    
343            public void unsubscribe(long groupId)
344                    throws com.liferay.portal.kernel.exception.PortalException,
345                            com.liferay.portal.kernel.exception.SystemException;
346    
347            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
348                    long userId, long groupId, long folderId, java.lang.String articleId,
349                    double version,
350                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
351                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
352                    java.lang.String content, java.lang.String layoutUuid,
353                    com.liferay.portal.service.ServiceContext serviceContext)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
358                    long groupId, long folderId, java.lang.String articleId,
359                    double version,
360                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
361                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
362                    java.lang.String content, java.lang.String type,
363                    java.lang.String structureId, java.lang.String templateId,
364                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
365                    int displayDateYear, int displayDateHour, int displayDateMinute,
366                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
367                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
368                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
369                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
370                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
371                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
372                    java.lang.String articleURL,
373                    com.liferay.portal.service.ServiceContext serviceContext)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException;
376    
377            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
378                    long groupId, long folderId, java.lang.String articleId,
379                    double version, java.lang.String content,
380                    com.liferay.portal.service.ServiceContext serviceContext)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException;
383    
384            /**
385            * @deprecated {@link #updateArticleTranslation(long, String, double,
386            Locale, String, String, String, Map, ServiceContext)}
387            */
388            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
389                    long groupId, java.lang.String articleId, double version,
390                    java.util.Locale locale, java.lang.String title,
391                    java.lang.String description, java.lang.String content,
392                    java.util.Map<java.lang.String, byte[]> images)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException;
395    
396            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
397                    long groupId, java.lang.String articleId, double version,
398                    java.util.Locale locale, java.lang.String title,
399                    java.lang.String description, java.lang.String content,
400                    java.util.Map<java.lang.String, byte[]> images,
401                    com.liferay.portal.service.ServiceContext serviceContext)
402                    throws com.liferay.portal.kernel.exception.PortalException,
403                            com.liferay.portal.kernel.exception.SystemException;
404    
405            public com.liferay.portlet.journal.model.JournalArticle updateContent(
406                    long groupId, java.lang.String articleId, double version,
407                    java.lang.String content)
408                    throws com.liferay.portal.kernel.exception.PortalException,
409                            com.liferay.portal.kernel.exception.SystemException;
410    
411            public com.liferay.portlet.journal.model.JournalArticle updateStatus(
412                    long groupId, java.lang.String articleId, double version, int status,
413                    java.lang.String articleURL,
414                    com.liferay.portal.service.ServiceContext serviceContext)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException;
417    }