1   /**
2    * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.journal.service;
24  
25  /**
26   * <a href="JournalArticleLocalService.java.html"><b><i>View Source</i></b></a>
27   *
28   * <p>
29   * ServiceBuilder generated this class. Modifications in this class will be overwritten
30   * the next time is generated.
31   * </p>
32   *
33   * <p>
34   * This interface defines the service. The default implementation is <code>com.liferay.portlet.journal.service.impl.JournalArticleLocalServiceImpl</code>.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * This is a local service. Methods of this service will not have security checks
41   * based on the propagated JAAS credentials because this service can only be accessed
42   * from within the same VM.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portlet.journal.service.JournalArticleServiceFactory
48   * @see com.liferay.portlet.journal.service.JournalArticleServiceUtil
49   *
50   */
51  public interface JournalArticleLocalService {
52      public com.liferay.portlet.journal.model.JournalArticle addJournalArticle(
53          com.liferay.portlet.journal.model.JournalArticle model)
54          throws com.liferay.portal.SystemException;
55  
56      public java.util.List dynamicQuery(
57          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
58          throws com.liferay.portal.SystemException;
59  
60      public java.util.List dynamicQuery(
61          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
62          int begin, int end) throws com.liferay.portal.SystemException;
63  
64      public com.liferay.portlet.journal.model.JournalArticle updateJournalArticle(
65          com.liferay.portlet.journal.model.JournalArticle model)
66          throws com.liferay.portal.SystemException;
67  
68      public com.liferay.portlet.journal.model.JournalArticle addArticle(
69          long userId, java.lang.String articleId, boolean autoArticleId,
70          long plid, java.lang.String title, java.lang.String description,
71          java.lang.String content, java.lang.String type,
72          java.lang.String structureId, java.lang.String templateId,
73          int displayDateMonth, int displayDateDay, int displayDateYear,
74          int displayDateHour, int displayDateMinute, int expirationDateMonth,
75          int expirationDateDay, int expirationDateYear, int expirationDateHour,
76          int expirationDateMinute, boolean neverExpire, int reviewDateMonth,
77          int reviewDateDay, int reviewDateYear, int reviewDateHour,
78          int reviewDateMinute, boolean neverReview, boolean indexable,
79          java.util.Map images, java.lang.String articleURL,
80          javax.portlet.PortletPreferences prefs, java.lang.String[] tagsEntries,
81          boolean addCommunityPermissions, boolean addGuestPermissions)
82          throws com.liferay.portal.SystemException, 
83              com.liferay.portal.PortalException;
84  
85      public com.liferay.portlet.journal.model.JournalArticle addArticle(
86          long userId, java.lang.String articleId, boolean autoArticleId,
87          long plid, java.lang.String title, java.lang.String description,
88          java.lang.String content, java.lang.String type,
89          java.lang.String structureId, java.lang.String templateId,
90          int displayDateMonth, int displayDateDay, int displayDateYear,
91          int displayDateHour, int displayDateMinute, int expirationDateMonth,
92          int expirationDateDay, int expirationDateYear, int expirationDateHour,
93          int expirationDateMinute, boolean neverExpire, int reviewDateMonth,
94          int reviewDateDay, int reviewDateYear, int reviewDateHour,
95          int reviewDateMinute, boolean neverReview, boolean indexable,
96          java.util.Map images, java.lang.String articleURL,
97          javax.portlet.PortletPreferences prefs, java.lang.String[] tagsEntries,
98          java.lang.String[] communityPermissions,
99          java.lang.String[] guestPermissions)
100         throws com.liferay.portal.SystemException, 
101             com.liferay.portal.PortalException;
102 
103     public com.liferay.portlet.journal.model.JournalArticle addArticle(
104         long userId, java.lang.String articleId, boolean autoArticleId,
105         long plid, java.lang.String title, java.lang.String description,
106         java.lang.String content, java.lang.String type,
107         java.lang.String structureId, java.lang.String templateId,
108         int displayDateMonth, int displayDateDay, int displayDateYear,
109         int displayDateHour, int displayDateMinute, int expirationDateMonth,
110         int expirationDateDay, int expirationDateYear, int expirationDateHour,
111         int expirationDateMinute, boolean neverExpire, int reviewDateMonth,
112         int reviewDateDay, int reviewDateYear, int reviewDateHour,
113         int reviewDateMinute, boolean neverReview, boolean indexable,
114         java.util.Map images, java.lang.String articleURL,
115         javax.portlet.PortletPreferences prefs, java.lang.String[] tagsEntries,
116         java.lang.Boolean addCommunityPermissions,
117         java.lang.Boolean addGuestPermissions,
118         java.lang.String[] communityPermissions,
119         java.lang.String[] guestPermissions)
120         throws com.liferay.portal.SystemException, 
121             com.liferay.portal.PortalException;
122 
123     public com.liferay.portlet.journal.model.JournalArticle addArticleToGroup(
124         long userId, java.lang.String articleId, boolean autoArticleId,
125         long groupId, java.lang.String title, java.lang.String description,
126         java.lang.String content, java.lang.String type,
127         java.lang.String structureId, java.lang.String templateId,
128         int displayDateMonth, int displayDateDay, int displayDateYear,
129         int displayDateHour, int displayDateMinute, int expirationDateMonth,
130         int expirationDateDay, int expirationDateYear, int expirationDateHour,
131         int expirationDateMinute, boolean neverExpire, int reviewDateMonth,
132         int reviewDateDay, int reviewDateYear, int reviewDateHour,
133         int reviewDateMinute, boolean neverReview, boolean indexable,
134         java.util.Map images, java.lang.String articleURL,
135         javax.portlet.PortletPreferences prefs, java.lang.String[] tagsEntries,
136         java.lang.Boolean addCommunityPermissions,
137         java.lang.Boolean addGuestPermissions,
138         java.lang.String[] communityPermissions,
139         java.lang.String[] guestPermissions)
140         throws com.liferay.portal.SystemException, 
141             com.liferay.portal.PortalException;
142 
143     public void addArticleResources(long groupId, java.lang.String articleId,
144         boolean addCommunityPermissions, boolean addGuestPermissions)
145         throws com.liferay.portal.SystemException, 
146             com.liferay.portal.PortalException;
147 
148     public void addArticleResources(
149         com.liferay.portlet.journal.model.JournalArticle article,
150         boolean addCommunityPermissions, boolean addGuestPermissions)
151         throws com.liferay.portal.SystemException, 
152             com.liferay.portal.PortalException;
153 
154     public void addArticleResources(long groupId, java.lang.String articleId,
155         java.lang.String[] communityPermissions,
156         java.lang.String[] guestPermissions)
157         throws com.liferay.portal.SystemException, 
158             com.liferay.portal.PortalException;
159 
160     public void addArticleResources(
161         com.liferay.portlet.journal.model.JournalArticle article,
162         java.lang.String[] communityPermissions,
163         java.lang.String[] guestPermissions)
164         throws com.liferay.portal.SystemException, 
165             com.liferay.portal.PortalException;
166 
167     public com.liferay.portlet.journal.model.JournalArticle approveArticle(
168         long userId, long groupId, java.lang.String articleId, double version,
169         java.lang.String articleURL, javax.portlet.PortletPreferences prefs)
170         throws com.liferay.portal.SystemException, 
171             com.liferay.portal.PortalException;
172 
173     public com.liferay.portlet.journal.model.JournalArticle checkArticleResourcePrimKey(
174         long groupId, java.lang.String articleId, double version)
175         throws com.liferay.portal.SystemException, 
176             com.liferay.portal.PortalException;
177 
178     public void checkArticles()
179         throws com.liferay.portal.SystemException, 
180             com.liferay.portal.PortalException;
181 
182     public void checkNewLine(long groupId, java.lang.String articleId,
183         double version)
184         throws com.liferay.portal.SystemException, 
185             com.liferay.portal.PortalException;
186 
187     public void deleteArticle(long groupId, java.lang.String articleId,
188         double version, java.lang.String articleURL,
189         javax.portlet.PortletPreferences prefs)
190         throws com.liferay.portal.SystemException, 
191             com.liferay.portal.PortalException;
192 
193     public void deleteArticle(
194         com.liferay.portlet.journal.model.JournalArticle article,
195         java.lang.String articleURL, javax.portlet.PortletPreferences prefs)
196         throws com.liferay.portal.SystemException, 
197             com.liferay.portal.PortalException;
198 
199     public void deleteArticles(long groupId)
200         throws com.liferay.portal.SystemException, 
201             com.liferay.portal.PortalException;
202 
203     public void expireArticle(long groupId, java.lang.String articleId,
204         double version, java.lang.String articleURL,
205         javax.portlet.PortletPreferences prefs)
206         throws com.liferay.portal.SystemException, 
207             com.liferay.portal.PortalException;
208 
209     public void expireArticle(
210         com.liferay.portlet.journal.model.JournalArticle article,
211         java.lang.String articleURL, javax.portlet.PortletPreferences prefs)
212         throws com.liferay.portal.SystemException, 
213             com.liferay.portal.PortalException;
214 
215     public com.liferay.portlet.journal.model.JournalArticle getArticle(long id)
216         throws com.liferay.portal.SystemException, 
217             com.liferay.portal.PortalException;
218 
219     public com.liferay.portlet.journal.model.JournalArticle getArticle(
220         long groupId, java.lang.String articleId)
221         throws com.liferay.portal.SystemException, 
222             com.liferay.portal.PortalException;
223 
224     public com.liferay.portlet.journal.model.JournalArticle getArticle(
225         long groupId, java.lang.String articleId, double version)
226         throws com.liferay.portal.SystemException, 
227             com.liferay.portal.PortalException;
228 
229     public java.lang.String getArticleContent(long groupId,
230         java.lang.String articleId, java.lang.String languageId,
231         com.liferay.portal.theme.ThemeDisplay themeDisplay)
232         throws com.liferay.portal.SystemException, 
233             com.liferay.portal.PortalException;
234 
235     public java.lang.String getArticleContent(long groupId,
236         java.lang.String articleId, java.lang.String templateId,
237         java.lang.String languageId,
238         com.liferay.portal.theme.ThemeDisplay themeDisplay)
239         throws com.liferay.portal.SystemException, 
240             com.liferay.portal.PortalException;
241 
242     public java.lang.String getArticleContent(long groupId,
243         java.lang.String articleId, double version,
244         java.lang.String languageId,
245         com.liferay.portal.theme.ThemeDisplay themeDisplay)
246         throws com.liferay.portal.SystemException, 
247             com.liferay.portal.PortalException;
248 
249     public java.lang.String getArticleContent(long groupId,
250         java.lang.String articleId, double version,
251         java.lang.String templateId, java.lang.String languageId,
252         com.liferay.portal.theme.ThemeDisplay themeDisplay)
253         throws com.liferay.portal.SystemException, 
254             com.liferay.portal.PortalException;
255 
256     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
257         long groupId, java.lang.String articleId, java.lang.String languageId,
258         com.liferay.portal.theme.ThemeDisplay themeDisplay)
259         throws com.liferay.portal.SystemException, 
260             com.liferay.portal.PortalException;
261 
262     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
263         long groupId, java.lang.String articleId, java.lang.String languageId,
264         com.liferay.portal.theme.ThemeDisplay themeDisplay,
265         java.lang.String xmlRequest)
266         throws com.liferay.portal.SystemException, 
267             com.liferay.portal.PortalException;
268 
269     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
270         long groupId, java.lang.String articleId, java.lang.String templateId,
271         java.lang.String languageId,
272         com.liferay.portal.theme.ThemeDisplay themeDisplay)
273         throws com.liferay.portal.SystemException, 
274             com.liferay.portal.PortalException;
275 
276     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
277         long groupId, java.lang.String articleId, java.lang.String templateId,
278         java.lang.String languageId,
279         com.liferay.portal.theme.ThemeDisplay themeDisplay,
280         java.lang.String xmlRequest)
281         throws com.liferay.portal.SystemException, 
282             com.liferay.portal.PortalException;
283 
284     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
285         long groupId, java.lang.String articleId, double version,
286         java.lang.String templateId, java.lang.String languageId,
287         com.liferay.portal.theme.ThemeDisplay themeDisplay)
288         throws com.liferay.portal.SystemException, 
289             com.liferay.portal.PortalException;
290 
291     public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay(
292         long groupId, java.lang.String articleId, double version,
293         java.lang.String templateId, java.lang.String languageId,
294         com.liferay.portal.theme.ThemeDisplay themeDisplay,
295         java.lang.String xmlRequest)
296         throws com.liferay.portal.SystemException, 
297             com.liferay.portal.PortalException;
298 
299     public java.util.List getArticles()
300         throws com.liferay.portal.SystemException;
301 
302     public java.util.List getArticles(long groupId)
303         throws com.liferay.portal.SystemException;
304 
305     public java.util.List getArticles(long groupId, int begin, int end)
306         throws com.liferay.portal.SystemException;
307 
308     public java.util.List getArticles(long groupId, int begin, int end,
309         com.liferay.portal.kernel.util.OrderByComparator obc)
310         throws com.liferay.portal.SystemException;
311 
312     public int getArticlesCount(long groupId)
313         throws com.liferay.portal.SystemException;
314 
315     public com.liferay.portlet.journal.model.JournalArticle getDisplayArticle(
316         long groupId, java.lang.String articleId)
317         throws com.liferay.portal.SystemException, 
318             com.liferay.portal.PortalException;
319 
320     public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
321         long groupId, java.lang.String articleId)
322         throws com.liferay.portal.SystemException, 
323             com.liferay.portal.PortalException;
324 
325     public com.liferay.portlet.journal.model.JournalArticle getLatestArticle(
326         long groupId, java.lang.String articleId, java.lang.Boolean approved)
327         throws com.liferay.portal.SystemException, 
328             com.liferay.portal.PortalException;
329 
330     public double getLatestVersion(long groupId, java.lang.String articleId)
331         throws com.liferay.portal.SystemException, 
332             com.liferay.portal.PortalException;
333 
334     public double getLatestVersion(long groupId, java.lang.String articleId,
335         java.lang.Boolean approved)
336         throws com.liferay.portal.SystemException, 
337             com.liferay.portal.PortalException;
338 
339     public java.util.List getStructureArticles(long groupId,
340         java.lang.String structureId) throws com.liferay.portal.SystemException;
341 
342     public java.util.List getStructureArticles(long groupId,
343         java.lang.String structureId, int begin, int end,
344         com.liferay.portal.kernel.util.OrderByComparator obc)
345         throws com.liferay.portal.SystemException;
346 
347     public int getStructureArticlesCount(long groupId,
348         java.lang.String structureId) throws com.liferay.portal.SystemException;
349 
350     public java.util.List getTemplateArticles(long groupId,
351         java.lang.String templateId) throws com.liferay.portal.SystemException;
352 
353     public java.util.List getTemplateArticles(long groupId,
354         java.lang.String templateId, int begin, int end,
355         com.liferay.portal.kernel.util.OrderByComparator obc)
356         throws com.liferay.portal.SystemException;
357 
358     public int getTemplateArticlesCount(long groupId,
359         java.lang.String templateId) throws com.liferay.portal.SystemException;
360 
361     public boolean hasArticle(long groupId, java.lang.String articleId)
362         throws com.liferay.portal.SystemException;
363 
364     public boolean isLatestVersion(long groupId, java.lang.String articleId,
365         double version)
366         throws com.liferay.portal.SystemException, 
367             com.liferay.portal.PortalException;
368 
369     public boolean isLatestVersion(long groupId, java.lang.String articleId,
370         double version, java.lang.Boolean active)
371         throws com.liferay.portal.SystemException, 
372             com.liferay.portal.PortalException;
373 
374     public void reIndex(java.lang.String[] ids)
375         throws com.liferay.portal.SystemException;
376 
377     public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale(
378         long groupId, java.lang.String articleId, double version,
379         java.lang.String languageId)
380         throws com.liferay.portal.SystemException, 
381             com.liferay.portal.PortalException;
382 
383     public com.liferay.portal.kernel.search.Hits search(long companyId,
384         long groupId, java.lang.String title, java.lang.String description,
385         java.lang.String content, java.lang.String type)
386         throws com.liferay.portal.SystemException;
387 
388     public com.liferay.portal.kernel.search.Hits search(long companyId,
389         long groupId, java.lang.String title, java.lang.String description,
390         java.lang.String content, java.lang.String type,
391         java.lang.String sortField) throws com.liferay.portal.SystemException;
392 
393     public java.util.List search(long companyId, long groupId,
394         java.lang.String keywords, java.lang.Double version,
395         java.lang.String type, java.lang.String structureId,
396         java.lang.String templateId, java.util.Date displayDateGT,
397         java.util.Date displayDateLT, java.lang.Boolean approved,
398         java.lang.Boolean expired, java.util.Date reviewDate, int begin,
399         int end, com.liferay.portal.kernel.util.OrderByComparator obc)
400         throws com.liferay.portal.SystemException;
401 
402     public java.util.List search(long companyId, long groupId,
403         java.lang.String articleId, java.lang.Double version,
404         java.lang.String title, java.lang.String description,
405         java.lang.String content, java.lang.String type,
406         java.lang.String structureId, java.lang.String templateId,
407         java.util.Date displayDateGT, java.util.Date displayDateLT,
408         java.lang.Boolean approved, java.lang.Boolean expired,
409         java.util.Date reviewDate, boolean andOperator, int begin, int end,
410         com.liferay.portal.kernel.util.OrderByComparator obc)
411         throws com.liferay.portal.SystemException;
412 
413     public java.util.List search(long companyId, long groupId,
414         java.lang.String articleId, java.lang.Double version,
415         java.lang.String title, java.lang.String description,
416         java.lang.String content, java.lang.String type,
417         java.lang.String[] structureIds, java.lang.String[] templateIds,
418         java.util.Date displayDateGT, java.util.Date displayDateLT,
419         java.lang.Boolean approved, java.lang.Boolean expired,
420         java.util.Date reviewDate, boolean andOperator, int begin, int end,
421         com.liferay.portal.kernel.util.OrderByComparator obc)
422         throws com.liferay.portal.SystemException;
423 
424     public int searchCount(long companyId, long groupId,
425         java.lang.String keywords, java.lang.Double version,
426         java.lang.String type, java.lang.String structureId,
427         java.lang.String templateId, java.util.Date displayDateGT,
428         java.util.Date displayDateLT, java.lang.Boolean approved,
429         java.lang.Boolean expired, java.util.Date reviewDate)
430         throws com.liferay.portal.SystemException;
431 
432     public int searchCount(long companyId, long groupId,
433         java.lang.String articleId, java.lang.Double version,
434         java.lang.String title, java.lang.String description,
435         java.lang.String content, java.lang.String type,
436         java.lang.String structureId, java.lang.String templateId,
437         java.util.Date displayDateGT, java.util.Date displayDateLT,
438         java.lang.Boolean approved, java.lang.Boolean expired,
439         java.util.Date reviewDate, boolean andOperator)
440         throws com.liferay.portal.SystemException;
441 
442     public int searchCount(long companyId, long groupId,
443         java.lang.String articleId, java.lang.Double version,
444         java.lang.String title, java.lang.String description,
445         java.lang.String content, java.lang.String type,
446         java.lang.String[] structureIds, java.lang.String[] templateIds,
447         java.util.Date displayDateGT, java.util.Date displayDateLT,
448         java.lang.Boolean approved, java.lang.Boolean expired,
449         java.util.Date reviewDate, boolean andOperator)
450         throws com.liferay.portal.SystemException;
451 
452     public com.liferay.portlet.journal.model.JournalArticle updateArticle(
453         long userId, long groupId, java.lang.String articleId, double version,
454         boolean incrementVersion, java.lang.String title,
455         java.lang.String description, java.lang.String content,
456         java.lang.String type, java.lang.String structureId,
457         java.lang.String templateId, int displayDateMonth, int displayDateDay,
458         int displayDateYear, int displayDateHour, int displayDateMinute,
459         int expirationDateMonth, int expirationDateDay, int expirationDateYear,
460         int expirationDateHour, int expirationDateMinute, boolean neverExpire,
461         int reviewDateMonth, int reviewDateDay, int reviewDateYear,
462         int reviewDateHour, int reviewDateMinute, boolean neverReview,
463         boolean indexable, java.util.Map images, java.lang.String articleURL,
464         javax.portlet.PortletPreferences prefs, java.lang.String[] tagsEntries)
465         throws com.liferay.portal.SystemException, 
466             com.liferay.portal.PortalException;
467 
468     public com.liferay.portlet.journal.model.JournalArticle updateContent(
469         long groupId, java.lang.String articleId, double version,
470         java.lang.String content)
471         throws com.liferay.portal.SystemException, 
472             com.liferay.portal.PortalException;
473 
474     public void updateTagsAsset(long userId,
475         com.liferay.portlet.journal.model.JournalArticle article,
476         java.lang.String[] tagsEntries)
477         throws com.liferay.portal.SystemException, 
478             com.liferay.portal.PortalException;
479 }