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.service.ServiceWrapper; 018 019 /** 020 * <p> 021 * This class is a wrapper for {@link JournalArticleLocalService}. 022 * </p> 023 * 024 * @author Brian Wing Shun Chan 025 * @see JournalArticleLocalService 026 * @generated 027 */ 028 public class JournalArticleLocalServiceWrapper 029 implements JournalArticleLocalService, 030 ServiceWrapper<JournalArticleLocalService> { 031 public JournalArticleLocalServiceWrapper( 032 JournalArticleLocalService journalArticleLocalService) { 033 _journalArticleLocalService = journalArticleLocalService; 034 } 035 036 /** 037 * Adds the journal article to the database. Also notifies the appropriate model listeners. 038 * 039 * @param journalArticle the journal article 040 * @return the journal article that was added 041 * @throws SystemException if a system exception occurred 042 */ 043 public com.liferay.portlet.journal.model.JournalArticle addJournalArticle( 044 com.liferay.portlet.journal.model.JournalArticle journalArticle) 045 throws com.liferay.portal.kernel.exception.SystemException { 046 return _journalArticleLocalService.addJournalArticle(journalArticle); 047 } 048 049 /** 050 * Creates a new journal article with the primary key. Does not add the journal article to the database. 051 * 052 * @param id the primary key for the new journal article 053 * @return the new journal article 054 */ 055 public com.liferay.portlet.journal.model.JournalArticle createJournalArticle( 056 long id) { 057 return _journalArticleLocalService.createJournalArticle(id); 058 } 059 060 /** 061 * Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners. 062 * 063 * @param id the primary key of the journal article 064 * @return the journal article that was removed 065 * @throws PortalException if a journal article with the primary key could not be found 066 * @throws SystemException if a system exception occurred 067 */ 068 public com.liferay.portlet.journal.model.JournalArticle deleteJournalArticle( 069 long id) 070 throws com.liferay.portal.kernel.exception.PortalException, 071 com.liferay.portal.kernel.exception.SystemException { 072 return _journalArticleLocalService.deleteJournalArticle(id); 073 } 074 075 /** 076 * Deletes the journal article from the database. Also notifies the appropriate model listeners. 077 * 078 * @param journalArticle the journal article 079 * @return the journal article that was removed 080 * @throws SystemException if a system exception occurred 081 */ 082 public com.liferay.portlet.journal.model.JournalArticle deleteJournalArticle( 083 com.liferay.portlet.journal.model.JournalArticle journalArticle) 084 throws com.liferay.portal.kernel.exception.SystemException { 085 return _journalArticleLocalService.deleteJournalArticle(journalArticle); 086 } 087 088 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 089 return _journalArticleLocalService.dynamicQuery(); 090 } 091 092 /** 093 * Performs a dynamic query on the database and returns the matching rows. 094 * 095 * @param dynamicQuery the dynamic query 096 * @return the matching rows 097 * @throws SystemException if a system exception occurred 098 */ 099 @SuppressWarnings("rawtypes") 100 public java.util.List dynamicQuery( 101 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 102 throws com.liferay.portal.kernel.exception.SystemException { 103 return _journalArticleLocalService.dynamicQuery(dynamicQuery); 104 } 105 106 /** 107 * Performs a dynamic query on the database and returns a range of the matching rows. 108 * 109 * <p> 110 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 111 * </p> 112 * 113 * @param dynamicQuery the dynamic query 114 * @param start the lower bound of the range of model instances 115 * @param end the upper bound of the range of model instances (not inclusive) 116 * @return the range of matching rows 117 * @throws SystemException if a system exception occurred 118 */ 119 @SuppressWarnings("rawtypes") 120 public java.util.List dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 122 int end) throws com.liferay.portal.kernel.exception.SystemException { 123 return _journalArticleLocalService.dynamicQuery(dynamicQuery, start, end); 124 } 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 * @throws SystemException if a system exception occurred 139 */ 140 @SuppressWarnings("rawtypes") 141 public java.util.List dynamicQuery( 142 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 143 int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException { 146 return _journalArticleLocalService.dynamicQuery(dynamicQuery, start, 147 end, orderByComparator); 148 } 149 150 /** 151 * Returns the number of rows that match the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows that match the dynamic query 155 * @throws SystemException if a system exception occurred 156 */ 157 public long dynamicQueryCount( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 159 throws com.liferay.portal.kernel.exception.SystemException { 160 return _journalArticleLocalService.dynamicQueryCount(dynamicQuery); 161 } 162 163 public com.liferay.portlet.journal.model.JournalArticle fetchJournalArticle( 164 long id) throws com.liferay.portal.kernel.exception.SystemException { 165 return _journalArticleLocalService.fetchJournalArticle(id); 166 } 167 168 /** 169 * Returns the journal article with the primary key. 170 * 171 * @param id the primary key of the journal article 172 * @return the journal article 173 * @throws PortalException if a journal article with the primary key could not be found 174 * @throws SystemException if a system exception occurred 175 */ 176 public com.liferay.portlet.journal.model.JournalArticle getJournalArticle( 177 long id) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException { 180 return _journalArticleLocalService.getJournalArticle(id); 181 } 182 183 public com.liferay.portal.model.PersistedModel getPersistedModel( 184 java.io.Serializable primaryKeyObj) 185 throws com.liferay.portal.kernel.exception.PortalException, 186 com.liferay.portal.kernel.exception.SystemException { 187 return _journalArticleLocalService.getPersistedModel(primaryKeyObj); 188 } 189 190 /** 191 * Returns the journal article matching the UUID and group. 192 * 193 * @param uuid the journal article's UUID 194 * @param groupId the primary key of the group 195 * @return the matching journal article 196 * @throws PortalException if a matching journal article could not be found 197 * @throws SystemException if a system exception occurred 198 */ 199 public com.liferay.portlet.journal.model.JournalArticle getJournalArticleByUuidAndGroupId( 200 java.lang.String uuid, long groupId) 201 throws com.liferay.portal.kernel.exception.PortalException, 202 com.liferay.portal.kernel.exception.SystemException { 203 return _journalArticleLocalService.getJournalArticleByUuidAndGroupId(uuid, 204 groupId); 205 } 206 207 /** 208 * Returns a range of all the journal articles. 209 * 210 * <p> 211 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 212 * </p> 213 * 214 * @param start the lower bound of the range of journal articles 215 * @param end the upper bound of the range of journal articles (not inclusive) 216 * @return the range of journal articles 217 * @throws SystemException if a system exception occurred 218 */ 219 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getJournalArticles( 220 int start, int end) 221 throws com.liferay.portal.kernel.exception.SystemException { 222 return _journalArticleLocalService.getJournalArticles(start, end); 223 } 224 225 /** 226 * Returns the number of journal articles. 227 * 228 * @return the number of journal articles 229 * @throws SystemException if a system exception occurred 230 */ 231 public int getJournalArticlesCount() 232 throws com.liferay.portal.kernel.exception.SystemException { 233 return _journalArticleLocalService.getJournalArticlesCount(); 234 } 235 236 /** 237 * Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 238 * 239 * @param journalArticle the journal article 240 * @return the journal article that was updated 241 * @throws SystemException if a system exception occurred 242 */ 243 public com.liferay.portlet.journal.model.JournalArticle updateJournalArticle( 244 com.liferay.portlet.journal.model.JournalArticle journalArticle) 245 throws com.liferay.portal.kernel.exception.SystemException { 246 return _journalArticleLocalService.updateJournalArticle(journalArticle); 247 } 248 249 /** 250 * Returns the Spring bean ID for this bean. 251 * 252 * @return the Spring bean ID for this bean 253 */ 254 public java.lang.String getBeanIdentifier() { 255 return _journalArticleLocalService.getBeanIdentifier(); 256 } 257 258 /** 259 * Sets the Spring bean ID for this bean. 260 * 261 * @param beanIdentifier the Spring bean ID for this bean 262 */ 263 public void setBeanIdentifier(java.lang.String beanIdentifier) { 264 _journalArticleLocalService.setBeanIdentifier(beanIdentifier); 265 } 266 267 /** 268 * Adds a web content article with additional parameters. 269 * 270 * @param userId the primary key of the web content article's creator/owner 271 * @param groupId the primary key of the web content article's group 272 * @param folderId the primary key of the web content article folder 273 * @param classNameId the primary key of the DDMStructure class if the web 274 content article is related to a DDM structure, the primary key of 275 the class name associated with the article, or {@link 276 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 277 * @param classPK the primary key of the DDM structure, if the primary key 278 of the DDMStructure class is given as the 279 <code>classNameId</code> parameter, the primary key of the class 280 associated with the web content article, or <code>0</code> 281 otherwise 282 * @param articleId the primary key of the web content article 283 * @param autoArticleId whether to auto generate the web content article ID 284 * @param version the web content article's version 285 * @param titleMap the web content article's locales and localized titles 286 * @param descriptionMap the web content article's locales and localized 287 descriptions 288 * @param content the HTML content wrapped in XML. For more information, 289 see the content example in the class description for {@link 290 JournalArticleLocalServiceImpl}. 291 * @param type the structure's type, if the web content article is related 292 to a DDM structure. For more information, see {@link 293 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 294 * @param ddmStructureKey the primary key of the web content article's DDM 295 structure, if the article is related to a DDM structure, or 296 <code>null</code> otherwise 297 * @param ddmTemplateKey the primary key of the web content article's DDM 298 template (optionally <code>null</code>). If the article is 299 related to a DDM structure, the template's structure must match 300 it. 301 * @param layoutUuid the unique string identifying the web content 302 article's display page 303 * @param displayDateMonth the month the web content article is set to 304 display 305 * @param displayDateDay the calendar day the web content article is set to 306 display 307 * @param displayDateYear the year the web content article is set to 308 display 309 * @param displayDateHour the hour the web content article is set to 310 display 311 * @param displayDateMinute the minute the web content article is set to 312 display 313 * @param expirationDateMonth the month the web content article is set to 314 expire 315 * @param expirationDateDay the calendar day the web content article is set 316 to expire 317 * @param expirationDateYear the year the web content article is set to 318 expire 319 * @param expirationDateHour the hour the web content article is set to 320 expire 321 * @param expirationDateMinute the minute the web content article is set to 322 expire 323 * @param neverExpire whether the web content article is not set to auto 324 expire 325 * @param reviewDateMonth the month the web content article is set for 326 review 327 * @param reviewDateDay the calendar day the web content article is set for 328 review 329 * @param reviewDateYear the year the web content article is set for review 330 * @param reviewDateHour the hour the web content article is set for review 331 * @param reviewDateMinute the minute the web content article is set for 332 review 333 * @param neverReview whether the web content article is not set for review 334 * @param indexable whether the web content article is searchable 335 * @param smallImage whether the web content article has a small image 336 * @param smallImageURL the web content article's small image URL 337 * @param smallImageFile the web content article's small image file 338 * @param images the web content's images 339 * @param articleURL the web content article's accessible URL 340 * @param serviceContext the service context to be applied. Can set the 341 UUID, creation date, modification date, expando bridge 342 attributes, guest permissions, group permissions, asset category 343 IDs, asset tag names, asset link entry IDs, the "urlTitle" 344 attribute, and workflow actions for the web content article. Can 345 also set whether to add the default guest and group permissions. 346 * @return the web content article 347 * @throws PortalException if a portal exception occurred 348 * @throws SystemException if a system exception occurred 349 */ 350 public com.liferay.portlet.journal.model.JournalArticle addArticle( 351 long userId, long groupId, long folderId, long classNameId, 352 long classPK, java.lang.String articleId, boolean autoArticleId, 353 double version, 354 java.util.Map<java.util.Locale, java.lang.String> titleMap, 355 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 356 java.lang.String content, java.lang.String type, 357 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 358 java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, 359 int displayDateYear, int displayDateHour, int displayDateMinute, 360 int expirationDateMonth, int expirationDateDay, int expirationDateYear, 361 int expirationDateHour, int expirationDateMinute, boolean neverExpire, 362 int reviewDateMonth, int reviewDateDay, int reviewDateYear, 363 int reviewDateHour, int reviewDateMinute, boolean neverReview, 364 boolean indexable, boolean smallImage, java.lang.String smallImageURL, 365 java.io.File smallImageFile, 366 java.util.Map<java.lang.String, byte[]> images, 367 java.lang.String articleURL, 368 com.liferay.portal.service.ServiceContext serviceContext) 369 throws com.liferay.portal.kernel.exception.PortalException, 370 com.liferay.portal.kernel.exception.SystemException { 371 return _journalArticleLocalService.addArticle(userId, groupId, 372 folderId, classNameId, classPK, articleId, autoArticleId, version, 373 titleMap, descriptionMap, content, type, ddmStructureKey, 374 ddmTemplateKey, layoutUuid, displayDateMonth, displayDateDay, 375 displayDateYear, displayDateHour, displayDateMinute, 376 expirationDateMonth, expirationDateDay, expirationDateYear, 377 expirationDateHour, expirationDateMinute, neverExpire, 378 reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour, 379 reviewDateMinute, neverReview, indexable, smallImage, 380 smallImageURL, smallImageFile, images, articleURL, serviceContext); 381 } 382 383 /** 384 * Adds a web content article. 385 * 386 * @param userId the primary key of the web content article's creator/owner 387 * @param groupId the primary key of the web content article's group 388 * @param folderId the primary key of the web content article folder 389 * @param titleMap the web content article's locales and localized titles 390 * @param descriptionMap the web content article's locales and localized 391 descriptions 392 * @param content the HTML content wrapped in XML. For more information, 393 see the content example in the class description for {@link 394 JournalArticleLocalServiceImpl}. 395 * @param ddmStructureKey the primary key of the web content article's DDM 396 structure, if the article is related to a DDM structure, or 397 <code>null</code> otherwise 398 * @param ddmTemplateKey the primary key of the web content article's DDM 399 template (optionally <code>null</code>). If the article is 400 related to a DDM structure, the template's structure must match 401 it. 402 * @param serviceContext the service context to be applied. Can set the 403 UUID, creation date, modification date, expando bridge 404 attributes, guest permissions, group permissions, asset category 405 IDs, asset tag names, asset link entry IDs, the "urlTitle" 406 attribute, and workflow actions for the web content article. Can 407 also set whether to add the default guest and group permissions. 408 * @return the web content article 409 * @throws PortalException if a portal exception occurred 410 * @throws SystemException if a system exception occurred 411 */ 412 public com.liferay.portlet.journal.model.JournalArticle addArticle( 413 long userId, long groupId, long folderId, 414 java.util.Map<java.util.Locale, java.lang.String> titleMap, 415 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 416 java.lang.String content, java.lang.String ddmStructureKey, 417 java.lang.String ddmTemplateKey, 418 com.liferay.portal.service.ServiceContext serviceContext) 419 throws com.liferay.portal.kernel.exception.PortalException, 420 com.liferay.portal.kernel.exception.SystemException { 421 return _journalArticleLocalService.addArticle(userId, groupId, 422 folderId, titleMap, descriptionMap, content, ddmStructureKey, 423 ddmTemplateKey, serviceContext); 424 } 425 426 /** 427 * Adds the resources to the web content article. 428 * 429 * @param article the web content article 430 * @param addGroupPermissions whether to add group permissions 431 * @param addGuestPermissions whether to add guest permissions 432 * @throws PortalException if no portal actions could be found associated 433 with the web content article or if a portal exception occurred 434 * @throws SystemException if a system exception occurred 435 */ 436 public void addArticleResources( 437 com.liferay.portlet.journal.model.JournalArticle article, 438 boolean addGroupPermissions, boolean addGuestPermissions) 439 throws com.liferay.portal.kernel.exception.PortalException, 440 com.liferay.portal.kernel.exception.SystemException { 441 _journalArticleLocalService.addArticleResources(article, 442 addGroupPermissions, addGuestPermissions); 443 } 444 445 /** 446 * Adds the model resources with the permissions to the web content article. 447 * 448 * @param article the web content article to add resources to 449 * @param groupPermissions the group permissions to be added 450 * @param guestPermissions the guest permissions to be added 451 * @throws PortalException if a portal exception occurred 452 * @throws SystemException if a system exception occurred 453 */ 454 public void addArticleResources( 455 com.liferay.portlet.journal.model.JournalArticle article, 456 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 457 throws com.liferay.portal.kernel.exception.PortalException, 458 com.liferay.portal.kernel.exception.SystemException { 459 _journalArticleLocalService.addArticleResources(article, 460 groupPermissions, guestPermissions); 461 } 462 463 /** 464 * Adds the resources to the most recently created web content article. 465 * 466 * @param groupId the primary key of the web content article's group 467 * @param articleId the primary key of the web content article 468 * @param addGroupPermissions whether to add group permissions 469 * @param addGuestPermissions whether to add guest permissions 470 * @throws PortalException if a portal exception occurred 471 * @throws SystemException if a system exception occurred 472 */ 473 public void addArticleResources(long groupId, java.lang.String articleId, 474 boolean addGroupPermissions, boolean addGuestPermissions) 475 throws com.liferay.portal.kernel.exception.PortalException, 476 com.liferay.portal.kernel.exception.SystemException { 477 _journalArticleLocalService.addArticleResources(groupId, articleId, 478 addGroupPermissions, addGuestPermissions); 479 } 480 481 /** 482 * Adds the resources with the permissions to the most recently created web 483 * content article. 484 * 485 * @param groupId the primary key of the web content article's group 486 * @param articleId the primary key of the web content article 487 * @param groupPermissions the group permissions to be added 488 * @param guestPermissions the guest permissions to be added 489 * @throws PortalException if a portal exception occurred 490 * @throws SystemException if a system exception occurred 491 */ 492 public void addArticleResources(long groupId, java.lang.String articleId, 493 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 494 throws com.liferay.portal.kernel.exception.PortalException, 495 com.liferay.portal.kernel.exception.SystemException { 496 _journalArticleLocalService.addArticleResources(groupId, articleId, 497 groupPermissions, guestPermissions); 498 } 499 500 /** 501 * Returns the web content article with the group, article ID, and version. 502 * This method checks for the article's resource primary key and, if not 503 * found, creates a new one. 504 * 505 * @param groupId the primary key of the web content article's group 506 * @param articleId the primary key of the web content article 507 * @param version the web content article's version 508 * @return the matching web content article 509 * @throws PortalException if a matching web content article could not be 510 found 511 * @throws SystemException if a system exception occurred 512 */ 513 public com.liferay.portlet.journal.model.JournalArticle checkArticleResourcePrimKey( 514 long groupId, java.lang.String articleId, double version) 515 throws com.liferay.portal.kernel.exception.PortalException, 516 com.liferay.portal.kernel.exception.SystemException { 517 return _journalArticleLocalService.checkArticleResourcePrimKey(groupId, 518 articleId, version); 519 } 520 521 /** 522 * Checks all web content articles by handling their expirations and sending 523 * review notifications based on their current workflow. 524 * 525 * @throws PortalException if a portal exception occurred 526 * @throws SystemException if a system exception occurred 527 */ 528 public void checkArticles() 529 throws com.liferay.portal.kernel.exception.PortalException, 530 com.liferay.portal.kernel.exception.SystemException { 531 _journalArticleLocalService.checkArticles(); 532 } 533 534 /** 535 * Checks the web content article matching the group, article ID, and 536 * version, replacing escaped newline and return characters with non-escaped 537 * newline and return characters. 538 * 539 * @param groupId the primary key of the web content article's group 540 * @param articleId the primary key of the web content article 541 * @param version the web content article's version 542 * @throws PortalException if a matching web content article could not be 543 found 544 * @throws SystemException if a system exception occurred 545 */ 546 public void checkNewLine(long groupId, java.lang.String articleId, 547 double version) 548 throws com.liferay.portal.kernel.exception.PortalException, 549 com.liferay.portal.kernel.exception.SystemException { 550 _journalArticleLocalService.checkNewLine(groupId, articleId, version); 551 } 552 553 /** 554 * Checks the web content article matching the group, article ID, and 555 * version for an associated structure. If no structure is associated, 556 * return; otherwise check that the article and structure match. 557 * 558 * @param groupId the primary key of the web content article's group 559 * @param articleId the primary key of the web content article 560 * @param version the web content article's version 561 * @throws PortalException if a matching web content article could not be 562 found, if the article's structure does not match it, or if a 563 portal exception occurred 564 * @throws SystemException if a system exception occurred 565 */ 566 public void checkStructure(long groupId, java.lang.String articleId, 567 double version) 568 throws com.liferay.portal.kernel.exception.PortalException, 569 com.liferay.portal.kernel.exception.SystemException { 570 _journalArticleLocalService.checkStructure(groupId, articleId, version); 571 } 572 573 /** 574 * Copies the web content article matching the group, article ID, and 575 * version. This method creates a new article, extracting all the values 576 * from the old one and updating its article ID. 577 * 578 * @param userId the primary key of the web content article's creator/owner 579 * @param groupId the primary key of the web content article's group 580 * @param oldArticleId the primary key of the old web content article 581 * @param newArticleId the primary key of the new web content article 582 * @param autoArticleId whether to auto-generate the web content article ID 583 * @param version the web content article's version 584 * @return the new web content article 585 * @throws PortalException if a matching web content article could not be 586 found or if a portal exception occurred 587 * @throws SystemException if a system exception occurred 588 */ 589 public com.liferay.portlet.journal.model.JournalArticle copyArticle( 590 long userId, long groupId, java.lang.String oldArticleId, 591 java.lang.String newArticleId, boolean autoArticleId, double version) 592 throws com.liferay.portal.kernel.exception.PortalException, 593 com.liferay.portal.kernel.exception.SystemException { 594 return _journalArticleLocalService.copyArticle(userId, groupId, 595 oldArticleId, newArticleId, autoArticleId, version); 596 } 597 598 /** 599 * Deletes the web content article and its resources. 600 * 601 * @param article the web content article 602 * @throws PortalException if a portal exception occurred 603 * @throws SystemException if a system exception occurred 604 */ 605 public void deleteArticle( 606 com.liferay.portlet.journal.model.JournalArticle article) 607 throws com.liferay.portal.kernel.exception.PortalException, 608 com.liferay.portal.kernel.exception.SystemException { 609 _journalArticleLocalService.deleteArticle(article); 610 } 611 612 /** 613 * Deletes the web content article and its resources, optionally sending 614 * email notifying denial of the article if it had not yet been approved. 615 * 616 * @param article the web content article 617 * @param articleURL the web content article's accessible URL to include in 618 email notifications (optionally <code>null</code>) 619 * @param serviceContext the service context to be applied (optionally 620 <code>null</code>). Can set the portlet preferences that include 621 email information to notify recipients of the unapproved web 622 content's denial. 623 * @throws PortalException if a portal exception occurred 624 * @throws SystemException if a system exception occurred 625 */ 626 public void deleteArticle( 627 com.liferay.portlet.journal.model.JournalArticle article, 628 java.lang.String articleURL, 629 com.liferay.portal.service.ServiceContext serviceContext) 630 throws com.liferay.portal.kernel.exception.PortalException, 631 com.liferay.portal.kernel.exception.SystemException { 632 _journalArticleLocalService.deleteArticle(article, articleURL, 633 serviceContext); 634 } 635 636 /** 637 * Deletes the web content article and its resources matching the group, 638 * article ID, and version, optionally sending email notifying denial of the 639 * web content article if it had not yet been approved. 640 * 641 * @param groupId the primary key of the web content article's group 642 * @param articleId the primary key of the web content article 643 * @param version the web content article's version 644 * @param articleURL the web content article's accessible URL 645 * @param serviceContext the service context to be applied. Can set the 646 portlet preferences that include email information to notify 647 recipients of the unapproved web content article's denial. 648 * @throws PortalException if a matching web content article could not be 649 found or if a portal exception occurred 650 * @throws SystemException if a system exception occurred 651 */ 652 public void deleteArticle(long groupId, java.lang.String articleId, 653 double version, java.lang.String articleURL, 654 com.liferay.portal.service.ServiceContext serviceContext) 655 throws com.liferay.portal.kernel.exception.PortalException, 656 com.liferay.portal.kernel.exception.SystemException { 657 _journalArticleLocalService.deleteArticle(groupId, articleId, version, 658 articleURL, serviceContext); 659 } 660 661 /** 662 * Deletes all web content articles and their resources matching the group 663 * and article ID, optionally sending email notifying denial of article if 664 * it had not yet been approved. 665 * 666 * @param groupId the primary key of the web content article's group 667 * @param articleId the primary key of the web content article 668 * @param serviceContext the service context to be applied. Can set the 669 portlet preferences that include email information to notify 670 recipients of the unapproved web content article's denial. 671 * @throws PortalException if a portal exception occurred 672 * @throws SystemException if a system exception occurred 673 */ 674 public void deleteArticle(long groupId, java.lang.String articleId, 675 com.liferay.portal.service.ServiceContext serviceContext) 676 throws com.liferay.portal.kernel.exception.PortalException, 677 com.liferay.portal.kernel.exception.SystemException { 678 _journalArticleLocalService.deleteArticle(groupId, articleId, 679 serviceContext); 680 } 681 682 /** 683 * Deletes all the group's web content articles and resources. 684 * 685 * @param groupId the primary key of the web content article's group 686 * @throws PortalException if a portal exception occurred 687 * @throws SystemException if a system exception occurred 688 */ 689 public void deleteArticles(long groupId) 690 throws com.liferay.portal.kernel.exception.PortalException, 691 com.liferay.portal.kernel.exception.SystemException { 692 _journalArticleLocalService.deleteArticles(groupId); 693 } 694 695 /** 696 * Deletes all the group's web content articles and resources in the folder, 697 * including recycled articles. 698 * 699 * @param groupId the primary key of the web content article's group 700 * @param folderId the primary key of the web content article folder 701 * @throws PortalException if a portal exception occurred 702 * @throws SystemException if a system exception occurred 703 */ 704 public void deleteArticles(long groupId, long folderId) 705 throws com.liferay.portal.kernel.exception.PortalException, 706 com.liferay.portal.kernel.exception.SystemException { 707 _journalArticleLocalService.deleteArticles(groupId, folderId); 708 } 709 710 /** 711 * Deletes all the group's web content articles and resources in the folder, 712 * optionally including recycled articles. 713 * 714 * @param groupId the primary key of the web content article's group 715 * @param folderId the primary key of the web content article folder 716 * @param includeTrashedEntries whether to include recycled web content 717 articles 718 * @throws PortalException if a portal exception occurred 719 * @throws SystemException if a system exception occurred 720 */ 721 public void deleteArticles(long groupId, long folderId, 722 boolean includeTrashedEntries) 723 throws com.liferay.portal.kernel.exception.PortalException, 724 com.liferay.portal.kernel.exception.SystemException { 725 _journalArticleLocalService.deleteArticles(groupId, folderId, 726 includeTrashedEntries); 727 } 728 729 /** 730 * Deletes the layout's association with the web content articles for the 731 * group. 732 * 733 * @param groupId the primary key of the web content article's group 734 * @param layoutUuid the unique string identifying the web content 735 article's display page 736 * @throws SystemException if a system exception occurred 737 */ 738 public void deleteLayoutArticleReferences(long groupId, 739 java.lang.String layoutUuid) 740 throws com.liferay.portal.kernel.exception.SystemException { 741 _journalArticleLocalService.deleteLayoutArticleReferences(groupId, 742 layoutUuid); 743 } 744 745 /** 746 * Expires the web content article matching the group, article ID, and 747 * version. 748 * 749 * @param userId the primary key of the user updating the web content 750 article 751 * @param groupId the primary key of the web content article's group 752 * @param articleId the primary key of the web content article 753 * @param version the web content article's version 754 * @param articleURL the web content article's accessible URL 755 * @param serviceContext the service context to be applied. Can set the 756 modification date, status date, portlet preferences, and can set 757 whether to add the default command update for the web content 758 article. With respect to social activities, by setting the 759 service context's command to {@link 760 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 761 is considered a web content update activity; otherwise it is 762 considered a web content add activity. 763 * @return the web content article 764 * @throws PortalException if a matching web content article could not be 765 found or if a portal exception occurred 766 * @throws SystemException if a system exception occurred 767 */ 768 public com.liferay.portlet.journal.model.JournalArticle expireArticle( 769 long userId, long groupId, java.lang.String articleId, double version, 770 java.lang.String articleURL, 771 com.liferay.portal.service.ServiceContext serviceContext) 772 throws com.liferay.portal.kernel.exception.PortalException, 773 com.liferay.portal.kernel.exception.SystemException { 774 return _journalArticleLocalService.expireArticle(userId, groupId, 775 articleId, version, articleURL, serviceContext); 776 } 777 778 /** 779 * Expires the web content article matching the group and article ID, 780 * expiring all of its versions if the 781 * <code>journal.article.expire.all.versions</code> portal property is 782 * <code>true</code>, otherwise expiring only its latest approved version. 783 * 784 * @param userId the primary key of the user updating the web content 785 article 786 * @param groupId the primary key of the web content article's group 787 * @param articleId the primary key of the web content article 788 * @param articleURL the web content article's accessible URL 789 * @param serviceContext the service context to be applied. Can set the 790 modification date, status date, portlet preferences, and can set 791 whether to add the default command update for the web content 792 article. With respect to social activities, by setting the 793 service context's command to {@link 794 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 795 is considered a web content update activity; otherwise it is 796 considered a web content add activity. 797 * @throws PortalException if a matching web content article could not be 798 found or if a portal exception occurred 799 * @throws SystemException if a system exception occurred 800 */ 801 public void expireArticle(long userId, long groupId, 802 java.lang.String articleId, java.lang.String articleURL, 803 com.liferay.portal.service.ServiceContext serviceContext) 804 throws com.liferay.portal.kernel.exception.PortalException, 805 com.liferay.portal.kernel.exception.SystemException { 806 _journalArticleLocalService.expireArticle(userId, groupId, articleId, 807 articleURL, serviceContext); 808 } 809 810 /** 811 * Returns the web content article matching the UUID and group. 812 * 813 * @param uuid the web content article's UUID 814 * @param groupId the primary key of the web content article's group 815 * @return the matching web content article 816 * @throws SystemException if a system exception occurred 817 */ 818 public com.liferay.portlet.journal.model.JournalArticle fetchArticle( 819 java.lang.String uuid, long groupId) 820 throws com.liferay.portal.kernel.exception.SystemException { 821 return _journalArticleLocalService.fetchArticle(uuid, groupId); 822 } 823 824 /** 825 * Returns the web content article with the ID. 826 * 827 * @param id the primary key of the web content article 828 * @return the web content article with the ID 829 * @throws PortalException if a matching web content article could not be 830 found 831 * @throws SystemException if a system exception occurred 832 */ 833 public com.liferay.portlet.journal.model.JournalArticle getArticle(long id) 834 throws com.liferay.portal.kernel.exception.PortalException, 835 com.liferay.portal.kernel.exception.SystemException { 836 return _journalArticleLocalService.getArticle(id); 837 } 838 839 /** 840 * Returns the latest approved web content article, or the latest unapproved 841 * article if none are approved. Both approved and unapproved articles must 842 * match the group and article ID. 843 * 844 * @param groupId the primary key of the web content article's group 845 * @param articleId the primary key of the web content article 846 * @return the matching web content article 847 * @throws PortalException if a matching web content article could not be 848 found 849 * @throws SystemException if a system exception occurred 850 */ 851 public com.liferay.portlet.journal.model.JournalArticle getArticle( 852 long groupId, java.lang.String articleId) 853 throws com.liferay.portal.kernel.exception.PortalException, 854 com.liferay.portal.kernel.exception.SystemException { 855 return _journalArticleLocalService.getArticle(groupId, articleId); 856 } 857 858 /** 859 * Returns the web content article matching the group, article ID, and 860 * version. 861 * 862 * @param groupId the primary key of the web content article's group 863 * @param articleId the primary key of the web content article 864 * @param version the web content article's version 865 * @return the matching web content article 866 * @throws PortalException if a matching web content article could not be 867 found 868 * @throws SystemException if a system exception occurred 869 */ 870 public com.liferay.portlet.journal.model.JournalArticle getArticle( 871 long groupId, java.lang.String articleId, double version) 872 throws com.liferay.portal.kernel.exception.PortalException, 873 com.liferay.portal.kernel.exception.SystemException { 874 return _journalArticleLocalService.getArticle(groupId, articleId, 875 version); 876 } 877 878 /** 879 * Returns the web content article matching the group, class name, and class 880 * PK. 881 * 882 * @param groupId the primary key of the web content article's group 883 * @param className the DDMStructure class name if the web content article 884 is related to a DDM structure, the primary key of the class name 885 associated with the article, or {@link 886 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 887 * @param classPK the primary key of the DDM structure, if the the 888 DDMStructure class name is given as the <code>className</code> 889 parameter, the primary key of the class associated with the web 890 content article, or <code>0</code> otherwise 891 * @return the matching web content article 892 * @throws PortalException if a matching web content article could not be 893 found 894 * @throws SystemException if a system exception occurred 895 */ 896 public com.liferay.portlet.journal.model.JournalArticle getArticle( 897 long groupId, java.lang.String className, long classPK) 898 throws com.liferay.portal.kernel.exception.PortalException, 899 com.liferay.portal.kernel.exception.SystemException { 900 return _journalArticleLocalService.getArticle(groupId, className, 901 classPK); 902 } 903 904 /** 905 * Returns the latest web content article that is approved, or the latest 906 * unapproved article if none are approved. Both approved and unapproved 907 * articles must match the group and URL title. 908 * 909 * @param groupId the primary key of the web content article's group 910 * @param urlTitle the web content article's accessible URL title 911 * @return the matching web content article 912 * @throws PortalException if a portal exception occurred 913 * @throws SystemException if a system exception occurred 914 */ 915 public com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle( 916 long groupId, java.lang.String urlTitle) 917 throws com.liferay.portal.kernel.exception.PortalException, 918 com.liferay.portal.kernel.exception.SystemException { 919 return _journalArticleLocalService.getArticleByUrlTitle(groupId, 920 urlTitle); 921 } 922 923 /** 924 * Returns the web content associated with the web content article and DDM 925 * template. 926 * 927 * @param article the web content article 928 * @param ddmTemplateKey the primary key of the web content article's DDM 929 template (optionally <code>null</code>). If the article is 930 related to a DDM structure, the template's structure must match 931 it. 932 * @param viewMode the mode in which the web content is being viewed 933 * @param languageId the primary key of the language translation to get 934 * @param themeDisplay the theme display 935 * @return the web content associated with the DDM template 936 * @throws PortalException if a matching DDM template could not be found or 937 if a portal exception occurred 938 * @throws SystemException if a system exception occurred 939 */ 940 public java.lang.String getArticleContent( 941 com.liferay.portlet.journal.model.JournalArticle article, 942 java.lang.String ddmTemplateKey, java.lang.String viewMode, 943 java.lang.String languageId, 944 com.liferay.portal.theme.ThemeDisplay themeDisplay) 945 throws com.liferay.portal.kernel.exception.PortalException, 946 com.liferay.portal.kernel.exception.SystemException { 947 return _journalArticleLocalService.getArticleContent(article, 948 ddmTemplateKey, viewMode, languageId, themeDisplay); 949 } 950 951 /** 952 * Returns the web content matching the group, article ID, and version, and 953 * associated with the DDM template. 954 * 955 * @param groupId the primary key of the web content article's group 956 * @param articleId the primary key of the web content article 957 * @param version the web content article's version 958 * @param viewMode the mode in which the web content is being viewed 959 * @param ddmTemplateKey the primary key of the web content article's DDM 960 template (optionally <code>null</code>). If the article is 961 related to a DDM structure, the template's structure must match 962 it. 963 * @param languageId the primary key of the language translation to get 964 * @param themeDisplay the theme display 965 * @return the matching web content 966 * @throws PortalException if a matching web content article or DDM template 967 could not be found, or if a portal exception occurred 968 * @throws SystemException if a system exception occurred 969 */ 970 public java.lang.String getArticleContent(long groupId, 971 java.lang.String articleId, double version, java.lang.String viewMode, 972 java.lang.String ddmTemplateKey, java.lang.String languageId, 973 com.liferay.portal.theme.ThemeDisplay themeDisplay) 974 throws com.liferay.portal.kernel.exception.PortalException, 975 com.liferay.portal.kernel.exception.SystemException { 976 return _journalArticleLocalService.getArticleContent(groupId, 977 articleId, version, viewMode, ddmTemplateKey, languageId, 978 themeDisplay); 979 } 980 981 /** 982 * Returns the web content matching the group, article ID, and version. 983 * 984 * @param groupId the primary key of the web content article's group 985 * @param articleId the primary key of the web content article 986 * @param version the web content article's version 987 * @param viewMode the mode in which the web content is being viewed 988 * @param languageId the primary key of the language translation to get 989 * @param themeDisplay the theme display 990 * @return the matching web content 991 * @throws PortalException if a matching web content article or DDM template 992 could not be found, or if a portal exception occurred 993 * @throws SystemException if a system exception occurred 994 */ 995 public java.lang.String getArticleContent(long groupId, 996 java.lang.String articleId, double version, java.lang.String viewMode, 997 java.lang.String languageId, 998 com.liferay.portal.theme.ThemeDisplay themeDisplay) 999 throws com.liferay.portal.kernel.exception.PortalException, 1000 com.liferay.portal.kernel.exception.SystemException { 1001 return _journalArticleLocalService.getArticleContent(groupId, 1002 articleId, version, viewMode, languageId, themeDisplay); 1003 } 1004 1005 /** 1006 * Returns the latest web content matching the group and article ID, and 1007 * associated with DDM template key. 1008 * 1009 * @param groupId the primary key of the web content article's group 1010 * @param articleId the primary key of the web content article 1011 * @param viewMode the mode in which the web content is being viewed 1012 * @param ddmTemplateKey the primary key of the web content article's DDM 1013 template (optionally <code>null</code>). If the article is 1014 related to a DDM structure, the template's structure must match 1015 it. 1016 * @param languageId the primary key of the language translation to get 1017 * @param themeDisplay the theme display 1018 * @return the matching web content 1019 * @throws PortalException if a matching web content article or DDM template 1020 could not be found, or if a portal exception occurred 1021 * @throws SystemException if a system exception occurred 1022 */ 1023 public java.lang.String getArticleContent(long groupId, 1024 java.lang.String articleId, java.lang.String viewMode, 1025 java.lang.String ddmTemplateKey, java.lang.String languageId, 1026 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1027 throws com.liferay.portal.kernel.exception.PortalException, 1028 com.liferay.portal.kernel.exception.SystemException { 1029 return _journalArticleLocalService.getArticleContent(groupId, 1030 articleId, viewMode, ddmTemplateKey, languageId, themeDisplay); 1031 } 1032 1033 /** 1034 * Returns the latest web content matching the group and article ID. 1035 * 1036 * @param groupId the primary key of the web content article's group 1037 * @param articleId the primary key of the web content article 1038 * @param viewMode the mode in which the web content is being viewed 1039 * @param languageId the primary key of the language translation to get 1040 * @param themeDisplay the theme display 1041 * @return the matching web content 1042 * @throws PortalException if a matching web content article or DDM template 1043 could not be found, or if a portal exception occurred 1044 * @throws SystemException if a system exception occurred 1045 */ 1046 public java.lang.String getArticleContent(long groupId, 1047 java.lang.String articleId, java.lang.String viewMode, 1048 java.lang.String languageId, 1049 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1050 throws com.liferay.portal.kernel.exception.PortalException, 1051 com.liferay.portal.kernel.exception.SystemException { 1052 return _journalArticleLocalService.getArticleContent(groupId, 1053 articleId, viewMode, languageId, themeDisplay); 1054 } 1055 1056 /** 1057 * Returns a web content article display for the specified page of the 1058 * latest version of the web content article, optionally based on the DDM 1059 * template if the article is template driven. If the article is template 1060 * driven, web content transformation tokens are added from the theme 1061 * display (if not <code>null</code>) or the XML request otherwise. 1062 * 1063 * @param article the web content article 1064 * @param ddmTemplateKey the primary key of the web content article's DDM 1065 template (optionally <code>null</code>). If the article is 1066 related to a DDM structure, the template's structure must match 1067 it. 1068 * @param viewMode the mode in which the web content is being viewed 1069 * @param languageId the primary key of the language translation to get 1070 * @param page the web content's page number. Page numbers start at 1071 <code>1</code>. 1072 * @param xmlRequest the request that serializes the web content into a 1073 hierarchical hash map (optionally <code>null</code>) 1074 * @param themeDisplay the theme display 1075 * @return the web content article display 1076 * @throws PortalException if a matching DDM template could not be found or 1077 if a portal exception occurred 1078 * @throws SystemException if a system exception occurred 1079 */ 1080 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1081 com.liferay.portlet.journal.model.JournalArticle article, 1082 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1083 java.lang.String languageId, int page, java.lang.String xmlRequest, 1084 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1085 throws com.liferay.portal.kernel.exception.PortalException, 1086 com.liferay.portal.kernel.exception.SystemException { 1087 return _journalArticleLocalService.getArticleDisplay(article, 1088 ddmTemplateKey, viewMode, languageId, page, xmlRequest, themeDisplay); 1089 } 1090 1091 /** 1092 * Returns a web content article display for the first page of the specified 1093 * version of the web content article, optionally based on the DDM template 1094 * if the article is template driven. If the article is template driven, web 1095 * content transformation tokens are added from the theme display (if not 1096 * <code>null</code>) or the XML request otherwise. 1097 * 1098 * @param groupId the primary key of the web content article's group 1099 * @param articleId the primary key of the web content article 1100 * @param version the web content article's version 1101 * @param ddmTemplateKey the primary key of the web content article's DDM 1102 template (optionally <code>null</code>). If the article is 1103 related to a DDM structure, the template's structure must match 1104 it. 1105 * @param viewMode the mode in which the web content is being viewed 1106 * @param languageId the primary key of the language translation to get 1107 * @param page the web content's page number 1108 * @param xmlRequest the request that serializes the web content into a 1109 hierarchical hash map 1110 * @param themeDisplay the theme display 1111 * @return the web content article display, or <code>null</code> if the 1112 article has expired or if article's display date/time is after 1113 the current date/time 1114 * @throws PortalException if a matching web content article or DDM template 1115 could not be found, or if a portal exception occurred 1116 * @throws SystemException if a system exception occurred 1117 */ 1118 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1119 long groupId, java.lang.String articleId, double version, 1120 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1121 java.lang.String languageId, int page, java.lang.String xmlRequest, 1122 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1123 throws com.liferay.portal.kernel.exception.PortalException, 1124 com.liferay.portal.kernel.exception.SystemException { 1125 return _journalArticleLocalService.getArticleDisplay(groupId, 1126 articleId, version, ddmTemplateKey, viewMode, languageId, page, 1127 xmlRequest, themeDisplay); 1128 } 1129 1130 /** 1131 * Returns a web content article display for the first page of the specified 1132 * version of the web content article matching the group and article ID, 1133 * optionally based on the DDM template if the article is template driven. 1134 * If the article is template driven, web content transformation tokens are 1135 * added from the theme display (if not <code>null</code>). 1136 * 1137 * @param groupId the primary key of the web content article's group 1138 * @param articleId the primary key of the web content article 1139 * @param version the web content article's version 1140 * @param ddmTemplateKey the primary key of the web content article's DDM 1141 template (optionally <code>null</code>). If the article is 1142 related to a DDM structure, the template's structure must match 1143 it. 1144 * @param viewMode the mode in which the web content is being viewed 1145 * @param languageId the primary key of the language translation to get 1146 * @param themeDisplay the theme display 1147 * @return the web content article display, or <code>null</code> if the 1148 article has expired or if article's display date/time is after 1149 the current date/time 1150 * @throws PortalException if a matching web content article or DDM template 1151 could not be found, or if a portal exception occurred 1152 * @throws SystemException if a system exception occurred 1153 */ 1154 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1155 long groupId, java.lang.String articleId, double version, 1156 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1157 java.lang.String languageId, 1158 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1159 throws com.liferay.portal.kernel.exception.PortalException, 1160 com.liferay.portal.kernel.exception.SystemException { 1161 return _journalArticleLocalService.getArticleDisplay(groupId, 1162 articleId, version, ddmTemplateKey, viewMode, languageId, 1163 themeDisplay); 1164 } 1165 1166 /** 1167 * Returns a web content article display for the first page of the latest 1168 * version of the web content article matching the group and article ID. If 1169 * the article is template driven, web content transformation tokens are 1170 * added from the theme display (if not <code>null</code>) or the XML 1171 * request otherwise. 1172 * 1173 * @param groupId the primary key of the web content article's group 1174 * @param articleId the primary key of the web content article 1175 * @param viewMode the mode in which the web content is being viewed 1176 * @param languageId the primary key of the language translation to get 1177 * @param page the web content's page number 1178 * @param xmlRequest the request that serializes the web content into a 1179 hierarchical hash map 1180 * @param themeDisplay the theme display 1181 * @return the web content article display, or <code>null</code> if the 1182 article has expired or if article's display date/time is after 1183 the current date/time 1184 * @throws PortalException if a matching web content article or DDM template 1185 could not be found, or if a portal exception occurred 1186 * @throws SystemException if a system exception occurred 1187 */ 1188 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1189 long groupId, java.lang.String articleId, java.lang.String viewMode, 1190 java.lang.String languageId, int page, java.lang.String xmlRequest, 1191 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1192 throws com.liferay.portal.kernel.exception.PortalException, 1193 com.liferay.portal.kernel.exception.SystemException { 1194 return _journalArticleLocalService.getArticleDisplay(groupId, 1195 articleId, viewMode, languageId, page, xmlRequest, themeDisplay); 1196 } 1197 1198 /** 1199 * Returns a web content article display for the specified page of the 1200 * latest version of the web content article matching the group and article 1201 * ID, optionally based on the DDM template if the article is template 1202 * driven. If the article is template driven, web content transformation 1203 * tokens are added from the theme display (if not <code>null</code>) or the 1204 * XML request otherwise. 1205 * 1206 * @param groupId the primary key of the web content article's group 1207 * @param articleId the primary key of the web content article 1208 * @param ddmTemplateKey the primary key of the web content article's DDM 1209 template (optionally <code>null</code>). If the article is 1210 related to a DDM structure, the template's structure must match 1211 it. 1212 * @param viewMode the mode in which the web content is being viewed 1213 * @param languageId the primary key of the language translation to get 1214 * @param page the web content's page number 1215 * @param xmlRequest the request that serializes the web content into a 1216 hierarchical hash map 1217 * @param themeDisplay the theme display 1218 * @return the web content article display, or <code>null</code> if the 1219 article has expired or if article's display date/time is after 1220 the current date/time 1221 * @throws PortalException if a matching web content article or DDM template 1222 could not be found, or if a portal exception occurred 1223 * @throws SystemException if a system exception occurred 1224 */ 1225 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1226 long groupId, java.lang.String articleId, 1227 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1228 java.lang.String languageId, int page, java.lang.String xmlRequest, 1229 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1230 throws com.liferay.portal.kernel.exception.PortalException, 1231 com.liferay.portal.kernel.exception.SystemException { 1232 return _journalArticleLocalService.getArticleDisplay(groupId, 1233 articleId, ddmTemplateKey, viewMode, languageId, page, xmlRequest, 1234 themeDisplay); 1235 } 1236 1237 /** 1238 * Returns a web content article display for the first page of the latest 1239 * version of the web content article matching the group and article ID, 1240 * optionally based on the DDM template if the article is template driven. 1241 * If the article is template driven, web content transformation tokens are 1242 * added from the theme display (if not <code>null</code>). 1243 * 1244 * @param groupId the primary key of the web content article's group 1245 * @param articleId the primary key of the web content article 1246 * @param ddmTemplateKey the primary key of the web content article's DDM 1247 template (optionally <code>null</code>). If the article is 1248 related to a DDM structure, the template's structure must match 1249 it. 1250 * @param viewMode the mode in which the web content is being viewed 1251 * @param languageId the primary key of the language translation to get 1252 * @param themeDisplay the theme display 1253 * @return the web content article display, or <code>null</code> if the 1254 article has expired or if article's display date/time is after 1255 the current date/time 1256 * @throws PortalException if a matching web content article or DDM template 1257 could not be found, or if a portal exception occurred 1258 * @throws SystemException if a system exception occurred 1259 */ 1260 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1261 long groupId, java.lang.String articleId, 1262 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1263 java.lang.String languageId, 1264 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1265 throws com.liferay.portal.kernel.exception.PortalException, 1266 com.liferay.portal.kernel.exception.SystemException { 1267 return _journalArticleLocalService.getArticleDisplay(groupId, 1268 articleId, ddmTemplateKey, viewMode, languageId, themeDisplay); 1269 } 1270 1271 /** 1272 * Returns a web content article display for the first page of the latest 1273 * version of the web content article matching the group and article ID. If 1274 * the article is template driven, web content transformation tokens are 1275 * added from the theme display (if not <code>null</code>). 1276 * 1277 * @param groupId the primary key of the web content article's group 1278 * @param articleId the primary key of the web content article 1279 * @param viewMode the mode in which the web content is being viewed 1280 * @param languageId the primary key of the language translation to get 1281 * @param themeDisplay the theme display 1282 * @return the web content article display, or <code>null</code> if the 1283 article has expired or if article's display date/time is after 1284 the current date/time 1285 * @throws PortalException if a matching web content article or DDM template 1286 could not be found, or if a portal exception occurred 1287 * @throws SystemException if a system exception occurred 1288 */ 1289 public com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1290 long groupId, java.lang.String articleId, java.lang.String viewMode, 1291 java.lang.String languageId, 1292 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1293 throws com.liferay.portal.kernel.exception.PortalException, 1294 com.liferay.portal.kernel.exception.SystemException { 1295 return _journalArticleLocalService.getArticleDisplay(groupId, 1296 articleId, viewMode, languageId, themeDisplay); 1297 } 1298 1299 /** 1300 * Returns all the web content articles present in the system. 1301 * 1302 * @return the web content articles present in the system 1303 * @throws SystemException if a system exception occurred 1304 */ 1305 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles() 1306 throws com.liferay.portal.kernel.exception.SystemException { 1307 return _journalArticleLocalService.getArticles(); 1308 } 1309 1310 /** 1311 * Returns all the web content articles belonging to the group. 1312 * 1313 * @param groupId the primary key of the web content article's group 1314 * @return the web content articles belonging to the group 1315 * @throws SystemException if a system exception occurred 1316 */ 1317 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1318 long groupId) 1319 throws com.liferay.portal.kernel.exception.SystemException { 1320 return _journalArticleLocalService.getArticles(groupId); 1321 } 1322 1323 /** 1324 * Returns a range of all the web content articles belonging to the group. 1325 * 1326 * <p> 1327 * Useful when paginating results. Returns a maximum of <code>end - 1328 * start</code> instances. <code>start</code> and <code>end</code> are not 1329 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1330 * refers to the first result in the set. Setting both <code>start</code> 1331 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1332 * result set. 1333 * </p> 1334 * 1335 * @param groupId the primary key of the web content article's group 1336 * @param start the lower bound of the range of web content articles to 1337 return 1338 * @param end the upper bound of the range of web content articles to 1339 return (not inclusive) 1340 * @return the range of matching web content articles 1341 * @throws SystemException if a system exception occurred 1342 */ 1343 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1344 long groupId, int start, int end) 1345 throws com.liferay.portal.kernel.exception.SystemException { 1346 return _journalArticleLocalService.getArticles(groupId, start, end); 1347 } 1348 1349 /** 1350 * Returns an ordered range of all the web content articles belonging to the 1351 * group. 1352 * 1353 * <p> 1354 * Useful when paginating results. Returns a maximum of <code>end - 1355 * start</code> instances. <code>start</code> and <code>end</code> are not 1356 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1357 * refers to the first result in the set. Setting both <code>start</code> 1358 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1359 * result set. 1360 * </p> 1361 * 1362 * @param groupId the primary key of the web content article's group 1363 * @param start the lower bound of the range of web content articles to 1364 return 1365 * @param end the upper bound of the range of web content articles to 1366 return (not inclusive) 1367 * @param obc the comparator to order the web content articles 1368 * @return the range of matching web content articles ordered by the 1369 comparator 1370 * @throws SystemException if a system exception occurred 1371 */ 1372 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1373 long groupId, int start, int end, 1374 com.liferay.portal.kernel.util.OrderByComparator obc) 1375 throws com.liferay.portal.kernel.exception.SystemException { 1376 return _journalArticleLocalService.getArticles(groupId, start, end, obc); 1377 } 1378 1379 /** 1380 * Returns all the web content articles matching the group and folder. 1381 * 1382 * @param groupId the primary key of the web content article's group 1383 * @param folderId the primary key of the web content article folder 1384 * @return the matching web content articles 1385 * @throws SystemException if a system exception occurred 1386 */ 1387 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1388 long groupId, long folderId) 1389 throws com.liferay.portal.kernel.exception.SystemException { 1390 return _journalArticleLocalService.getArticles(groupId, folderId); 1391 } 1392 1393 /** 1394 * Returns a range of all the web content articles matching the group and 1395 * folder. 1396 * 1397 * <p> 1398 * Useful when paginating results. Returns a maximum of <code>end - 1399 * start</code> instances. <code>start</code> and <code>end</code> are not 1400 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1401 * refers to the first result in the set. Setting both <code>start</code> 1402 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1403 * result set. 1404 * </p> 1405 * 1406 * @param groupId the primary key of the web content article's group 1407 * @param folderId the primary key of the web content article's folder 1408 * @param start the lower bound of the range of web content articles to 1409 return 1410 * @param end the upper bound of the range of web content articles to 1411 return (not inclusive) 1412 * @return the range of matching web content articles 1413 * @throws SystemException if a system exception occurred 1414 */ 1415 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1416 long groupId, long folderId, int start, int end) 1417 throws com.liferay.portal.kernel.exception.SystemException { 1418 return _journalArticleLocalService.getArticles(groupId, folderId, 1419 start, end); 1420 } 1421 1422 /** 1423 * Returns an ordered range of all the web content articles matching the 1424 * group and folder. 1425 * 1426 * <p> 1427 * Useful when paginating results. Returns a maximum of <code>end - 1428 * start</code> instances. <code>start</code> and <code>end</code> are not 1429 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1430 * refers to the first result in the set. Setting both <code>start</code> 1431 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1432 * result set. 1433 * </p> 1434 * 1435 * @param groupId the primary key of the web content article's group 1436 * @param folderId the primary key of the web content article's folder 1437 * @param start the lower bound of the range of web content articles to 1438 return 1439 * @param end the upper bound of the range of web content articles to 1440 return (not inclusive) 1441 * @param orderByComparator the comparator to order the web content 1442 articles 1443 * @return the range of matching web content articles ordered by the 1444 comparator 1445 * @throws SystemException if a system exception occurred 1446 */ 1447 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1448 long groupId, long folderId, int start, int end, 1449 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 1450 throws com.liferay.portal.kernel.exception.SystemException { 1451 return _journalArticleLocalService.getArticles(groupId, folderId, 1452 start, end, orderByComparator); 1453 } 1454 1455 /** 1456 * Returns all the web content articles matching the group and article ID. 1457 * 1458 * @param groupId the primary key of the web content article's group 1459 * @param articleId the primary key of the web content article 1460 * @return the matching web content articles 1461 * @throws SystemException if a system exception occurred 1462 */ 1463 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1464 long groupId, java.lang.String articleId) 1465 throws com.liferay.portal.kernel.exception.SystemException { 1466 return _journalArticleLocalService.getArticles(groupId, articleId); 1467 } 1468 1469 /** 1470 * Returns all the web content articles matching the small image ID. 1471 * 1472 * @param smallImageId the primary key of the web content article's small 1473 image 1474 * @return the web content articles matching the small image ID 1475 * @throws SystemException if a system exception occurred 1476 */ 1477 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesBySmallImageId( 1478 long smallImageId) 1479 throws com.liferay.portal.kernel.exception.SystemException { 1480 return _journalArticleLocalService.getArticlesBySmallImageId(smallImageId); 1481 } 1482 1483 /** 1484 * Returns the number of web content articles belonging to the group. 1485 * 1486 * @param groupId the primary key of the web content article's group 1487 * @return the number of web content articles belonging to the group 1488 * @throws SystemException if a system exception occurred 1489 */ 1490 public int getArticlesCount(long groupId) 1491 throws com.liferay.portal.kernel.exception.SystemException { 1492 return _journalArticleLocalService.getArticlesCount(groupId); 1493 } 1494 1495 /** 1496 * Returns the number of web content articles matching the group and folder. 1497 * 1498 * @param groupId the primary key of the web content article's group 1499 * @param folderId the primary key of the web content article's folder 1500 * @return the number of matching web content articles 1501 * @throws SystemException if a system exception occurred 1502 */ 1503 public int getArticlesCount(long groupId, long folderId) 1504 throws com.liferay.portal.kernel.exception.SystemException { 1505 return _journalArticleLocalService.getArticlesCount(groupId, folderId); 1506 } 1507 1508 /** 1509 * Returns an ordered range of all the web content articles matching the 1510 * company, version, and workflow status. 1511 * 1512 * <p> 1513 * Useful when paginating results. Returns a maximum of <code>end - 1514 * start</code> instances. <code>start</code> and <code>end</code> are not 1515 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1516 * refers to the first result in the set. Setting both <code>start</code> 1517 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1518 * result set. 1519 * </p> 1520 * 1521 * @param companyId the primary key of the web content article's company 1522 * @param version the web content article's version 1523 * @param status the web content article's workflow status. For more 1524 information see {@link WorkflowConstants} for constants starting 1525 with the "STATUS_" prefix. 1526 * @param start the lower bound of the range of web content articles to 1527 return 1528 * @param end the upper bound of the range of web content articles to 1529 return (not inclusive) 1530 * @return the range of matching web content articles ordered by article ID 1531 * @throws SystemException if a system exception occurred 1532 */ 1533 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getCompanyArticles( 1534 long companyId, double version, int status, int start, int end) 1535 throws com.liferay.portal.kernel.exception.SystemException { 1536 return _journalArticleLocalService.getCompanyArticles(companyId, 1537 version, status, start, end); 1538 } 1539 1540 /** 1541 * Returns an ordered range of all the web content articles matching the 1542 * company and workflow status. 1543 * 1544 * <p> 1545 * Useful when paginating results. Returns a maximum of <code>end - 1546 * start</code> instances. <code>start</code> and <code>end</code> are not 1547 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1548 * refers to the first result in the set. Setting both <code>start</code> 1549 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1550 * result set. 1551 * </p> 1552 * 1553 * @param companyId the primary key of the web content article's company 1554 * @param status the web content article's workflow status. For more 1555 information see {@link WorkflowConstants} for constants starting 1556 with the "STATUS_" prefix. 1557 * @param start the lower bound of the range of web content articles to 1558 return 1559 * @param end the upper bound of the range of web content articles to 1560 return (not inclusive) 1561 * @return the range of matching web content articles ordered by article ID 1562 * @throws SystemException if a system exception occurred 1563 */ 1564 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getCompanyArticles( 1565 long companyId, int status, int start, int end) 1566 throws com.liferay.portal.kernel.exception.SystemException { 1567 return _journalArticleLocalService.getCompanyArticles(companyId, 1568 status, start, end); 1569 } 1570 1571 /** 1572 * Returns the number of web content articles matching the company, version, 1573 * and workflow status. 1574 * 1575 * <p> 1576 * Useful when paginating results. Returns a maximum of <code>end - 1577 * start</code> instances. <code>start</code> and <code>end</code> are not 1578 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1579 * refers to the first result in the set. Setting both <code>start</code> 1580 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1581 * result set. 1582 * </p> 1583 * 1584 * @param companyId the primary key of the web content article's company 1585 * @param version the web content article's version 1586 * @param status the web content article's workflow status. For more 1587 information see {@link WorkflowConstants} for constants starting 1588 with the "STATUS_" prefix. 1589 * @param start the lower bound of the range of web content articles to 1590 return 1591 * @param end the upper bound of the range of web content articles to 1592 return (not inclusive) 1593 * @return the number of matching web content articles 1594 * @throws SystemException if a system exception occurred 1595 */ 1596 public int getCompanyArticlesCount(long companyId, double version, 1597 int status, int start, int end) 1598 throws com.liferay.portal.kernel.exception.SystemException { 1599 return _journalArticleLocalService.getCompanyArticlesCount(companyId, 1600 version, status, start, end); 1601 } 1602 1603 /** 1604 * Returns the number of web content articles matching the company and 1605 * workflow status. 1606 * 1607 * @param companyId the primary key of the web content article's company 1608 * @param status the web content article's workflow status. For more 1609 information see {@link WorkflowConstants} for constants starting 1610 with the "STATUS_" prefix. 1611 * @return the number of matching web content articles 1612 * @throws SystemException if a system exception occurred 1613 */ 1614 public int getCompanyArticlesCount(long companyId, int status) 1615 throws com.liferay.portal.kernel.exception.SystemException { 1616 return _journalArticleLocalService.getCompanyArticlesCount(companyId, 1617 status); 1618 } 1619 1620 /** 1621 * Returns the matching web content article currently displayed or next to 1622 * be displayed if no article is currently displayed. 1623 * 1624 * @param groupId the primary key of the web content article's group 1625 * @param articleId the primary key of the web content article 1626 * @return the matching web content article currently displayed, or the next 1627 one to be displayed if no version of the article is currently 1628 displayed 1629 * @throws PortalException if no approved matching web content articles 1630 could be found 1631 * @throws SystemException if a system exception occurred 1632 */ 1633 public com.liferay.portlet.journal.model.JournalArticle getDisplayArticle( 1634 long groupId, java.lang.String articleId) 1635 throws com.liferay.portal.kernel.exception.PortalException, 1636 com.liferay.portal.kernel.exception.SystemException { 1637 return _journalArticleLocalService.getDisplayArticle(groupId, articleId); 1638 } 1639 1640 /** 1641 * Returns the web content article matching the URL title that is currently 1642 * displayed or next to be displayed if no article is currently displayed. 1643 * 1644 * @param groupId the primary key of the web content article's group 1645 * @param urlTitle the web content article's accessible URL title 1646 * @return the web content article matching the URL title that is currently 1647 displayed, or next one to be displayed if no version of the 1648 article is currently displayed 1649 * @throws PortalException if no approved matching web content articles 1650 could be found 1651 * @throws SystemException if a system exception occurred 1652 */ 1653 public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle( 1654 long groupId, java.lang.String urlTitle) 1655 throws com.liferay.portal.kernel.exception.PortalException, 1656 com.liferay.portal.kernel.exception.SystemException { 1657 return _journalArticleLocalService.getDisplayArticleByUrlTitle(groupId, 1658 urlTitle); 1659 } 1660 1661 /** 1662 * Returns the latest web content article matching the resource primary key, 1663 * preferring articles with approved workflow status. 1664 * 1665 * @param resourcePrimKey the primary key of the resource instance 1666 * @return the latest web content article matching the resource primary key, 1667 preferring articles with approved workflow status 1668 * @throws PortalException if a matching web content article could not be 1669 found 1670 * @throws SystemException if a system exception occurred 1671 */ 1672 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1673 long resourcePrimKey) 1674 throws com.liferay.portal.kernel.exception.PortalException, 1675 com.liferay.portal.kernel.exception.SystemException { 1676 return _journalArticleLocalService.getLatestArticle(resourcePrimKey); 1677 } 1678 1679 /** 1680 * Returns the latest web content article matching the resource primary key 1681 * and workflow status, preferring articles with approved workflow status. 1682 * 1683 * @param resourcePrimKey the primary key of the resource instance 1684 * @param status the web content article's workflow status. For more 1685 information see {@link WorkflowConstants} for constants starting 1686 with the "STATUS_" prefix. 1687 * @return the latest web content article matching the resource primary key 1688 and workflow status, preferring articles with approved workflow 1689 status 1690 * @throws PortalException if a matching web content article could not be 1691 found 1692 * @throws SystemException if a system exception occurred 1693 */ 1694 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1695 long resourcePrimKey, int status) 1696 throws com.liferay.portal.kernel.exception.PortalException, 1697 com.liferay.portal.kernel.exception.SystemException { 1698 return _journalArticleLocalService.getLatestArticle(resourcePrimKey, 1699 status); 1700 } 1701 1702 /** 1703 * Returns the latest web content article matching the resource primary key 1704 * and workflow status, optionally preferring articles with approved 1705 * workflow status. 1706 * 1707 * @param resourcePrimKey the primary key of the resource instance 1708 * @param status the web content article's workflow status. For more 1709 information see {@link WorkflowConstants} for constants starting 1710 with the "STATUS_" prefix. 1711 * @param preferApproved whether to prefer returning the latest matching 1712 article that has workflow status {@link 1713 WorkflowConstants#STATUS_APPROVED} over returning one that has a 1714 different status 1715 * @return the latest web content article matching the resource primary key 1716 and workflow status, optionally preferring articles with approved 1717 workflow status 1718 * @throws PortalException if a matching web content article could not be 1719 found 1720 * @throws SystemException if a system exception occurred 1721 */ 1722 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1723 long resourcePrimKey, int status, boolean preferApproved) 1724 throws com.liferay.portal.kernel.exception.PortalException, 1725 com.liferay.portal.kernel.exception.SystemException { 1726 return _journalArticleLocalService.getLatestArticle(resourcePrimKey, 1727 status, preferApproved); 1728 } 1729 1730 /** 1731 * Returns the latest web content article with the group and article ID. 1732 * 1733 * @param groupId the primary key of the web content article's group 1734 * @param articleId the primary key of the web content article 1735 * @return the latest matching web content article 1736 * @throws PortalException if a matching web content article could not be 1737 found 1738 * @throws SystemException if a system exception occurred 1739 */ 1740 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1741 long groupId, java.lang.String articleId) 1742 throws com.liferay.portal.kernel.exception.PortalException, 1743 com.liferay.portal.kernel.exception.SystemException { 1744 return _journalArticleLocalService.getLatestArticle(groupId, articleId); 1745 } 1746 1747 /** 1748 * Returns the latest web content article matching the group, article ID, 1749 * and workflow status. 1750 * 1751 * @param groupId the primary key of the web content article's group 1752 * @param articleId the primary key of the web content article 1753 * @param status the web content article's workflow status. For more 1754 information see {@link WorkflowConstants} for constants starting 1755 with the "STATUS_" prefix. 1756 * @return the latest matching web content article 1757 * @throws PortalException if a matching web content article could not be 1758 found 1759 * @throws SystemException if a system exception occurred 1760 */ 1761 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1762 long groupId, java.lang.String articleId, int status) 1763 throws com.liferay.portal.kernel.exception.PortalException, 1764 com.liferay.portal.kernel.exception.SystemException { 1765 return _journalArticleLocalService.getLatestArticle(groupId, articleId, 1766 status); 1767 } 1768 1769 /** 1770 * Returns the latest web content article matching the group, class name ID, 1771 * and class PK. 1772 * 1773 * @param groupId the primary key of the web content article's group 1774 * @param className the DDMStructure class name if the web content article 1775 is related to a DDM structure, the class name associated with the 1776 article, or {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} 1777 otherwise 1778 * @param classPK the primary key of the DDM structure, if the DDMStructure 1779 class name is given as the <code>className</code> parameter, the 1780 primary key of the class associated with the web content article, 1781 or <code>0</code> otherwise 1782 * @return the latest matching web content article 1783 * @throws PortalException if a matching web content article could not be 1784 found 1785 * @throws SystemException if a system exception occurred 1786 */ 1787 public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1788 long groupId, java.lang.String className, long classPK) 1789 throws com.liferay.portal.kernel.exception.PortalException, 1790 com.liferay.portal.kernel.exception.SystemException { 1791 return _journalArticleLocalService.getLatestArticle(groupId, className, 1792 classPK); 1793 } 1794 1795 /** 1796 * Returns the latest web content article matching the group, URL title, and 1797 * workflow status. 1798 * 1799 * @param groupId the primary key of the web content article's group 1800 * @param urlTitle the web content article's accessible URL title 1801 * @param status the web content article's workflow status. For more 1802 information see {@link WorkflowConstants} for constants starting 1803 with the "STATUS_" prefix. 1804 * @return the latest matching web content article 1805 * @throws PortalException if a matching web content article could not be 1806 found 1807 * @throws SystemException if a system exception occurred 1808 */ 1809 public com.liferay.portlet.journal.model.JournalArticle getLatestArticleByUrlTitle( 1810 long groupId, java.lang.String urlTitle, int status) 1811 throws com.liferay.portal.kernel.exception.PortalException, 1812 com.liferay.portal.kernel.exception.SystemException { 1813 return _journalArticleLocalService.getLatestArticleByUrlTitle(groupId, 1814 urlTitle, status); 1815 } 1816 1817 /** 1818 * Returns the latest version number of the web content with the group and 1819 * article ID. 1820 * 1821 * @param groupId the primary key of the web content article's group 1822 * @param articleId the primary key of the web content article 1823 * @return the latest version number of the matching web content 1824 * @throws PortalException if a matching web content article could not be 1825 found 1826 * @throws SystemException if a system exception occurred 1827 */ 1828 public double getLatestVersion(long groupId, java.lang.String articleId) 1829 throws com.liferay.portal.kernel.exception.PortalException, 1830 com.liferay.portal.kernel.exception.SystemException { 1831 return _journalArticleLocalService.getLatestVersion(groupId, articleId); 1832 } 1833 1834 /** 1835 * Returns the latest version number of the web content with the group, 1836 * article ID, and workflow status. 1837 * 1838 * @param groupId the primary key of the web content article's group 1839 * @param articleId the primary key of the web content article 1840 * @param status the web content article's workflow status. For more 1841 information see {@link WorkflowConstants} for constants starting 1842 with the "STATUS_" prefix. 1843 * @return the latest version number of the matching web content 1844 * @throws PortalException if a matching web content article could not be 1845 found 1846 * @throws SystemException if a system exception occurred 1847 */ 1848 public double getLatestVersion(long groupId, java.lang.String articleId, 1849 int status) 1850 throws com.liferay.portal.kernel.exception.PortalException, 1851 com.liferay.portal.kernel.exception.SystemException { 1852 return _journalArticleLocalService.getLatestVersion(groupId, articleId, 1853 status); 1854 } 1855 1856 /** 1857 * Returns the number of web content articles that are not recycled. 1858 * 1859 * @param groupId the primary key of the web content article's group 1860 * @param folderId the primary key of the web content article folder 1861 * @return the number of web content articles that are not recycled 1862 * @throws SystemException if a system exception occurred 1863 */ 1864 public int getNotInTrashArticlesCount(long groupId, long folderId) 1865 throws com.liferay.portal.kernel.exception.SystemException { 1866 return _journalArticleLocalService.getNotInTrashArticlesCount(groupId, 1867 folderId); 1868 } 1869 1870 /** 1871 * Returns the web content articles matching the group and DDM structure 1872 * key. 1873 * 1874 * @param groupId the primary key of the web content article's group 1875 * @param ddmStructureKey the primary key of the web content article's DDM 1876 structure 1877 * @return the matching web content articles 1878 * @throws SystemException if a system exception occurred 1879 */ 1880 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 1881 long groupId, java.lang.String ddmStructureKey) 1882 throws com.liferay.portal.kernel.exception.SystemException { 1883 return _journalArticleLocalService.getStructureArticles(groupId, 1884 ddmStructureKey); 1885 } 1886 1887 /** 1888 * Returns an ordered range of all the web content articles matching the 1889 * group and DDM structure key. 1890 * 1891 * <p> 1892 * Useful when paginating results. Returns a maximum of <code>end - 1893 * start</code> instances. <code>start</code> and <code>end</code> are not 1894 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1895 * refers to the first result in the set. Setting both <code>start</code> 1896 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1897 * result set. 1898 * </p> 1899 * 1900 * @param groupId the primary key of the web content article's group 1901 * @param ddmStructureKey the primary key of the web content article's DDM 1902 structure 1903 * @param start the lower bound of the range of web content articles to 1904 return 1905 * @param end the upper bound of the range of web content articles to 1906 return (not inclusive) 1907 * @param obc the comparator to order the web content articles 1908 * @return the range of matching web content articles ordered by the 1909 comparator 1910 * @throws SystemException if a system exception occurred 1911 */ 1912 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 1913 long groupId, java.lang.String ddmStructureKey, int start, int end, 1914 com.liferay.portal.kernel.util.OrderByComparator obc) 1915 throws com.liferay.portal.kernel.exception.SystemException { 1916 return _journalArticleLocalService.getStructureArticles(groupId, 1917 ddmStructureKey, start, end, obc); 1918 } 1919 1920 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 1921 java.lang.String[] ddmStructureKeys) 1922 throws com.liferay.portal.kernel.exception.SystemException { 1923 return _journalArticleLocalService.getStructureArticles(ddmStructureKeys); 1924 } 1925 1926 /** 1927 * Returns the number of web content articles matching the group and DDM 1928 * structure key. 1929 * 1930 * @param groupId the primary key of the web content article's group 1931 * @param ddmStructureKey the primary key of the web content article's DDM 1932 structure 1933 * @return the number of matching web content articles 1934 * @throws SystemException if a system exception occurred 1935 */ 1936 public int getStructureArticlesCount(long groupId, 1937 java.lang.String ddmStructureKey) 1938 throws com.liferay.portal.kernel.exception.SystemException { 1939 return _journalArticleLocalService.getStructureArticlesCount(groupId, 1940 ddmStructureKey); 1941 } 1942 1943 /** 1944 * Returns the web content articles matching the group and DDM template key. 1945 * 1946 * @param groupId the primary key of the web content article's group 1947 * @param ddmTemplateKey the primary key of the web content article's DDM 1948 template (optionally <code>null</code>). If the article is 1949 related to a DDM structure, the template's structure must match 1950 it. 1951 * @return the matching web content articles 1952 * @throws SystemException if a system exception occurred 1953 */ 1954 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getTemplateArticles( 1955 long groupId, java.lang.String ddmTemplateKey) 1956 throws com.liferay.portal.kernel.exception.SystemException { 1957 return _journalArticleLocalService.getTemplateArticles(groupId, 1958 ddmTemplateKey); 1959 } 1960 1961 /** 1962 * Returns an ordered range of all the web content articles matching the 1963 * group and DDM template key. 1964 * 1965 * <p> 1966 * Useful when paginating results. Returns a maximum of <code>end - 1967 * start</code> instances. <code>start</code> and <code>end</code> are not 1968 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1969 * refers to the first result in the set. Setting both <code>start</code> 1970 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1971 * result set. 1972 * </p> 1973 * 1974 * @param groupId the primary key of the web content article's group 1975 * @param ddmTemplateKey the primary key of the web content article's DDM 1976 template (optionally <code>null</code>). If the article is 1977 related to a DDM structure, the template's structure must match 1978 it. 1979 * @param start the lower bound of the range of web content articles to 1980 return 1981 * @param end the upper bound of the range of web content articles to 1982 return (not inclusive) 1983 * @param obc the comparator to order the web content articles 1984 * @return the range of matching web content articles ordered by the 1985 comparator 1986 * @throws SystemException if a system exception occurred 1987 */ 1988 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> getTemplateArticles( 1989 long groupId, java.lang.String ddmTemplateKey, int start, int end, 1990 com.liferay.portal.kernel.util.OrderByComparator obc) 1991 throws com.liferay.portal.kernel.exception.SystemException { 1992 return _journalArticleLocalService.getTemplateArticles(groupId, 1993 ddmTemplateKey, start, end, obc); 1994 } 1995 1996 /** 1997 * Returns the number of web content articles matching the group and DDM 1998 * template key. 1999 * 2000 * @param groupId the primary key of the web content article's group 2001 * @param ddmTemplateKey the primary key of the web content article's DDM 2002 template (optionally <code>null</code>). If the article is 2003 related to a DDM structure, the template's structure must match 2004 it. 2005 * @return the number of matching web content articles 2006 * @throws SystemException if a system exception occurred 2007 */ 2008 public int getTemplateArticlesCount(long groupId, 2009 java.lang.String ddmTemplateKey) 2010 throws com.liferay.portal.kernel.exception.SystemException { 2011 return _journalArticleLocalService.getTemplateArticlesCount(groupId, 2012 ddmTemplateKey); 2013 } 2014 2015 /** 2016 * Returns <code>true</code> if the specified web content article exists. 2017 * 2018 * @param groupId the primary key of the group 2019 * @param articleId the primary key of the web content article 2020 * @return <code>true</code> if the specified web content article exists; 2021 <code>false</code> otherwise 2022 * @throws SystemException if a system exception occurred 2023 */ 2024 public boolean hasArticle(long groupId, java.lang.String articleId) 2025 throws com.liferay.portal.kernel.exception.SystemException { 2026 return _journalArticleLocalService.hasArticle(groupId, articleId); 2027 } 2028 2029 /** 2030 * Returns <code>true</code> if the web content article, specified by group 2031 * and article ID, is the latest version. 2032 * 2033 * @param groupId the primary key of the web content article's group 2034 * @param articleId the primary key of the web content article 2035 * @param version the web content article's version 2036 * @return <code>true</code> if the specified web content article is the 2037 latest version; <code>false</code> otherwise 2038 * @throws PortalException if a matching web content article could not be 2039 found 2040 * @throws SystemException if a system exception occurred 2041 */ 2042 public boolean isLatestVersion(long groupId, java.lang.String articleId, 2043 double version) 2044 throws com.liferay.portal.kernel.exception.PortalException, 2045 com.liferay.portal.kernel.exception.SystemException { 2046 return _journalArticleLocalService.isLatestVersion(groupId, articleId, 2047 version); 2048 } 2049 2050 /** 2051 * Returns <code>true</code> if the web content article, specified by group, 2052 * article ID, and workflow status, is the latest version. 2053 * 2054 * @param groupId the primary key of the web content article's group 2055 * @param articleId the primary key of the web content article 2056 * @param version the web content article's version 2057 * @param status the web content article's workflow status. For more 2058 information see {@link WorkflowConstants} for constants starting 2059 with the "STATUS_" prefix. 2060 * @return <code>true</code> if the specified web content article is the 2061 latest version; <code>false</code> otherwise 2062 * @throws PortalException if a matching web content article could not be 2063 found 2064 * @throws SystemException if a system exception occurred 2065 */ 2066 public boolean isLatestVersion(long groupId, java.lang.String articleId, 2067 double version, int status) 2068 throws com.liferay.portal.kernel.exception.PortalException, 2069 com.liferay.portal.kernel.exception.SystemException { 2070 return _journalArticleLocalService.isLatestVersion(groupId, articleId, 2071 version, status); 2072 } 2073 2074 /** 2075 * Moves the web content article matching the group and article ID to a new 2076 * folder. 2077 * 2078 * @param groupId the primary key of the web content article's group 2079 * @param articleId the primary key of the web content article 2080 * @param newFolderId the primary key of the web content article's new 2081 folder 2082 * @return the updated web content article, which was moved to a new folder 2083 * @throws PortalException if a matching web content article could not be 2084 found 2085 * @throws SystemException if a system exception occurred 2086 */ 2087 public com.liferay.portlet.journal.model.JournalArticle moveArticle( 2088 long groupId, java.lang.String articleId, long newFolderId) 2089 throws com.liferay.portal.kernel.exception.PortalException, 2090 com.liferay.portal.kernel.exception.SystemException { 2091 return _journalArticleLocalService.moveArticle(groupId, articleId, 2092 newFolderId); 2093 } 2094 2095 /** 2096 * Moves the web content article from the Recycle Bin to a new folder. 2097 * 2098 * @param userId the primary key of the user updating the web content 2099 article 2100 * @param groupId the primary key of the web content article's group 2101 * @param article the web content article 2102 * @param newFolderId the primary key of the web content article's new 2103 folder 2104 * @param serviceContext the service context to be applied. Can set the 2105 modification date, portlet preferences, and can set whether to 2106 add the default command update for the web content article. With 2107 respect to social activities, by setting the service context's 2108 command to {@link 2109 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 2110 is considered a web content update activity; otherwise it is 2111 considered a web content add activity. 2112 * @return the updated web content article, which was moved from the Recycle 2113 Bin to a new folder 2114 * @throws PortalException if a trashed web content article with the primary 2115 key could not be found or if a portal exception occurred 2116 * @throws SystemException if a system exception occurred 2117 */ 2118 public com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( 2119 long userId, long groupId, 2120 com.liferay.portlet.journal.model.JournalArticle article, 2121 long newFolderId, 2122 com.liferay.portal.service.ServiceContext serviceContext) 2123 throws com.liferay.portal.kernel.exception.PortalException, 2124 com.liferay.portal.kernel.exception.SystemException { 2125 return _journalArticleLocalService.moveArticleFromTrash(userId, 2126 groupId, article, newFolderId, serviceContext); 2127 } 2128 2129 /** 2130 * Moves the latest version of the web content article matching the group 2131 * and article ID to the recycle bin. 2132 * 2133 * @param userId the primary key of the user updating the web content 2134 article 2135 * @param article the web content article 2136 * @return the updated web content article, which was moved to the Recycle 2137 Bin 2138 * @throws PortalException if the user did not have permission to move the 2139 article to the Recycle Bin or if a portal exception occurred 2140 * @throws SystemException if a system exception occurred 2141 */ 2142 public com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( 2143 long userId, com.liferay.portlet.journal.model.JournalArticle article) 2144 throws com.liferay.portal.kernel.exception.PortalException, 2145 com.liferay.portal.kernel.exception.SystemException { 2146 return _journalArticleLocalService.moveArticleToTrash(userId, article); 2147 } 2148 2149 /** 2150 * Moves the latest version of the web content article matching the group 2151 * and article ID to the recycle bin. 2152 * 2153 * @param userId the primary key of the user updating the web content 2154 article 2155 * @param groupId the primary key of the web content article's group 2156 * @param articleId the primary key of the web content article 2157 * @return the moved web content article or <code>null</code> if no matching 2158 article was found 2159 * @throws PortalException if the user did not have permission to move the 2160 article to the Recycle Bin or if a portal exception occurred 2161 * @throws SystemException if a system exception occurred 2162 */ 2163 public com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( 2164 long userId, long groupId, java.lang.String articleId) 2165 throws com.liferay.portal.kernel.exception.PortalException, 2166 com.liferay.portal.kernel.exception.SystemException { 2167 return _journalArticleLocalService.moveArticleToTrash(userId, groupId, 2168 articleId); 2169 } 2170 2171 /** 2172 * Removes the web content of the web content article matching the group, 2173 * article ID, and version, and language. 2174 * 2175 * @param groupId the primary key of the web content article's group 2176 * @param articleId the primary key of the web content article 2177 * @param version the web content article's version 2178 * @param languageId the primary key of the language locale to remove 2179 * @return the updated web content article with the locale removed 2180 * @throws PortalException if a matching web content article could not be 2181 found 2182 * @throws SystemException if a system exception occurred 2183 */ 2184 public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale( 2185 long groupId, java.lang.String articleId, double version, 2186 java.lang.String languageId) 2187 throws com.liferay.portal.kernel.exception.PortalException, 2188 com.liferay.portal.kernel.exception.SystemException { 2189 return _journalArticleLocalService.removeArticleLocale(groupId, 2190 articleId, version, languageId); 2191 } 2192 2193 /** 2194 * Restores the web content article from the Recycle Bin. 2195 * 2196 * @param userId the primary key of the user restoring the web content 2197 article 2198 * @param article the web content article 2199 * @throws PortalException if the web content article with the primary key 2200 could not be found in the Recycle Bin, if the user did not have 2201 permission to restore the article, or if a portal exception 2202 occurred 2203 * @throws SystemException if a system exception occurred 2204 */ 2205 public void restoreArticleFromTrash(long userId, 2206 com.liferay.portlet.journal.model.JournalArticle article) 2207 throws com.liferay.portal.kernel.exception.PortalException, 2208 com.liferay.portal.kernel.exception.SystemException { 2209 _journalArticleLocalService.restoreArticleFromTrash(userId, article); 2210 } 2211 2212 /** 2213 * Returns an ordered range of all the web content articles matching the 2214 * parameters without using the indexer, including a keywords parameter for 2215 * matching with the article's ID, title, description, and content, a DDM 2216 * structure key parameter, and a DDM template key parameter. It is 2217 * preferable to use the indexed version {@link #search(long, long, List, 2218 * long, String, String, String, LinkedHashMap, int, int, Sort)} instead of 2219 * this method wherever possible for performance reasons. 2220 * 2221 * <p> 2222 * Useful when paginating results. Returns a maximum of <code>end - 2223 * start</code> instances. <code>start</code> and <code>end</code> are not 2224 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2225 * refers to the first result in the set. Setting both <code>start</code> 2226 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2227 * result set. 2228 * </p> 2229 * 2230 * @param companyId the primary key of the web content article's company 2231 * @param groupId the primary key of the group (optionally <code>0</code>) 2232 * @param folderIds the primary keys of the web content article folders 2233 (optionally {@link java.util.Collections#EMPTY_LIST}) 2234 * @param classNameId the primary key of the DDMStructure class if the web 2235 content article is related to a DDM structure, the primary key of 2236 the class name associated with the article, or {@link 2237 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2238 * @param keywords the keywords (space separated), which may occur in the 2239 web content article ID, title, description, or content 2240 (optionally <code>null</code>). If the keywords value is not 2241 <code>null</code>, the search uses the OR operator in connecting 2242 query criteria; otherwise it uses the AND operator. 2243 * @param version the web content article's version (optionally 2244 <code>null</code>) 2245 * @param type the web content article's type (optionally 2246 <code>null</code>) 2247 * @param ddmStructureKey the primary key of the web content article's DDM 2248 structure, if the article is related to a DDM structure, or 2249 <code>null</code> otherwise 2250 * @param ddmTemplateKey the primary key of the web content article's DDM 2251 template (optionally <code>null</code>). If the article is 2252 related to a DDM structure, the template's structure must match 2253 it. 2254 * @param displayDateGT the date after which a matching web content 2255 article's display date must be after (optionally 2256 <code>null</code>) 2257 * @param displayDateLT the date before which a matching web content 2258 article's display date must be before (optionally 2259 <code>null</code>) 2260 * @param status the web content article's workflow status. For more 2261 information see {@link WorkflowConstants} for constants starting 2262 with the "STATUS_" prefix. 2263 * @param reviewDate the web content article's scheduled review date 2264 (optionally <code>null</code>) 2265 * @param start the lower bound of the range of web content articles to 2266 return 2267 * @param end the upper bound of the range of web content articles to 2268 return (not inclusive) 2269 * @param obc the comparator to order the web content articles 2270 * @return the range of matching web content articles ordered by the 2271 comparator 2272 * @throws SystemException if a system exception occurred 2273 */ 2274 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2275 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2276 long classNameId, java.lang.String keywords, java.lang.Double version, 2277 java.lang.String type, java.lang.String ddmStructureKey, 2278 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 2279 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2280 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 2281 throws com.liferay.portal.kernel.exception.SystemException { 2282 return _journalArticleLocalService.search(companyId, groupId, 2283 folderIds, classNameId, keywords, version, type, ddmStructureKey, 2284 ddmTemplateKey, displayDateGT, displayDateLT, status, reviewDate, 2285 start, end, obc); 2286 } 2287 2288 /** 2289 * Returns an ordered range of all the web content articles matching the 2290 * parameters without using the indexer, including keyword parameters for 2291 * article ID, title, description, and content, a DDM structure key 2292 * parameter, a DDM template key parameter, and an AND operator switch. It 2293 * is preferable to use the indexed version {@link #search(long, long, List, 2294 * long, String, String, String, String, String, String, String, String, 2295 * LinkedHashMap, boolean, int, int, Sort)} instead of this method wherever 2296 * possible for performance reasons. 2297 * 2298 * <p> 2299 * Useful when paginating results. Returns a maximum of <code>end - 2300 * start</code> instances. <code>start</code> and <code>end</code> are not 2301 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2302 * refers to the first result in the set. Setting both <code>start</code> 2303 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2304 * result set. 2305 * </p> 2306 * 2307 * @param companyId the primary key of the web content article's company 2308 * @param groupId the primary key of the group (optionally <code>0</code>) 2309 * @param folderIds the primary keys of the web content article folders 2310 (optionally {@link java.util.Collections#EMPTY_LIST}) 2311 * @param classNameId the primary key of the DDMStructure class if the web 2312 content article is related to a DDM structure, the primary key of 2313 the class name associated with the article, or {@link 2314 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2315 * @param articleId the article ID keywords (space separated, optionally 2316 <code>null</code>) 2317 * @param version the web content article's version (optionally 2318 <code>null</code>) 2319 * @param title the title keywords (space separated, optionally 2320 <code>null</code>) 2321 * @param description the description keywords (space separated, optionally 2322 <code>null</code>) 2323 * @param content the content keywords (space separated, optionally 2324 <code>null</code>) 2325 * @param type the web content article's type (optionally 2326 <code>null</code>) 2327 * @param ddmStructureKey the primary key of the web content article's DDM 2328 structure, if the article is related to a DDM structure, or 2329 <code>null</code> otherwise 2330 * @param ddmTemplateKey the primary key of the web content article's DDM 2331 template (optionally <code>null</code>). If the article is 2332 related to a DDM structure, the template's structure must match 2333 it. 2334 * @param displayDateGT the date after which a matching web content 2335 article's display date must be after (optionally 2336 <code>null</code>) 2337 * @param displayDateLT the date before which a matching web content 2338 article's display date must be before (optionally 2339 <code>null</code>) 2340 * @param status the web content article's workflow status. For more 2341 information see {@link WorkflowConstants} for constants starting 2342 with the "STATUS_" prefix. 2343 * @param reviewDate the web content article's scheduled review date 2344 (optionally <code>null</code>) 2345 * @param andOperator whether every field must match its value or keywords, 2346 or just one field must match. Company, group, folder IDs, class 2347 name ID, and status must all match their values. 2348 * @param start the lower bound of the range of web content articles to 2349 return 2350 * @param end the upper bound of the range of web content articles to 2351 return (not inclusive) 2352 * @param obc the comparator to order the web content articles 2353 * @return the range of matching web content articles ordered by the 2354 comparator 2355 * @throws SystemException if a system exception occurred 2356 */ 2357 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2358 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2359 long classNameId, java.lang.String articleId, java.lang.Double version, 2360 java.lang.String title, java.lang.String description, 2361 java.lang.String content, java.lang.String type, 2362 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2363 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 2364 java.util.Date reviewDate, boolean andOperator, int start, int end, 2365 com.liferay.portal.kernel.util.OrderByComparator obc) 2366 throws com.liferay.portal.kernel.exception.SystemException { 2367 return _journalArticleLocalService.search(companyId, groupId, 2368 folderIds, classNameId, articleId, version, title, description, 2369 content, type, ddmStructureKey, ddmTemplateKey, displayDateGT, 2370 displayDateLT, status, reviewDate, andOperator, start, end, obc); 2371 } 2372 2373 /** 2374 * Returns an ordered range of all the web content articles matching the 2375 * parameters without using the indexer, including keyword parameters for 2376 * article ID, title, description, and content, a DDM structure keys 2377 * (plural) parameter, a DDM template keys (plural) parameter, and an AND 2378 * operator switch. 2379 * 2380 * <p> 2381 * Useful when paginating results. Returns a maximum of <code>end - 2382 * start</code> instances. <code>start</code> and <code>end</code> are not 2383 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2384 * refers to the first result in the set. Setting both <code>start</code> 2385 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2386 * result set. 2387 * </p> 2388 * 2389 * @param companyId the primary key of the web content article's company 2390 * @param groupId the primary key of the group (optionally <code>0</code>) 2391 * @param folderIds the primary keys of the web content article folders 2392 (optionally {@link java.util.Collections#EMPTY_LIST}) 2393 * @param classNameId the primary key of the DDMStructure class if the web 2394 content article is related to a DDM structure, the primary key of 2395 the class name associated with the article, or {@link 2396 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2397 * @param articleId the article ID keywords (space separated, optionally 2398 <code>null</code>) 2399 * @param version the web content article's version (optionally 2400 <code>null</code>) 2401 * @param title the title keywords (space separated, optionally 2402 <code>null</code>) 2403 * @param description the description keywords (space separated, optionally 2404 <code>null</code>) 2405 * @param content the content keywords (space separated, optionally 2406 <code>null</code>) 2407 * @param type the web content article's type (optionally 2408 <code>null</code>) 2409 * @param ddmStructureKeys the primary keys of the web content article's 2410 DDM structures, if the article is related to a DDM structure, or 2411 <code>null</code> otherwise 2412 * @param ddmTemplateKeys the primary keys of the web content article's DDM 2413 templates (originally <code>null</code>). If the articles are 2414 related to a DDM structure, the template's structure must match 2415 it. 2416 * @param displayDateGT the date after which a matching web content 2417 article's display date must be after (optionally 2418 <code>null</code>) 2419 * @param displayDateLT the date before which a matching web content 2420 article's display date must be before (optionally 2421 <code>null</code>) 2422 * @param status the web content article's workflow status. For more 2423 information see {@link WorkflowConstants} for constants starting 2424 with the "STATUS_" prefix. 2425 * @param reviewDate the web content article's scheduled review date 2426 (optionally <code>null</code>) 2427 * @param andOperator whether every field must match its value or keywords, 2428 or just one field must match. Company, group, folder IDs, class 2429 name ID, and status must all match their values. 2430 * @param start the lower bound of the range of web content articles to 2431 return 2432 * @param end the upper bound of the range of web content articles to 2433 return (not inclusive) 2434 * @param obc the comparator to order the web content articles 2435 * @return the range of matching web content articles ordered by the 2436 comparator 2437 * @throws SystemException if a system exception occurred 2438 */ 2439 public java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2440 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2441 long classNameId, java.lang.String articleId, java.lang.Double version, 2442 java.lang.String title, java.lang.String description, 2443 java.lang.String content, java.lang.String type, 2444 java.lang.String[] ddmStructureKeys, 2445 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 2446 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2447 boolean andOperator, int start, int end, 2448 com.liferay.portal.kernel.util.OrderByComparator obc) 2449 throws com.liferay.portal.kernel.exception.SystemException { 2450 return _journalArticleLocalService.search(companyId, groupId, 2451 folderIds, classNameId, articleId, version, title, description, 2452 content, type, ddmStructureKeys, ddmTemplateKeys, displayDateGT, 2453 displayDateLT, status, reviewDate, andOperator, start, end, obc); 2454 } 2455 2456 /** 2457 * Returns an ordered range of all the web content articles matching the 2458 * parameters using the indexer, including a keywords parameter for matching 2459 * an article's ID, title, description, or content, a DDM structure key 2460 * parameter, a DDM template key parameter, and a finder hash map parameter. 2461 * It is preferable to use this method instead of the non-indexed version 2462 * whenever possible for performance reasons. 2463 * 2464 * <p> 2465 * Useful when paginating results. Returns a maximum of <code>end - 2466 * start</code> instances. <code>start</code> and <code>end</code> are not 2467 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2468 * refers to the first result in the set. Setting both <code>start</code> 2469 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2470 * result set. 2471 * </p> 2472 * 2473 * @param companyId the primary key of the web content article's company 2474 * @param groupId the primary key of the group (optionally <code>0</code>) 2475 * @param folderIds the primary keys of the web content article folders 2476 (optionally {@link java.util.Collections#EMPTY_LIST}) 2477 * @param classNameId the primary key of the DDMStructure class if the web 2478 content article is related to a DDM structure, the primary key of 2479 the class name associated with the article, or {@link 2480 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2481 * @param ddmStructureKey the primary key of the web content article's DDM 2482 structure, if the article is related to a DDM structure, or 2483 <code>null</code> otherwise 2484 * @param ddmTemplateKey the primary key of the web content article's DDM 2485 template (optionally <code>null</code>). If the article is 2486 related to a DDM structure, the template's structure must match 2487 it. 2488 * @param keywords the keywords (space separated), which may occur in the 2489 web content article ID, title, description, or content 2490 (optionally <code>null</code>). If the keywords value is not 2491 <code>null</code>, the search uses the OR operator in connecting 2492 query criteria; otherwise it uses the AND operator. 2493 * @param params the finder parameters (optionally <code>null</code>) 2494 * @param start the lower bound of the range of web content articles to 2495 return 2496 * @param end the upper bound of the range of web content articles to 2497 return (not inclusive) 2498 * @param sort the field, type, and direction by which to sort (optionally 2499 <code>null</code>) 2500 * @return the matching web content articles ordered by <code>sort</code> 2501 * @throws SystemException if a system exception occurred 2502 */ 2503 public com.liferay.portal.kernel.search.Hits search(long companyId, 2504 long groupId, java.util.List<java.lang.Long> folderIds, 2505 long classNameId, java.lang.String ddmStructureKey, 2506 java.lang.String ddmTemplateKey, java.lang.String keywords, 2507 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2508 int start, int end, com.liferay.portal.kernel.search.Sort sort) 2509 throws com.liferay.portal.kernel.exception.SystemException { 2510 return _journalArticleLocalService.search(companyId, groupId, 2511 folderIds, classNameId, ddmStructureKey, ddmTemplateKey, keywords, 2512 params, start, end, sort); 2513 } 2514 2515 /** 2516 * Returns an ordered range of all the web content articles matching the 2517 * parameters using the indexer, including a keywords parameter for matching 2518 * an article's ID, title, description, or content, a DDM structure key 2519 * parameter, a DDM template key parameter, an AND operator switch, and 2520 * parameters for type, status, a finder hash map. It is preferable to use 2521 * this method instead of the non-indexed version whenever possible for 2522 * performance reasons. 2523 * 2524 * <p> 2525 * Useful when paginating results. Returns a maximum of <code>end - 2526 * start</code> instances. <code>start</code> and <code>end</code> are not 2527 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2528 * refers to the first result in the set. Setting both <code>start</code> 2529 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2530 * result set. 2531 * </p> 2532 * 2533 * @param companyId the primary key of the web content article's company 2534 * @param groupId the primary key of the group (optionally <code>0</code>) 2535 * @param folderIds the primary keys of the web content article folders 2536 (optionally {@link java.util.Collections#EMPTY_LIST}) 2537 * @param classNameId the primary key of the DDMStructure class if the web 2538 content article is related to a DDM structure, the primary key of 2539 the class name associated with the article, or {@link 2540 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2541 * @param articleId the article ID keywords (space separated, optionally 2542 <code>null</code>) 2543 * @param title the title keywords (space separated, optionally 2544 <code>null</code>) 2545 * @param description the description keywords (space separated, optionally 2546 <code>null</code>) 2547 * @param content the content keywords (space separated, optionally 2548 <code>null</code>) 2549 * @param type the web content article's type (optionally 2550 <code>null</code>) 2551 * @param status the web content article's workflow status. For more 2552 information see {@link WorkflowConstants} for constants starting 2553 with the "STATUS_" prefix. 2554 * @param ddmStructureKey the primary key of the web content article's DDM 2555 structure, if the article is related to a DDM structure, or 2556 <code>null</code> otherwise 2557 * @param ddmTemplateKey the primary key of the web content article's DDM 2558 template (optionally <code>null</code>). If the article is 2559 related to a DDM structure, the template's structure must match 2560 it. 2561 * @param params the finder parameters (optionally <code>null</code>). Can 2562 set parameter <code>"includeDiscussions"</code> to 2563 <code>true</code> to search for the keywords in the web content 2564 article discussions. 2565 * @param andSearch whether every field must match its value or keywords, 2566 or just one field must match 2567 * @param start the lower bound of the range of web content articles to 2568 return 2569 * @param end the upper bound of the range of web content articles to 2570 return (not inclusive) 2571 * @param sort the field, type, and direction by which to sort (optionally 2572 <code>null</code>) 2573 * @return the matching web content articles ordered by <code>sort</code> 2574 * @throws SystemException if a system exception occurred 2575 */ 2576 public com.liferay.portal.kernel.search.Hits search(long companyId, 2577 long groupId, java.util.List<java.lang.Long> folderIds, 2578 long classNameId, java.lang.String articleId, java.lang.String title, 2579 java.lang.String description, java.lang.String content, 2580 java.lang.String type, java.lang.String status, 2581 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2582 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2583 boolean andSearch, int start, int end, 2584 com.liferay.portal.kernel.search.Sort sort) 2585 throws com.liferay.portal.kernel.exception.SystemException { 2586 return _journalArticleLocalService.search(companyId, groupId, 2587 folderIds, classNameId, articleId, title, description, content, 2588 type, status, ddmStructureKey, ddmTemplateKey, params, andSearch, 2589 start, end, sort); 2590 } 2591 2592 /** 2593 * Returns the number of web content articles matching the parameters, 2594 * including a keywords parameter for matching with the article's ID, title, 2595 * description, and content, a DDM structure key parameter, and a DDM 2596 * template key parameter. 2597 * 2598 * @param companyId the primary key of the web content article's company 2599 * @param groupId the primary key of the group (optionally <code>0</code>) 2600 * @param folderIds the primary keys of the web content article folders 2601 (optionally {@link java.util.Collections#EMPTY_LIST}) 2602 * @param classNameId the primary key of the DDMStructure class if the web 2603 content article is related to a DDM structure, the primary key of 2604 the class name associated with the article, or {@link 2605 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2606 * @param keywords the keywords (space separated), which may occur in the 2607 web content article ID, title, description, or content 2608 (optionally <code>null</code>). If the keywords value is not 2609 <code>null</code>, the search uses the OR operator in connecting 2610 query criteria; otherwise it uses the AND operator. 2611 * @param version the web content article's version (optionally 2612 <code>null</code>) 2613 * @param type the web content article's type (optionally 2614 <code>null</code>) 2615 * @param ddmStructureKey the primary key of the web content article's DDM 2616 structure, if the article is related to a DDM structure, or 2617 <code>null</code> otherwise 2618 * @param ddmTemplateKey the primary key of the web content article's DDM 2619 template (optionally <code>null</code>). If the article is 2620 related to a DDM structure, the template's structure must match 2621 it. 2622 * @param displayDateGT the date after which a matching web content 2623 article's display date must be after (optionally 2624 <code>null</code>) 2625 * @param displayDateLT the date before which a matching web content 2626 article's display date must be before (optionally 2627 <code>null</code>) 2628 * @param status the web content article's workflow status. For more 2629 information see {@link WorkflowConstants} for constants starting 2630 with the "STATUS_" prefix. 2631 * @param reviewDate the web content article's scheduled review date 2632 (optionally <code>null</code>) 2633 * @return the number of matching web content articles 2634 * @throws SystemException if a system exception occurred 2635 */ 2636 public int searchCount(long companyId, long groupId, 2637 java.util.List<java.lang.Long> folderIds, long classNameId, 2638 java.lang.String keywords, java.lang.Double version, 2639 java.lang.String type, java.lang.String ddmStructureKey, 2640 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 2641 java.util.Date displayDateLT, int status, java.util.Date reviewDate) 2642 throws com.liferay.portal.kernel.exception.SystemException { 2643 return _journalArticleLocalService.searchCount(companyId, groupId, 2644 folderIds, classNameId, keywords, version, type, ddmStructureKey, 2645 ddmTemplateKey, displayDateGT, displayDateLT, status, reviewDate); 2646 } 2647 2648 /** 2649 * Returns the number of web content articles matching the parameters, 2650 * including keyword parameters for article ID, title, description, and 2651 * content, a DDM structure key parameter, a DDM template key parameter, and 2652 * an AND operator switch. 2653 * 2654 * @param companyId the primary key of the web content article's company 2655 * @param groupId the primary key of the group (optionally <code>0</code>) 2656 * @param folderIds the primary keys of the web content article folders 2657 (optionally {@link java.util.Collections#EMPTY_LIST}) 2658 * @param classNameId the primary key of the DDMStructure class if the web 2659 content article is related to a DDM structure, the primary key of 2660 the class name associated with the article, or {@link 2661 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2662 * @param articleId the article ID keywords (space separated, optionally 2663 <code>null</code>) 2664 * @param version the web content article's version (optionally 2665 <code>null</code>) 2666 * @param title the title keywords (space separated, optionally 2667 <code>null</code>) 2668 * @param description the description keywords (space separated, optionally 2669 <code>null</code>) 2670 * @param content the content keywords (space separated, optionally 2671 <code>null</code>) 2672 * @param type the web content article's type (optionally 2673 <code>null</code>) 2674 * @param ddmStructureKey the primary key of the web content article's DDM 2675 structure, if the article is related to a DDM structure, or 2676 <code>null</code> otherwise 2677 * @param ddmTemplateKey the primary key of the web content article's DDM 2678 template (optionally <code>null</code>). If the article is 2679 related to a DDM structure, the template's structure must match 2680 it. 2681 * @param displayDateGT the date after which a matching web content 2682 article's display date must be after (optionally 2683 <code>null</code>) 2684 * @param displayDateLT the date before which a matching web content 2685 article's display date must be before (optionally 2686 <code>null</code>) 2687 * @param status the web content article's workflow status. For more 2688 information see {@link WorkflowConstants} for constants starting 2689 with the "STATUS_" prefix. 2690 * @param reviewDate the web content article's scheduled review date 2691 (optionally <code>null</code>) 2692 * @param andOperator whether every field must match its value or keywords, 2693 or just one field must match. Group, folder IDs, class name ID, 2694 and status must all match their values. 2695 * @return the number of matching web content articles 2696 * @throws SystemException if a system exception occurred 2697 */ 2698 public int searchCount(long companyId, long groupId, 2699 java.util.List<java.lang.Long> folderIds, long classNameId, 2700 java.lang.String articleId, java.lang.Double version, 2701 java.lang.String title, java.lang.String description, 2702 java.lang.String content, java.lang.String type, 2703 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2704 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 2705 java.util.Date reviewDate, boolean andOperator) 2706 throws com.liferay.portal.kernel.exception.SystemException { 2707 return _journalArticleLocalService.searchCount(companyId, groupId, 2708 folderIds, classNameId, articleId, version, title, description, 2709 content, type, ddmStructureKey, ddmTemplateKey, displayDateGT, 2710 displayDateLT, status, reviewDate, andOperator); 2711 } 2712 2713 /** 2714 * Returns the number of web content articles matching the parameters, 2715 * including keyword parameters for article ID, title, description, and 2716 * content, a DDM structure keys (plural) parameter, a DDM template keys 2717 * (plural) parameter, and an AND operator switch. 2718 * 2719 * @param companyId the primary key of the web content article's company 2720 * @param groupId the primary key of the group (optionally <code>0</code>) 2721 * @param folderIds the primary keys of the web content article folders 2722 (optionally {@link java.util.Collections#EMPTY_LIST}) 2723 * @param classNameId the primary key of the DDMStructure class if the web 2724 content article is related to a DDM structure, the primary key of 2725 the class name associated with the article, or {@link 2726 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2727 * @param articleId the article ID keywords (space separated, optionally 2728 <code>null</code>) 2729 * @param version the web content article's version (optionally 2730 <code>null</code>) 2731 * @param title the title keywords (space separated, optionally 2732 <code>null</code>) 2733 * @param description the description keywords (space separated, optionally 2734 <code>null</code>) 2735 * @param content the content keywords (space separated, optionally 2736 <code>null</code>) 2737 * @param type the web content article's type (optionally 2738 <code>null</code>) 2739 * @param ddmStructureKeys the primary keys of the web content article's 2740 DDM structures, if the article is related to a DDM structure, or 2741 <code>null</code> otherwise 2742 * @param ddmTemplateKeys the primary keys of the web content article's DDM 2743 templates (originally <code>null</code>). If the articles are 2744 related to a DDM structure, the template's structure must match 2745 it. 2746 * @param displayDateGT the date after which a matching web content 2747 article's display date must be after (optionally 2748 <code>null</code>) 2749 * @param displayDateLT the date before which a matching web content 2750 article's display date must be before (optionally 2751 <code>null</code>) 2752 * @param status the web content article's workflow status. For more 2753 information see {@link WorkflowConstants} for constants starting 2754 with the "STATUS_" prefix. 2755 * @param reviewDate the web content article's scheduled review date 2756 (optionally <code>null</code>) 2757 * @param andOperator whether every field must match its value or keywords, 2758 or just one field must match. Group, folder IDs, class name ID, 2759 and status must all match their values. 2760 * @return the number of matching web content articles 2761 * @throws SystemException if a system exception occurred 2762 */ 2763 public int searchCount(long companyId, long groupId, 2764 java.util.List<java.lang.Long> folderIds, long classNameId, 2765 java.lang.String articleId, java.lang.Double version, 2766 java.lang.String title, java.lang.String description, 2767 java.lang.String content, java.lang.String type, 2768 java.lang.String[] ddmStructureKeys, 2769 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 2770 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2771 boolean andOperator) 2772 throws com.liferay.portal.kernel.exception.SystemException { 2773 return _journalArticleLocalService.searchCount(companyId, groupId, 2774 folderIds, classNameId, articleId, version, title, description, 2775 content, type, ddmStructureKeys, ddmTemplateKeys, displayDateGT, 2776 displayDateLT, status, reviewDate, andOperator); 2777 } 2778 2779 /** 2780 * Subscribes the user to notifications for the web content article matching 2781 * the group, notifying him the instant versions of the article are created, 2782 * deleted, or modified. 2783 * 2784 * @param userId the primary key of the user to subscribe 2785 * @param groupId the primary key of the group 2786 * @throws PortalException if a matching user or group could not be found 2787 * @throws SystemException if a system exception occurred 2788 */ 2789 public void subscribe(long userId, long groupId) 2790 throws com.liferay.portal.kernel.exception.PortalException, 2791 com.liferay.portal.kernel.exception.SystemException { 2792 _journalArticleLocalService.subscribe(userId, groupId); 2793 } 2794 2795 /** 2796 * Unsubscribes the user from notifications for the web content article 2797 * matching the group. 2798 * 2799 * @param userId the primary key of the user to unsubscribe 2800 * @param groupId the primary key of the group 2801 * @throws PortalException if a matching user or subscription could not be 2802 found 2803 * @throws SystemException if a system exception occurred 2804 */ 2805 public void unsubscribe(long userId, long groupId) 2806 throws com.liferay.portal.kernel.exception.PortalException, 2807 com.liferay.portal.kernel.exception.SystemException { 2808 _journalArticleLocalService.unsubscribe(userId, groupId); 2809 } 2810 2811 /** 2812 * Updates the web content article matching the version, replacing its 2813 * folder, title, description, content, and layout UUID. 2814 * 2815 * @param userId the primary key of the user updating the web content 2816 article 2817 * @param groupId the primary key of the web content article's group 2818 * @param folderId the primary key of the web content article folder 2819 * @param articleId the primary key of the web content article 2820 * @param version the web content article's version 2821 * @param titleMap the web content article's locales and localized titles 2822 * @param descriptionMap the web content article's locales and localized 2823 descriptions 2824 * @param content the HTML content wrapped in XML. For more information, 2825 see the content example in the class description for {@link 2826 JournalArticleLocalServiceImpl}. 2827 * @param layoutUuid the unique string identifying the web content 2828 article's display page 2829 * @param serviceContext the service context to be applied. Can set the 2830 modification date, expando bridge attributes, asset category IDs, 2831 asset tag names, asset link entry IDs, workflow actions, the 2832 "defaultLanguageId" and "urlTitle" attributes, and can set 2833 whether to add the default command update for the web content 2834 article. With respect to social activities, by setting the 2835 service context's command to {@link 2836 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 2837 is considered a web content update activity; otherwise it is 2838 considered a web content add activity. 2839 * @return the updated web content article 2840 * @throws PortalException if a user with the primary key or a matching web 2841 content article could not be found, or if a portal exception 2842 occurred 2843 * @throws SystemException if a system exception occurred 2844 */ 2845 public com.liferay.portlet.journal.model.JournalArticle updateArticle( 2846 long userId, long groupId, long folderId, java.lang.String articleId, 2847 double version, 2848 java.util.Map<java.util.Locale, java.lang.String> titleMap, 2849 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 2850 java.lang.String content, java.lang.String layoutUuid, 2851 com.liferay.portal.service.ServiceContext serviceContext) 2852 throws com.liferay.portal.kernel.exception.PortalException, 2853 com.liferay.portal.kernel.exception.SystemException { 2854 return _journalArticleLocalService.updateArticle(userId, groupId, 2855 folderId, articleId, version, titleMap, descriptionMap, content, 2856 layoutUuid, serviceContext); 2857 } 2858 2859 /** 2860 * Updates the web content article with additional parameters. 2861 * 2862 * @param userId the primary key of the user updating the web content 2863 article 2864 * @param groupId the primary key of the web content article's group 2865 * @param folderId the primary key of the web content article folder 2866 * @param articleId the primary key of the web content article 2867 * @param version the web content article's version 2868 * @param titleMap the web content article's locales and localized titles 2869 * @param descriptionMap the web content article's locales and localized 2870 descriptions 2871 * @param content the HTML content wrapped in XML. For more information, 2872 see the content example in the class description for {@link 2873 JournalArticleLocalServiceImpl}. 2874 * @param type the structure's type, if the web content article is related 2875 to a DDM structure. For more information, see {@link 2876 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 2877 * @param ddmStructureKey the primary key of the web content article's DDM 2878 structure, if the article is related to a DDM structure, or 2879 <code>null</code> otherwise 2880 * @param ddmTemplateKey the primary key of the web content article's DDM 2881 template (optionally <code>null</code>). If the article is 2882 related to a DDM structure, the template's structure must match 2883 it. 2884 * @param layoutUuid the unique string identifying the web content 2885 article's display page 2886 * @param displayDateMonth the month the web content article is set to 2887 display 2888 * @param displayDateDay the calendar day the web content article is set to 2889 display 2890 * @param displayDateYear the year the web content article is set to 2891 display 2892 * @param displayDateHour the hour the web content article is set to 2893 display 2894 * @param displayDateMinute the minute the web content article is set to 2895 display 2896 * @param expirationDateMonth the month the web content article is set to 2897 expire 2898 * @param expirationDateDay the calendar day the web content article is set 2899 to expire 2900 * @param expirationDateYear the year the web content article is set to 2901 expire 2902 * @param expirationDateHour the hour the web content article is set to 2903 expire 2904 * @param expirationDateMinute the minute the web content article is set to 2905 expire 2906 * @param neverExpire whether the web content article is not set to auto 2907 expire 2908 * @param reviewDateMonth the month the web content article is set for 2909 review 2910 * @param reviewDateDay the calendar day the web content article is set for 2911 review 2912 * @param reviewDateYear the year the web content article is set for review 2913 * @param reviewDateHour the hour the web content article is set for review 2914 * @param reviewDateMinute the minute the web content article is set for 2915 review 2916 * @param neverReview whether the web content article is not set for review 2917 * @param indexable whether the web content is searchable 2918 * @param smallImage whether to update web content article's a small image. 2919 A file must be passed in as <code>smallImageFile</code> value, 2920 otherwise the current small image is deleted. 2921 * @param smallImageURL the web content article's small image URL 2922 (optionally <code>null</code>) 2923 * @param smallImageFile the web content article's new small image file 2924 (optionally <code>null</code>). Must pass in 2925 <code>smallImage</code> value of <code>true</code> to replace the 2926 article's small image file. 2927 * @param images the web content's images (optionally <code>null</code>) 2928 * @param articleURL the web content article's accessible URL (optionally 2929 <code>null</code>) 2930 * @param serviceContext the service context to be applied. Can set the 2931 modification date, expando bridge attributes, asset category IDs, 2932 asset tag names, asset link entry IDs, workflow actions, the 2933 "defaultLanguageId" and "urlTitle" attributes, and can set 2934 whether to add the default command update for the web content 2935 article. With respect to social activities, by setting the 2936 service context's command to {@link 2937 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 2938 is considered a web content update activity; otherwise it is 2939 considered a web content add activity. 2940 * @return the updated web content article 2941 * @throws PortalException if a user with the primary key or a matching web 2942 content article could not be found, or if a portal exception 2943 occurred 2944 * @throws SystemException if a system exception occurred 2945 */ 2946 public com.liferay.portlet.journal.model.JournalArticle updateArticle( 2947 long userId, long groupId, long folderId, java.lang.String articleId, 2948 double version, 2949 java.util.Map<java.util.Locale, java.lang.String> titleMap, 2950 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 2951 java.lang.String content, java.lang.String type, 2952 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2953 java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, 2954 int displayDateYear, int displayDateHour, int displayDateMinute, 2955 int expirationDateMonth, int expirationDateDay, int expirationDateYear, 2956 int expirationDateHour, int expirationDateMinute, boolean neverExpire, 2957 int reviewDateMonth, int reviewDateDay, int reviewDateYear, 2958 int reviewDateHour, int reviewDateMinute, boolean neverReview, 2959 boolean indexable, boolean smallImage, java.lang.String smallImageURL, 2960 java.io.File smallImageFile, 2961 java.util.Map<java.lang.String, byte[]> images, 2962 java.lang.String articleURL, 2963 com.liferay.portal.service.ServiceContext serviceContext) 2964 throws com.liferay.portal.kernel.exception.PortalException, 2965 com.liferay.portal.kernel.exception.SystemException { 2966 return _journalArticleLocalService.updateArticle(userId, groupId, 2967 folderId, articleId, version, titleMap, descriptionMap, content, 2968 type, ddmStructureKey, ddmTemplateKey, layoutUuid, 2969 displayDateMonth, displayDateDay, displayDateYear, displayDateHour, 2970 displayDateMinute, expirationDateMonth, expirationDateDay, 2971 expirationDateYear, expirationDateHour, expirationDateMinute, 2972 neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear, 2973 reviewDateHour, reviewDateMinute, neverReview, indexable, 2974 smallImage, smallImageURL, smallImageFile, images, articleURL, 2975 serviceContext); 2976 } 2977 2978 /** 2979 * Updates the web content article matching the version, replacing its 2980 * folder and content. 2981 * 2982 * @param userId the primary key of the user updating the web content 2983 article 2984 * @param groupId the primary key of the web content article's group 2985 * @param folderId the primary key of the web content article folder 2986 * @param articleId the primary key of the web content article 2987 * @param version the web content article's version 2988 * @param content the HTML content wrapped in XML. For more information, 2989 see the content example in the class description for {@link 2990 JournalArticleLocalServiceImpl}. 2991 * @param serviceContext the service context to be applied. Can set the 2992 modification date, expando bridge attributes, asset category IDs, 2993 asset tag names, asset link entry IDs, workflow actions, the 2994 "defaultLanguageId" and "urlTitle" attributes, and can set 2995 whether to add the default command update for the web content 2996 article. With respect to social activities, by setting the 2997 service context's command to {@link 2998 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 2999 is considered a web content update activity; otherwise it is 3000 considered a web content add activity. 3001 * @return the updated web content article 3002 * @throws PortalException if a user with the primary key or a matching web 3003 content article could not be found, or if a portal exception 3004 occurred 3005 * @throws SystemException if a system exception occurred 3006 */ 3007 public com.liferay.portlet.journal.model.JournalArticle updateArticle( 3008 long userId, long groupId, long folderId, java.lang.String articleId, 3009 double version, java.lang.String content, 3010 com.liferay.portal.service.ServiceContext serviceContext) 3011 throws com.liferay.portal.kernel.exception.PortalException, 3012 com.liferay.portal.kernel.exception.SystemException { 3013 return _journalArticleLocalService.updateArticle(userId, groupId, 3014 folderId, articleId, version, content, serviceContext); 3015 } 3016 3017 /** 3018 * @deprecated As of 6.2.0, replaced by {@link 3019 #updateArticleTranslation(long, String, double, Locale, 3020 String, String, String, Map, ServiceContext)} 3021 */ 3022 public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 3023 long groupId, java.lang.String articleId, double version, 3024 java.util.Locale locale, java.lang.String title, 3025 java.lang.String description, java.lang.String content, 3026 java.util.Map<java.lang.String, byte[]> images) 3027 throws com.liferay.portal.kernel.exception.PortalException, 3028 com.liferay.portal.kernel.exception.SystemException { 3029 return _journalArticleLocalService.updateArticleTranslation(groupId, 3030 articleId, version, locale, title, description, content, images); 3031 } 3032 3033 /** 3034 * Updates the translation of the web content article. 3035 * 3036 * @param groupId the primary key of the web content article's group 3037 * @param articleId the primary key of the web content article 3038 * @param version the web content article's version 3039 * @param locale the locale of the web content article's display template 3040 * @param title the translated web content article title 3041 * @param description the translated web content article description 3042 * @param content the HTML content wrapped in XML. For more information, 3043 see the content example in the class description for {@link 3044 JournalArticleLocalServiceImpl}. 3045 * @param images the web content's images 3046 * @param serviceContext the service context to be applied. Can set the 3047 modification date and "urlTitle" attribute for the web content 3048 article. 3049 * @return the updated web content article 3050 * @throws PortalException if a user with the primary key or a matching web 3051 content article could not be found, or if a portal exception 3052 occurred 3053 * @throws SystemException if a system exception occurred 3054 */ 3055 public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 3056 long groupId, java.lang.String articleId, double version, 3057 java.util.Locale locale, java.lang.String title, 3058 java.lang.String description, java.lang.String content, 3059 java.util.Map<java.lang.String, byte[]> images, 3060 com.liferay.portal.service.ServiceContext serviceContext) 3061 throws com.liferay.portal.kernel.exception.PortalException, 3062 com.liferay.portal.kernel.exception.SystemException { 3063 return _journalArticleLocalService.updateArticleTranslation(groupId, 3064 articleId, version, locale, title, description, content, images, 3065 serviceContext); 3066 } 3067 3068 /** 3069 * Updates the web content article's asset with the new asset categories, 3070 * tag names, and link entries, removing and adding them as necessary. 3071 * 3072 * @param userId the primary key of the user updating the web content 3073 article's asset 3074 * @param article the web content article 3075 * @param assetCategoryIds the primary keys of the new asset categories 3076 * @param assetTagNames the new asset tag names 3077 * @param assetLinkEntryIds the primary keys of the new asset link entries 3078 * @throws PortalException if a portal exception occurred 3079 * @throws SystemException if a system exception occurred 3080 */ 3081 public void updateAsset(long userId, 3082 com.liferay.portlet.journal.model.JournalArticle article, 3083 long[] assetCategoryIds, java.lang.String[] assetTagNames, 3084 long[] assetLinkEntryIds) 3085 throws com.liferay.portal.kernel.exception.PortalException, 3086 com.liferay.portal.kernel.exception.SystemException { 3087 _journalArticleLocalService.updateAsset(userId, article, 3088 assetCategoryIds, assetTagNames, assetLinkEntryIds); 3089 } 3090 3091 /** 3092 * Updates the web content article matching the group, article ID, and 3093 * version, replacing its content. 3094 * 3095 * @param groupId the primary key of the web content article's group 3096 * @param articleId the primary key of the web content article 3097 * @param version the web content article's version 3098 * @param content the HTML content wrapped in XML. For more information, 3099 see the content example in the class description for {@link 3100 JournalArticleLocalServiceImpl}. 3101 * @return the updated web content article 3102 * @throws PortalException if a matching web content article could not be 3103 found 3104 * @throws SystemException if a system exception occurred 3105 */ 3106 public com.liferay.portlet.journal.model.JournalArticle updateContent( 3107 long groupId, java.lang.String articleId, double version, 3108 java.lang.String content) 3109 throws com.liferay.portal.kernel.exception.PortalException, 3110 com.liferay.portal.kernel.exception.SystemException { 3111 return _journalArticleLocalService.updateContent(groupId, articleId, 3112 version, content); 3113 } 3114 3115 /** 3116 * Updates the workflow status of the web content article. 3117 * 3118 * @param userId the primary key of the user updating the web content 3119 article's status 3120 * @param article the web content article 3121 * @param status the web content article's workflow status. For more 3122 information see {@link WorkflowConstants} for constants starting 3123 with the "STATUS_" prefix. 3124 * @param articleURL the web content article's accessible URL 3125 * @param workflowContext the web content article's configured workflow 3126 context 3127 * @param serviceContext the service context to be applied. Can set the 3128 modification date, status date, and portlet preferences. With 3129 respect to social activities, by setting the service context's 3130 command to {@link 3131 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 3132 is considered a web content update activity; otherwise it is 3133 considered a web content add activity. 3134 * @return the updated web content article 3135 * @throws PortalException if a portal exception occurred 3136 * @throws SystemException if a system exception occurred 3137 */ 3138 public com.liferay.portlet.journal.model.JournalArticle updateStatus( 3139 long userId, com.liferay.portlet.journal.model.JournalArticle article, 3140 int status, java.lang.String articleURL, 3141 java.util.Map<java.lang.String, java.io.Serializable> workflowContext, 3142 com.liferay.portal.service.ServiceContext serviceContext) 3143 throws com.liferay.portal.kernel.exception.PortalException, 3144 com.liferay.portal.kernel.exception.SystemException { 3145 return _journalArticleLocalService.updateStatus(userId, article, 3146 status, articleURL, workflowContext, serviceContext); 3147 } 3148 3149 /** 3150 * Updates the workflow status of the web content article matching the class 3151 * PK. 3152 * 3153 * @param userId the primary key of the user updating the web content 3154 article's status 3155 * @param classPK the primary key of the DDM structure, if the web content 3156 article is related to a DDM structure, the primary key of the 3157 class associated with the article, or <code>0</code> otherwise 3158 * @param status the web content article's workflow status. For more 3159 information see {@link WorkflowConstants} for constants starting 3160 with the "STATUS_" prefix. 3161 * @param workflowContext the web content article's configured workflow 3162 * @param serviceContext the service context to be applied. Can set the 3163 modification date, portlet preferences, and can set whether to 3164 add the default command update for the web content article. 3165 * @return the updated web content article 3166 * @throws PortalException if a matching web content article could not be 3167 found or if a portal exception occurred 3168 * @throws SystemException if a system exception occurred 3169 */ 3170 public com.liferay.portlet.journal.model.JournalArticle updateStatus( 3171 long userId, long classPK, int status, 3172 java.util.Map<java.lang.String, java.io.Serializable> workflowContext, 3173 com.liferay.portal.service.ServiceContext serviceContext) 3174 throws com.liferay.portal.kernel.exception.PortalException, 3175 com.liferay.portal.kernel.exception.SystemException { 3176 return _journalArticleLocalService.updateStatus(userId, classPK, 3177 status, workflowContext, serviceContext); 3178 } 3179 3180 /** 3181 * Updates the workflow status of the web content article matching the 3182 * group, article ID, and version. 3183 * 3184 * @param userId the primary key of the user updating the web content 3185 article's status 3186 * @param groupId the primary key of the web content article's group 3187 * @param articleId the primary key of the web content article 3188 * @param version the web content article's version 3189 * @param status the web content article's workflow status. For more 3190 information see {@link WorkflowConstants} for constants starting 3191 with the "STATUS_" prefix. 3192 * @param articleURL the web content article's accessible URL 3193 * @param workflowContext the web content article's configured workflow 3194 * @param serviceContext the service context to be applied. Can set the 3195 modification date, portlet preferences, and can set whether to 3196 add the default command update for the web content article. 3197 * @return the updated web content article 3198 * @throws PortalException if a matching web content article could not be 3199 found or if a portal exception occurred 3200 * @throws SystemException if a system exception occurred 3201 */ 3202 public com.liferay.portlet.journal.model.JournalArticle updateStatus( 3203 long userId, long groupId, java.lang.String articleId, double version, 3204 int status, java.lang.String articleURL, 3205 java.util.Map<java.lang.String, java.io.Serializable> workflowContext, 3206 com.liferay.portal.service.ServiceContext serviceContext) 3207 throws com.liferay.portal.kernel.exception.PortalException, 3208 com.liferay.portal.kernel.exception.SystemException { 3209 return _journalArticleLocalService.updateStatus(userId, groupId, 3210 articleId, version, status, articleURL, workflowContext, 3211 serviceContext); 3212 } 3213 3214 /** 3215 * Updates the web content articles matching the group, class name ID, and 3216 * DDM template key, replacing the DDM template key with a new one. 3217 * 3218 * @param groupId the primary key of the web content article's group 3219 * @param classNameId the primary key of the DDMStructure class if the web 3220 content article is related to a DDM structure, the primary key of 3221 the class name associated with the article, or {@link 3222 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 3223 * @param oldDDMTemplateKey the primary key of the web content article's 3224 old DDM template 3225 * @param newDDMTemplateKey the primary key of the web content article's 3226 new DDM template 3227 * @throws SystemException if a system exception occurred 3228 */ 3229 public void updateTemplateId(long groupId, long classNameId, 3230 java.lang.String oldDDMTemplateKey, java.lang.String newDDMTemplateKey) 3231 throws com.liferay.portal.kernel.exception.SystemException { 3232 _journalArticleLocalService.updateTemplateId(groupId, classNameId, 3233 oldDDMTemplateKey, newDDMTemplateKey); 3234 } 3235 3236 /** 3237 * @deprecated As of 6.1.0, replaced by {@link #getWrappedService} 3238 */ 3239 public JournalArticleLocalService getWrappedJournalArticleLocalService() { 3240 return _journalArticleLocalService; 3241 } 3242 3243 /** 3244 * @deprecated As of 6.1.0, replaced by {@link #setWrappedService} 3245 */ 3246 public void setWrappedJournalArticleLocalService( 3247 JournalArticleLocalService journalArticleLocalService) { 3248 _journalArticleLocalService = journalArticleLocalService; 3249 } 3250 3251 public JournalArticleLocalService getWrappedService() { 3252 return _journalArticleLocalService; 3253 } 3254 3255 public void setWrappedService( 3256 JournalArticleLocalService journalArticleLocalService) { 3257 _journalArticleLocalService = journalArticleLocalService; 3258 } 3259 3260 private JournalArticleLocalService _journalArticleLocalService; 3261 }