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