001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.journal.service;
016    
017    import com.liferay.portal.kernel.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.service.BaseService;
024    
025    /**
026     * The interface for the journal article remote service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see JournalArticleServiceUtil
034     * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl
035     * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl
036     * @generated
037     */
038    @JSONWebService
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface JournalArticleService extends BaseService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Returns the Spring bean ID for this bean.
050            *
051            * @return the Spring bean ID for this bean
052            */
053            public java.lang.String getBeanIdentifier();
054    
055            /**
056            * Sets the Spring bean ID for this bean.
057            *
058            * @param beanIdentifier the Spring bean ID for this bean
059            */
060            public void setBeanIdentifier(java.lang.String beanIdentifier);
061    
062            public com.liferay.portlet.journal.model.JournalArticle addArticle(
063                    long groupId, long classNameId, long classPK,
064                    java.lang.String articleId, boolean autoArticleId,
065                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
066                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
067                    java.lang.String content, java.lang.String type,
068                    java.lang.String structureId, java.lang.String templateId,
069                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
070                    int displayDateYear, int displayDateHour, int displayDateMinute,
071                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
072                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
073                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
074                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
075                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
076                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
077                    java.lang.String articleURL,
078                    com.liferay.portal.service.ServiceContext serviceContext)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            public com.liferay.portlet.journal.model.JournalArticle addArticle(
083                    long groupId, long classNameId, long classPK,
084                    java.lang.String articleId, boolean autoArticleId,
085                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
086                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
087                    java.lang.String content, java.lang.String type,
088                    java.lang.String structureId, java.lang.String templateId,
089                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
090                    int displayDateYear, int displayDateHour, int displayDateMinute,
091                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
092                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
093                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
094                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
095                    boolean indexable, java.lang.String articleURL,
096                    com.liferay.portal.service.ServiceContext serviceContext)
097                    throws com.liferay.portal.kernel.exception.PortalException,
098                            com.liferay.portal.kernel.exception.SystemException;
099    
100            public com.liferay.portlet.journal.model.JournalArticle copyArticle(
101                    long groupId, java.lang.String oldArticleId,
102                    java.lang.String newArticleId, boolean autoArticleId, double version)
103                    throws com.liferay.portal.kernel.exception.PortalException,
104                            com.liferay.portal.kernel.exception.SystemException;
105    
106            public void deleteArticle(long groupId, java.lang.String articleId,
107                    double version, java.lang.String articleURL,
108                    com.liferay.portal.service.ServiceContext serviceContext)
109                    throws com.liferay.portal.kernel.exception.PortalException,
110                            com.liferay.portal.kernel.exception.SystemException;
111    
112            public void deleteArticle(long groupId, java.lang.String articleId,
113                    java.lang.String articleURL,
114                    com.liferay.portal.service.ServiceContext serviceContext)
115                    throws com.liferay.portal.kernel.exception.PortalException,
116                            com.liferay.portal.kernel.exception.SystemException;
117    
118            public com.liferay.portlet.journal.model.JournalArticle expireArticle(
119                    long groupId, java.lang.String articleId, double version,
120                    java.lang.String articleURL,
121                    com.liferay.portal.service.ServiceContext serviceContext)
122                    throws com.liferay.portal.kernel.exception.PortalException,
123                            com.liferay.portal.kernel.exception.SystemException;
124    
125            public void expireArticle(long groupId, java.lang.String articleId,
126                    java.lang.String articleURL,
127                    com.liferay.portal.service.ServiceContext serviceContext)
128                    throws com.liferay.portal.kernel.exception.PortalException,
129                            com.liferay.portal.kernel.exception.SystemException;
130    
131            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
132            public com.liferay.portlet.journal.model.JournalArticle getArticle(long id)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException;
135    
136            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137            public com.liferay.portlet.journal.model.JournalArticle getArticle(
138                    long groupId, java.lang.String articleId)
139                    throws com.liferay.portal.kernel.exception.PortalException,
140                            com.liferay.portal.kernel.exception.SystemException;
141    
142            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
143            public com.liferay.portlet.journal.model.JournalArticle getArticle(
144                    long groupId, java.lang.String articleId, double version)
145                    throws com.liferay.portal.kernel.exception.PortalException,
146                            com.liferay.portal.kernel.exception.SystemException;
147    
148            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
149            public com.liferay.portlet.journal.model.JournalArticle getArticle(
150                    long groupId, java.lang.String className, long classPK)
151                    throws com.liferay.portal.kernel.exception.PortalException,
152                            com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(
156                    long groupId, java.lang.String urlTitle)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
161            public java.lang.String getArticleContent(long groupId,
162                    java.lang.String articleId, double version,
163                    java.lang.String languageId,
164                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public java.lang.String getArticleContent(long groupId,
170                    java.lang.String articleId, java.lang.String languageId,
171                    com.liferay.portal.theme.ThemeDisplay themeDisplay)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByArticleId(
177                    long groupId, java.lang.String articleId, int start, int end,
178                    com.liferay.portal.kernel.util.OrderByComparator obc)
179                    throws com.liferay.portal.kernel.exception.SystemException;
180    
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByLayoutUuid(
183                    long groupId, java.lang.String layoutUuid)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public int getArticlesCountByArticleId(long groupId,
188                    java.lang.String articleId)
189                    throws com.liferay.portal.kernel.exception.SystemException;
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle(
193                    long groupId, java.lang.String urlTitle)
194                    throws com.liferay.portal.kernel.exception.PortalException,
195                            com.liferay.portal.kernel.exception.SystemException;
196    
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
199                    long resourcePrimKey)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException;
202    
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
205                    long groupId, java.lang.String articleId, int status)
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 com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
211                    long groupId, java.lang.String className, long classPK)
212                    throws com.liferay.portal.kernel.exception.PortalException,
213                            com.liferay.portal.kernel.exception.SystemException;
214    
215            public void removeArticleLocale(long companyId, java.lang.String languageId)
216                    throws com.liferay.portal.kernel.exception.PortalException,
217                            com.liferay.portal.kernel.exception.SystemException;
218    
219            public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
220                    long groupId, java.lang.String articleId, double version,
221                    java.lang.String languageId)
222                    throws com.liferay.portal.kernel.exception.PortalException,
223                            com.liferay.portal.kernel.exception.SystemException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
227                    long companyId, long groupId, long classNameId,
228                    java.lang.String keywords, java.lang.Double version,
229                    java.lang.String type, java.lang.String structureId,
230                    java.lang.String templateId, java.util.Date displayDateGT,
231                    java.util.Date displayDateLT, int status, java.util.Date reviewDate,
232                    int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
236            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
237                    long companyId, long groupId, long classNameId,
238                    java.lang.String articleId, java.lang.Double version,
239                    java.lang.String title, java.lang.String description,
240                    java.lang.String content, java.lang.String type,
241                    java.lang.String structureId, java.lang.String templateId,
242                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
243                    java.util.Date reviewDate, boolean andOperator, int start, int end,
244                    com.liferay.portal.kernel.util.OrderByComparator obc)
245                    throws com.liferay.portal.kernel.exception.SystemException;
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search(
249                    long companyId, long groupId, long classNameId,
250                    java.lang.String articleId, java.lang.Double version,
251                    java.lang.String title, java.lang.String description,
252                    java.lang.String content, java.lang.String type,
253                    java.lang.String[] structureIds, java.lang.String[] templateIds,
254                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
255                    java.util.Date reviewDate, boolean andOperator, int start, int end,
256                    com.liferay.portal.kernel.util.OrderByComparator obc)
257                    throws com.liferay.portal.kernel.exception.SystemException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public int searchCount(long companyId, long groupId, long classNameId,
261                    java.lang.String keywords, java.lang.Double version,
262                    java.lang.String type, java.lang.String structureId,
263                    java.lang.String templateId, java.util.Date displayDateGT,
264                    java.util.Date displayDateLT, int status, java.util.Date reviewDate)
265                    throws com.liferay.portal.kernel.exception.SystemException;
266    
267            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
268            public int searchCount(long companyId, long groupId, long classNameId,
269                    java.lang.String articleId, java.lang.Double version,
270                    java.lang.String title, java.lang.String description,
271                    java.lang.String content, java.lang.String type,
272                    java.lang.String structureId, java.lang.String templateId,
273                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
274                    java.util.Date reviewDate, boolean andOperator)
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public int searchCount(long companyId, long groupId, long classNameId,
279                    java.lang.String articleId, java.lang.Double version,
280                    java.lang.String title, java.lang.String description,
281                    java.lang.String content, java.lang.String type,
282                    java.lang.String[] structureIds, java.lang.String[] templateIds,
283                    java.util.Date displayDateGT, java.util.Date displayDateLT, int status,
284                    java.util.Date reviewDate, boolean andOperator)
285                    throws com.liferay.portal.kernel.exception.SystemException;
286    
287            public void subscribe(long groupId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public void unsubscribe(long groupId)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException;
294    
295            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
296                    long userId, long groupId, java.lang.String articleId, double version,
297                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
298                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
299                    java.lang.String content, java.lang.String layoutUuid,
300                    com.liferay.portal.service.ServiceContext serviceContext)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException;
303    
304            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
305                    long groupId, java.lang.String articleId, double version,
306                    java.util.Map<java.util.Locale, java.lang.String> titleMap,
307                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
308                    java.lang.String content, java.lang.String type,
309                    java.lang.String structureId, java.lang.String templateId,
310                    java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
311                    int displayDateYear, int displayDateHour, int displayDateMinute,
312                    int expirationDateMonth, int expirationDateDay, int expirationDateYear,
313                    int expirationDateHour, int expirationDateMinute, boolean neverExpire,
314                    int reviewDateMonth, int reviewDateDay, int reviewDateYear,
315                    int reviewDateHour, int reviewDateMinute, boolean neverReview,
316                    boolean indexable, boolean smallImage, java.lang.String smallImageURL,
317                    java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images,
318                    java.lang.String articleURL,
319                    com.liferay.portal.service.ServiceContext serviceContext)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException;
322    
323            public com.liferay.portlet.journal.model.JournalArticle updateArticle(
324                    long groupId, java.lang.String articleId, double version,
325                    java.lang.String content,
326                    com.liferay.portal.service.ServiceContext serviceContext)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException;
329    
330            /**
331            * @deprecated {@link #updateArticleTranslation(long, String, double,
332            Locale, String, String, String, Map, ServiceContext)}
333            */
334            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
335                    long groupId, java.lang.String articleId, double version,
336                    java.util.Locale locale, java.lang.String title,
337                    java.lang.String description, java.lang.String content,
338                    java.util.Map<java.lang.String, byte[]> images)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException;
341    
342            public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation(
343                    long groupId, java.lang.String articleId, double version,
344                    java.util.Locale locale, java.lang.String title,
345                    java.lang.String description, java.lang.String content,
346                    java.util.Map<java.lang.String, byte[]> images,
347                    com.liferay.portal.service.ServiceContext serviceContext)
348                    throws com.liferay.portal.kernel.exception.PortalException,
349                            com.liferay.portal.kernel.exception.SystemException;
350    
351            public com.liferay.portlet.journal.model.JournalArticle updateContent(
352                    long groupId, java.lang.String articleId, double version,
353                    java.lang.String content)
354                    throws com.liferay.portal.kernel.exception.PortalException,
355                            com.liferay.portal.kernel.exception.SystemException;
356    
357            public com.liferay.portlet.journal.model.JournalArticle updateStatus(
358                    long groupId, java.lang.String articleId, double version, int status,
359                    java.lang.String articleURL,
360                    com.liferay.portal.service.ServiceContext serviceContext)
361                    throws com.liferay.portal.kernel.exception.PortalException,
362                            com.liferay.portal.kernel.exception.SystemException;
363    }