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, 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                    throws com.liferay.portal.kernel.exception.SystemException;
228    
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle(
231                    long groupId, java.lang.String urlTitle)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public int getFoldersAndArticlesCount(long groupId,
237                    java.util.List<java.lang.Long> folderIds)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
242                    long resourcePrimKey)
243                    throws com.liferay.portal.kernel.exception.PortalException,
244                            com.liferay.portal.kernel.exception.SystemException;
245    
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
248                    long groupId, java.lang.String articleId, int status)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
254                    long groupId, java.lang.String className, long classPK)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            public void moveArticle(long groupId, java.lang.String articleId,
259                    long newFolderId)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public void removeArticleLocale(long companyId, java.lang.String languageId)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException;
266    
267            public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
268                    long groupId, java.lang.String articleId, double version,
269                    java.lang.String languageId)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
275                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
276                    long classNameId, java.lang.String keywords, java.lang.Double version,
277                    java.lang.String type, java.lang.String structureId,
278                    java.lang.String templateId, java.util.Date displayDateGT,
279                    java.util.Date displayDateLT, int status, java.util.Date reviewDate,
280                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
281                    throws com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
285                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
286                    long classNameId, java.lang.String articleId, java.lang.Double version,
287                    java.lang.String title, java.lang.String description,
288                    java.lang.String content, java.lang.String type,
289                    java.lang.String structureId, java.lang.String templateId,
290                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
291                    java.util.Date reviewDate, boolean andOperator, int start, int end,
292                    com.liferay.portal.kernel.util.OrderByComparator obc)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
296            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
297                    long companyId, long groupId, java.util.List<java.lang.Long> folderIds,
298                    long classNameId, java.lang.String articleId, java.lang.Double version,
299                    java.lang.String title, java.lang.String description,
300                    java.lang.String content, java.lang.String type,
301                    java.lang.String[] structureIds, java.lang.String[] templateIds,
302                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
303                    java.util.Date reviewDate, boolean andOperator, int start, int end,
304                    com.liferay.portal.kernel.util.OrderByComparator obc)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public int searchCount(long companyId, long groupId,
309                    java.util.List<java.lang.Long> folderIds, long classNameId,
310                    java.lang.String keywords, java.lang.Double version,
311                    java.lang.String type, java.lang.String structureId,
312                    java.lang.String templateId, java.util.Date displayDateGT,
313                    java.util.Date displayDateLT, int status, java.util.Date reviewDate)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public int searchCount(long companyId, long groupId,
318                    java.util.List<java.lang.Long> folderIds, long classNameId,
319                    java.lang.String articleId, java.lang.Double version,
320                    java.lang.String title, java.lang.String description,
321                    java.lang.String content, java.lang.String type,
322                    java.lang.String structureId, java.lang.String templateId,
323                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
324                    java.util.Date reviewDate, boolean andOperator)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public int searchCount(long companyId, long groupId,
329                    java.util.List<java.lang.Long> folderIds, long classNameId,
330                    java.lang.String articleId, java.lang.Double version,
331                    java.lang.String title, java.lang.String description,
332                    java.lang.String content, java.lang.String type,
333                    java.lang.String[] structureIds, java.lang.String[] templateIds,
334                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
335                    java.util.Date reviewDate, boolean andOperator)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            public void subscribe(long groupId)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException;
341    
342            public void unsubscribe(long groupId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
347                    long userId, long groupId, long folderId, java.lang.String articleId,
348                    double version,
349                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
350                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
351                    java.lang.String content, java.lang.String layoutUuid,
352                    com.liferay.portal.service.ServiceContext serviceContext)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
357                    long groupId, long folderId, java.lang.String articleId,
358                    double version,
359                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
360                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
361                    java.lang.String content, java.lang.String type,
362                    java.lang.String structureId, java.lang.String templateId,
363                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
364                    int displayDateYear, int displayDateHour, int displayDateMinute,
365                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
366                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
367                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
368                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
369                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
370                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
371                    java.lang.String articleURL,
372                    com.liferay.portal.service.ServiceContext serviceContext)
373                    throws com.liferay.portal.kernel.exception.PortalException,
374                            com.liferay.portal.kernel.exception.SystemException;
375    
376            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
377                    long groupId, long folderId, java.lang.String articleId,
378                    double version, java.lang.String content,
379                    com.liferay.portal.service.ServiceContext serviceContext)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException;
382    
383            /**
384            * @deprecated {@link #updateArticleTranslation(long, String, double,
385            Locale, String, String, String, Map, ServiceContext)}
386            */
387            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
388                    long groupId, java.lang.String articleId, double version,
389                    java.util.Locale locale, java.lang.String title,
390                    java.lang.String description, java.lang.String content,
391                    java.util.Map<java.lang.String, byte[]> images)
392                    throws com.liferay.portal.kernel.exception.PortalException,
393                            com.liferay.portal.kernel.exception.SystemException;
394    
395            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
396                    long groupId, java.lang.String articleId, double version,
397                    java.util.Locale locale, java.lang.String title,
398                    java.lang.String description, java.lang.String content,
399                    java.util.Map<java.lang.String, byte[]> images,
400                    com.liferay.portal.service.ServiceContext serviceContext)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException;
403    
404            public com.liferay.portlet.journal.model.JournalArticle updateContent(
405                    long groupId, java.lang.String articleId, double version,
406                    java.lang.String content)
407                    throws com.liferay.portal.kernel.exception.PortalException,
408                            com.liferay.portal.kernel.exception.SystemException;
409    
410            public com.liferay.portlet.journal.model.JournalArticle updateStatus(
411                    long groupId, java.lang.String articleId, double version, int status,
412                    java.lang.String articleURL,
413                    com.liferay.portal.service.ServiceContext serviceContext)
414                    throws com.liferay.portal.kernel.exception.PortalException,
415                            com.liferay.portal.kernel.exception.SystemException;
416    }