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    
024    /**
025     * The interface for the journal article remote service.
026     *
027     * <p>
028     * 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.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see JournalArticleServiceUtil
033     * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl
034     * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl
035     * @generated
036     */
037    @JSONWebService
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface JournalArticleService {
041            /*
042             * NOTE FOR DEVELOPERS:
043             *
044             * 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.
045             */
046            public com.liferay.portlet.journal.model.JournalArticle addArticle(
047                    long groupId, long classNameId, long classPK,
048                    java.lang.String articleId, boolean autoArticleId,
049                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
050                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
051                    java.lang.String content, java.lang.String type,
052                    java.lang.String structureId, java.lang.String templateId,
053                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
054                    int displayDateYear, int displayDateHour, int displayDateMinute,
055                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
056                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
057                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
058                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
059                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
060                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
061                    java.lang.String articleURL,
062                    com.liferay.portal.service.ServiceContext serviceContext)
063                    throws com.liferay.portal.kernel.exception.PortalException,
064                            com.liferay.portal.kernel.exception.SystemException;
065    
066            public com.liferay.portlet.journal.model.JournalArticle addArticle(
067                    long groupId, long classNameId, long classPK,
068                    java.lang.String articleId, boolean autoArticleId,
069                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
070                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
071                    java.lang.String content, java.lang.String type,
072                    java.lang.String structureId, java.lang.String templateId,
073                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
074                    int displayDateYear, int displayDateHour, int displayDateMinute,
075                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
076                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
077                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
078                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
079                    boolean indexable, 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 copyArticle(
085                    long groupId, java.lang.String oldArticleId,
086                    java.lang.String newArticleId, boolean autoArticleId, double version)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException;
089    
090            public void deleteArticle(long groupId, java.lang.String articleId,
091                    double version, java.lang.String articleURL,
092                    com.liferay.portal.service.ServiceContext serviceContext)
093                    throws com.liferay.portal.kernel.exception.PortalException,
094                            com.liferay.portal.kernel.exception.SystemException;
095    
096            public void deleteArticle(long groupId, java.lang.String articleId,
097                    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 expireArticle(
103                    long groupId, java.lang.String articleId, double version,
104                    java.lang.String articleURL,
105                    com.liferay.portal.service.ServiceContext serviceContext)
106                    throws com.liferay.portal.kernel.exception.PortalException,
107                            com.liferay.portal.kernel.exception.SystemException;
108    
109            public void expireArticle(long groupId, java.lang.String articleId,
110                    java.lang.String articleURL,
111                    com.liferay.portal.service.ServiceContext serviceContext)
112                    throws com.liferay.portal.kernel.exception.PortalException,
113                            com.liferay.portal.kernel.exception.SystemException;
114    
115            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
116            public com.liferay.portlet.journal.model.JournalArticle getArticle(long id)
117                    throws com.liferay.portal.kernel.exception.PortalException,
118                            com.liferay.portal.kernel.exception.SystemException;
119    
120            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121            public com.liferay.portlet.journal.model.JournalArticle getArticle(
122                    long groupId, java.lang.String articleId)
123                    throws com.liferay.portal.kernel.exception.PortalException,
124                            com.liferay.portal.kernel.exception.SystemException;
125    
126            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127            public com.liferay.portlet.journal.model.JournalArticle getArticle(
128                    long groupId, java.lang.String articleId, double version)
129                    throws com.liferay.portal.kernel.exception.PortalException,
130                            com.liferay.portal.kernel.exception.SystemException;
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public com.liferay.portlet.journal.model.JournalArticle getArticle(
134                    long groupId, java.lang.String className, long classPK)
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 getArticleByUrlTitle(
140                    long groupId, java.lang.String urlTitle)
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 java.lang.String getArticleContent(long groupId,
146                    java.lang.String articleId, double version,
147                    java.lang.String languageId,
148                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
149                    throws com.liferay.portal.kernel.exception.PortalException,
150                            com.liferay.portal.kernel.exception.SystemException;
151    
152            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
153            public java.lang.String getArticleContent(long groupId,
154                    java.lang.String articleId, java.lang.String languageId,
155                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
156                    throws com.liferay.portal.kernel.exception.PortalException,
157                            com.liferay.portal.kernel.exception.SystemException;
158    
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByArticleId(
161                    long groupId, java.lang.String articleId, int start, int end,
162                    com.liferay.portal.kernel.util.OrderByComparator obc)
163                    throws com.liferay.portal.kernel.exception.SystemException;
164    
165            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
166            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByLayoutUuid(
167                    long groupId, java.lang.String layoutUuid)
168                    throws com.liferay.portal.kernel.exception.SystemException;
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public int getArticlesCountByArticleId(long groupId,
172                    java.lang.String articleId)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle(
177                    long groupId, java.lang.String urlTitle)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
183                    long resourcePrimKey)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException;
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
189                    long groupId, java.lang.String articleId, int status)
190                    throws com.liferay.portal.kernel.exception.PortalException,
191                            com.liferay.portal.kernel.exception.SystemException;
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
195                    long groupId, java.lang.String className, long classPK)
196                    throws com.liferay.portal.kernel.exception.PortalException,
197                            com.liferay.portal.kernel.exception.SystemException;
198    
199            public void removeArticleLocale(long companyId, java.lang.String languageId)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
204                    long groupId, java.lang.String articleId, double version,
205                    java.lang.String languageId)
206                    throws com.liferay.portal.kernel.exception.PortalException,
207                            com.liferay.portal.kernel.exception.SystemException;
208    
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
211                    long companyId, long groupId, long classNameId,
212                    java.lang.String keywords, java.lang.Double version,
213                    java.lang.String type, java.lang.String structureId,
214                    java.lang.String templateId, java.util.Date displayDateGT,
215                    java.util.Date displayDateLT, int status, java.util.Date reviewDate,
216                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
221                    long companyId, long groupId, long classNameId,
222                    java.lang.String articleId, java.lang.Double version,
223                    java.lang.String title, java.lang.String description,
224                    java.lang.String content, java.lang.String type,
225                    java.lang.String structureId, java.lang.String templateId,
226                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
227                    java.util.Date reviewDate, boolean andOperator, int start, int end,
228                    com.liferay.portal.kernel.util.OrderByComparator obc)
229                    throws com.liferay.portal.kernel.exception.SystemException;
230    
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
233                    long companyId, long groupId, long classNameId,
234                    java.lang.String articleId, java.lang.Double version,
235                    java.lang.String title, java.lang.String description,
236                    java.lang.String content, java.lang.String type,
237                    java.lang.String[] structureIds, java.lang.String[] templateIds,
238                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
239                    java.util.Date reviewDate, boolean andOperator, int start, int end,
240                    com.liferay.portal.kernel.util.OrderByComparator obc)
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public int searchCount(long companyId, long groupId, long classNameId,
245                    java.lang.String keywords, java.lang.Double version,
246                    java.lang.String type, java.lang.String structureId,
247                    java.lang.String templateId, java.util.Date displayDateGT,
248                    java.util.Date displayDateLT, int status, java.util.Date reviewDate)
249                    throws com.liferay.portal.kernel.exception.SystemException;
250    
251            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252            public int searchCount(long companyId, long groupId, long classNameId,
253                    java.lang.String articleId, java.lang.Double version,
254                    java.lang.String title, java.lang.String description,
255                    java.lang.String content, java.lang.String type,
256                    java.lang.String structureId, java.lang.String templateId,
257                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
258                    java.util.Date reviewDate, boolean andOperator)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public int searchCount(long companyId, long groupId, long classNameId,
263                    java.lang.String articleId, java.lang.Double version,
264                    java.lang.String title, java.lang.String description,
265                    java.lang.String content, java.lang.String type,
266                    java.lang.String[] structureIds, java.lang.String[] templateIds,
267                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
268                    java.util.Date reviewDate, boolean andOperator)
269                    throws com.liferay.portal.kernel.exception.SystemException;
270    
271            public void subscribe(long groupId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void unsubscribe(long groupId)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
280                    long userId, long groupId, java.lang.String articleId, double version,
281                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
282                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
283                    java.lang.String content, java.lang.String layoutUuid,
284                    com.liferay.portal.service.ServiceContext serviceContext)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
289                    long groupId, java.lang.String articleId, double version,
290                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
291                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
292                    java.lang.String content, java.lang.String type,
293                    java.lang.String structureId, java.lang.String templateId,
294                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
295                    int displayDateYear, int displayDateHour, int displayDateMinute,
296                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
297                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
298                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
299                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
300                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
301                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
302                    java.lang.String articleURL,
303                    com.liferay.portal.service.ServiceContext serviceContext)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException;
306    
307            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
308                    long groupId, java.lang.String articleId, double version,
309                    java.lang.String content,
310                    com.liferay.portal.service.ServiceContext serviceContext)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException;
313    
314            /**
315            * @deprecated {@link #updateArticleTranslation(long, String, double,
316            Locale, String, String, String, Map, ServiceContext)}
317            */
318            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
319                    long groupId, java.lang.String articleId, double version,
320                    java.util.Locale locale, java.lang.String title,
321                    java.lang.String description, java.lang.String content,
322                    java.util.Map<java.lang.String, byte[]> images)
323                    throws com.liferay.portal.kernel.exception.PortalException,
324                            com.liferay.portal.kernel.exception.SystemException;
325    
326            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
327                    long groupId, java.lang.String articleId, double version,
328                    java.util.Locale locale, java.lang.String title,
329                    java.lang.String description, java.lang.String content,
330                    java.util.Map<java.lang.String, byte[]> images,
331                    com.liferay.portal.service.ServiceContext serviceContext)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException;
334    
335            public com.liferay.portlet.journal.model.JournalArticle updateContent(
336                    long groupId, java.lang.String articleId, double version,
337                    java.lang.String content)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException;
340    }