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 aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the remote service utility for JournalArticle. This utility wraps 024 * {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on a remote server. Methods of this service are expected to have security 027 * checks based on the propagated JAAS credentials because this service can be 028 * accessed remotely. 029 * 030 * @author Brian Wing Shun Chan 031 * @see JournalArticleService 032 * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl 033 * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class JournalArticleServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Returns the Spring bean ID for this bean. 046 * 047 * @return the Spring bean ID for this bean 048 */ 049 public static java.lang.String getBeanIdentifier() { 050 return getService().getBeanIdentifier(); 051 } 052 053 /** 054 * Sets the Spring bean ID for this bean. 055 * 056 * @param beanIdentifier the Spring bean ID for this bean 057 */ 058 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 059 getService().setBeanIdentifier(beanIdentifier); 060 } 061 062 /** 063 * Adds a web content article with additional parameters. 064 * 065 * @param groupId the primary key of the web content article's group 066 * @param folderId the primary key of the web content article folder 067 * @param classNameId the primary key of the DDMStructure class if the web 068 content article is related to a DDM structure, the primary key of 069 the class name associated with the article, or {@link 070 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 071 * @param classPK the primary key of the DDM structure, if the primary key 072 of the DDMStructure class is given as the 073 <code>classNameId</code> parameter, the primary key of the class 074 associated with the web content article, or <code>0</code> 075 otherwise 076 * @param articleId the primary key of the web content article 077 * @param autoArticleId whether to auto generate the web content article ID 078 * @param titleMap the web content article's locales and localized titles 079 * @param descriptionMap the web content article's locales and localized 080 descriptions 081 * @param content the HTML content wrapped in XML. For more information, 082 see the content example in the class description for {@link 083 JournalArticleLocalServiceImpl}. 084 * @param type the structure's type, if the web content article is related 085 to a DDM structure. For more information, see {@link 086 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 087 * @param ddmStructureKey the primary key of the web content article's DDM 088 structure, if the article is related to a DDM structure, or 089 <code>null</code> otherwise 090 * @param ddmTemplateKey the primary key of the web content article's DDM 091 template (optionally <code>null</code>). If the article is 092 related to a DDM structure, the template's structure must match 093 it. 094 * @param layoutUuid the unique string identifying the web content 095 article's display page 096 * @param displayDateMonth the month the web content article is set to 097 display 098 * @param displayDateDay the calendar day the web content article is set to 099 display 100 * @param displayDateYear the year the web content article is set to 101 display 102 * @param displayDateHour the hour the web content article is set to 103 display 104 * @param displayDateMinute the minute the web content article is set to 105 display 106 * @param expirationDateMonth the month the web content article is set to 107 expire 108 * @param expirationDateDay the calendar day the web content article is set 109 to expire 110 * @param expirationDateYear the year the web content article is set to 111 expire 112 * @param expirationDateHour the hour the web content article is set to 113 expire 114 * @param expirationDateMinute the minute the web content article is set to 115 expire 116 * @param neverExpire whether the web content article is not set to auto 117 expire 118 * @param reviewDateMonth the month the web content article is set for 119 review 120 * @param reviewDateDay the calendar day the web content article is set for 121 review 122 * @param reviewDateYear the year the web content article is set for review 123 * @param reviewDateHour the hour the web content article is set for review 124 * @param reviewDateMinute the minute the web content article is set for 125 review 126 * @param neverReview whether the web content article is not set for review 127 * @param indexable whether the web content article is searchable 128 * @param smallImage whether the web content article has a small image 129 * @param smallImageURL the web content article's small image URL 130 * @param smallFile the web content article's small image file 131 * @param images the web content's images 132 * @param articleURL the web content article's accessible URL 133 * @param serviceContext the service context to be applied. Can set the 134 UUID, creation date, modification date, expando bridge 135 attributes, guest permissions, group permissions, asset category 136 IDs, asset tag names, asset link entry IDs, the "urlTitle" 137 attribute, and workflow actions for the web content article. Can 138 also set whether to add the default guest and group permissions. 139 * @return the web content article 140 * @throws PortalException if the user did not have permission to add the 141 web content article or if a portal exception occurred 142 * @throws SystemException if a system exception occurred 143 */ 144 public static com.liferay.portlet.journal.model.JournalArticle addArticle( 145 long groupId, long folderId, long classNameId, long classPK, 146 java.lang.String articleId, boolean autoArticleId, 147 java.util.Map<java.util.Locale, java.lang.String> titleMap, 148 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 149 java.lang.String content, java.lang.String type, 150 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 151 java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, 152 int displayDateYear, int displayDateHour, int displayDateMinute, 153 int expirationDateMonth, int expirationDateDay, int expirationDateYear, 154 int expirationDateHour, int expirationDateMinute, boolean neverExpire, 155 int reviewDateMonth, int reviewDateDay, int reviewDateYear, 156 int reviewDateHour, int reviewDateMinute, boolean neverReview, 157 boolean indexable, boolean smallImage, java.lang.String smallImageURL, 158 java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images, 159 java.lang.String articleURL, 160 com.liferay.portal.service.ServiceContext serviceContext) 161 throws com.liferay.portal.kernel.exception.PortalException, 162 com.liferay.portal.kernel.exception.SystemException { 163 return getService() 164 .addArticle(groupId, folderId, classNameId, classPK, 165 articleId, autoArticleId, titleMap, descriptionMap, content, type, 166 ddmStructureKey, ddmTemplateKey, layoutUuid, displayDateMonth, 167 displayDateDay, displayDateYear, displayDateHour, 168 displayDateMinute, expirationDateMonth, expirationDateDay, 169 expirationDateYear, expirationDateHour, expirationDateMinute, 170 neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear, 171 reviewDateHour, reviewDateMinute, neverReview, indexable, 172 smallImage, smallImageURL, smallFile, images, articleURL, 173 serviceContext); 174 } 175 176 /** 177 * Adds a web content article without any images. 178 * 179 * @param groupId the primary key of the web content article's group 180 * @param folderId the primary key of the web content article folder 181 * @param classNameId the primary key of the DDMStructure class if the web 182 content article is related to a DDM structure, the primary key of 183 the class name associated with the article, or {@link 184 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 185 * @param classPK the primary key of the DDM structure, if the primary key 186 of the DDMStructure class is given as the 187 <code>classNameId</code> parameter, the primary key of the class 188 associated with the web content article, or <code>0</code> 189 otherwise 190 * @param articleId the primary key of the web content article 191 * @param autoArticleId whether to auto generate the web content article ID 192 * @param titleMap the web content article's locales and localized titles 193 * @param descriptionMap the web content article's locales and localized 194 descriptions 195 * @param content the HTML content wrapped in XML. For more information, 196 see the content example in the class description for {@link 197 JournalArticleLocalServiceImpl}. 198 * @param type the structure's type, if the web content article is related 199 to a DDM structure. For more information, see {@link 200 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 201 * @param ddmStructureKey the primary key of the web content article's DDM 202 structure, if the article is related to a DDM structure, or 203 <code>null</code> otherwise 204 * @param ddmTemplateKey the primary key of the web content article's DDM 205 template (optionally <code>null</code>). If the article is 206 related to a DDM structure, the template's structure must match 207 it. 208 * @param layoutUuid the unique string identifying the web content 209 article's display page 210 * @param displayDateMonth the month the web content article is set to 211 display 212 * @param displayDateDay the calendar day the web content article is set to 213 display 214 * @param displayDateYear the year the web content article is set to 215 display 216 * @param displayDateHour the hour the web content article is set to 217 display 218 * @param displayDateMinute the minute the web content article is set to 219 display 220 * @param expirationDateMonth the month the web content article is set to 221 expire 222 * @param expirationDateDay the calendar day the web content article is set 223 to expire 224 * @param expirationDateYear the year the web content article is set to 225 expire 226 * @param expirationDateHour the hour the web content article is set to 227 expire 228 * @param expirationDateMinute the minute the web content article is set to 229 expire 230 * @param neverExpire whether the web content article is not set to auto 231 expire 232 * @param reviewDateMonth the month the web content article is set for 233 review 234 * @param reviewDateDay the calendar day the web content article is set for 235 review 236 * @param reviewDateYear the year the web content article is set for review 237 * @param reviewDateHour the hour the web content article is set for review 238 * @param reviewDateMinute the minute the web content article is set for 239 review 240 * @param neverReview whether the web content article is not set for review 241 * @param indexable whether the web content article is searchable 242 * @param articleURL the web content article's accessible URL 243 * @param serviceContext the service context to be applied. Can set the 244 UUID, creation date, modification date, expando bridge 245 attributes, guest permissions, group permissions, asset category 246 IDs, asset tag names, asset link entry IDs, the "urlTitle" 247 attribute, and workflow actions for the web content article. Can 248 also set whether to add the default guest and group permissions. 249 * @return the web content article 250 * @throws PortalException if the user did not have permission to add the 251 web content article or if a portal exception occurred 252 * @throws SystemException if a system exception occurred 253 */ 254 public static com.liferay.portlet.journal.model.JournalArticle addArticle( 255 long groupId, long folderId, long classNameId, long classPK, 256 java.lang.String articleId, boolean autoArticleId, 257 java.util.Map<java.util.Locale, java.lang.String> titleMap, 258 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 259 java.lang.String content, java.lang.String type, 260 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 261 java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, 262 int displayDateYear, int displayDateHour, int displayDateMinute, 263 int expirationDateMonth, int expirationDateDay, int expirationDateYear, 264 int expirationDateHour, int expirationDateMinute, boolean neverExpire, 265 int reviewDateMonth, int reviewDateDay, int reviewDateYear, 266 int reviewDateHour, int reviewDateMinute, boolean neverReview, 267 boolean indexable, java.lang.String articleURL, 268 com.liferay.portal.service.ServiceContext serviceContext) 269 throws com.liferay.portal.kernel.exception.PortalException, 270 com.liferay.portal.kernel.exception.SystemException { 271 return getService() 272 .addArticle(groupId, folderId, classNameId, classPK, 273 articleId, autoArticleId, titleMap, descriptionMap, content, type, 274 ddmStructureKey, ddmTemplateKey, layoutUuid, displayDateMonth, 275 displayDateDay, displayDateYear, displayDateHour, 276 displayDateMinute, expirationDateMonth, expirationDateDay, 277 expirationDateYear, expirationDateHour, expirationDateMinute, 278 neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear, 279 reviewDateHour, reviewDateMinute, neverReview, indexable, 280 articleURL, serviceContext); 281 } 282 283 /** 284 * Copies the web content article matching the group, article ID, and 285 * version. This method creates a new article, extracting all the values 286 * from the old one and updating its article ID. 287 * 288 * @param groupId the primary key of the web content article's group 289 * @param oldArticleId the primary key of the old web content article 290 * @param newArticleId the primary key of the new web content article 291 * @param autoArticleId whether to auto-generate the web content article ID 292 * @param version the web content article's version 293 * @return the new web content article 294 * @throws PortalException if the user did not have permission to add the 295 copy the web content article, if a matching web content article 296 could not be found, or if a portal exception occurred 297 * @throws SystemException if a system exception occurred 298 */ 299 public static com.liferay.portlet.journal.model.JournalArticle copyArticle( 300 long groupId, java.lang.String oldArticleId, 301 java.lang.String newArticleId, boolean autoArticleId, double version) 302 throws com.liferay.portal.kernel.exception.PortalException, 303 com.liferay.portal.kernel.exception.SystemException { 304 return getService() 305 .copyArticle(groupId, oldArticleId, newArticleId, 306 autoArticleId, version); 307 } 308 309 /** 310 * Deletes the web content article and its resources matching the group, 311 * article ID, and version, optionally sending email notifying denial of the 312 * web content article if it had not yet been approved. 313 * 314 * @param groupId the primary key of the web content article's group 315 * @param articleId the primary key of the web content article 316 * @param version the web content article's version 317 * @param articleURL the web content article's accessible URL 318 * @param serviceContext the service context to be applied. Can set the 319 portlet preferences that include email information to notify 320 recipients of the unapproved web content article's denial. 321 * @throws PortalException if the user did not have permission to delete the 322 web content article, if a matching web content article could not 323 be found, or if a portal exception occurred 324 * @throws SystemException if a system exception occurred 325 */ 326 public static void deleteArticle(long groupId, java.lang.String articleId, 327 double version, java.lang.String articleURL, 328 com.liferay.portal.service.ServiceContext serviceContext) 329 throws com.liferay.portal.kernel.exception.PortalException, 330 com.liferay.portal.kernel.exception.SystemException { 331 getService() 332 .deleteArticle(groupId, articleId, version, articleURL, 333 serviceContext); 334 } 335 336 /** 337 * Deletes all web content articles and their resources matching the group 338 * and article ID, optionally sending email notifying denial of article if 339 * it had not yet been approved. 340 * 341 * @param groupId the primary key of the web content article's group 342 * @param articleId the primary key of the web content article 343 * @param articleURL the web content article's accessible URL 344 * @param serviceContext the service context to be applied. Can set the 345 portlet preferences that include email information to notify 346 recipients of the unapproved web content article's denial. 347 * @throws PortalException if the user did not have permission to delete the 348 web content article or if a portal exception occurred 349 * @throws SystemException if a system exception occurred 350 */ 351 public static void deleteArticle(long groupId, java.lang.String articleId, 352 java.lang.String articleURL, 353 com.liferay.portal.service.ServiceContext serviceContext) 354 throws com.liferay.portal.kernel.exception.PortalException, 355 com.liferay.portal.kernel.exception.SystemException { 356 getService() 357 .deleteArticle(groupId, articleId, articleURL, serviceContext); 358 } 359 360 /** 361 * Expires the web content article matching the group, article ID, and 362 * version. 363 * 364 * @param groupId the primary key of the web content article's group 365 * @param articleId the primary key of the web content article 366 * @param version the web content article's version 367 * @param articleURL the web content article's accessible URL 368 * @param serviceContext the service context to be applied. Can set the 369 modification date, status date, portlet preferences, and can set 370 whether to add the default command update for the web content 371 article. With respect to social activities, by setting the 372 service context's command to {@link 373 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 374 is considered a web content update activity; otherwise it is 375 considered a web content add activity. 376 * @return the web content article 377 * @throws PortalException if the user did not have permission to expire the 378 web content article, if a matching web content article could not 379 be found, or if a portal exception occurred 380 * @throws SystemException if a system exception occurred 381 */ 382 public static com.liferay.portlet.journal.model.JournalArticle expireArticle( 383 long groupId, java.lang.String articleId, double version, 384 java.lang.String articleURL, 385 com.liferay.portal.service.ServiceContext serviceContext) 386 throws com.liferay.portal.kernel.exception.PortalException, 387 com.liferay.portal.kernel.exception.SystemException { 388 return getService() 389 .expireArticle(groupId, articleId, version, articleURL, 390 serviceContext); 391 } 392 393 /** 394 * Expires the web content article matching the group and article ID, 395 * expiring all of its versions if the 396 * <code>journal.article.expire.all.versions</code> portal property is 397 * <code>true</code>, otherwise expiring only its latest approved version. 398 * 399 * @param groupId the primary key of the web content article's group 400 * @param articleId the primary key of the web content article 401 * @param articleURL the web content article's accessible URL 402 * @param serviceContext the service context to be applied. Can set the 403 modification date, status date, portlet preferences, and can set 404 whether to add the default command update for the web content 405 article. With respect to social activities, by setting the 406 service context's command to {@link 407 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 408 is considered a web content update activity; otherwise it is 409 considered a web content add activity. 410 * @throws PortalException if the user did not have permission to expire the 411 web content article, if a matching web content article could not 412 be found, or if a portal exception occurred 413 * @throws SystemException if a system exception occurred 414 */ 415 public static void expireArticle(long groupId, java.lang.String articleId, 416 java.lang.String articleURL, 417 com.liferay.portal.service.ServiceContext serviceContext) 418 throws com.liferay.portal.kernel.exception.PortalException, 419 com.liferay.portal.kernel.exception.SystemException { 420 getService() 421 .expireArticle(groupId, articleId, articleURL, serviceContext); 422 } 423 424 /** 425 * Returns the web content article with the ID. 426 * 427 * @param id the primary key of the web content article 428 * @return the web content article with the ID 429 * @throws PortalException if a matching web content article could not be 430 found or if the user did not have permission to view the web 431 content article 432 * @throws SystemException if a system exception occurred 433 */ 434 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 435 long id) 436 throws com.liferay.portal.kernel.exception.PortalException, 437 com.liferay.portal.kernel.exception.SystemException { 438 return getService().getArticle(id); 439 } 440 441 /** 442 * Returns the latest approved web content article, or the latest unapproved 443 * article if none are approved. Both approved and unapproved articles must 444 * match the group and article ID. 445 * 446 * @param groupId the primary key of the web content article's group 447 * @param articleId the primary key of the web content article 448 * @return the matching web content article 449 * @throws PortalException if the user did not have permission to view the 450 web content article or if a matching web content article could 451 not be found 452 * @throws SystemException if a system exception occurred 453 */ 454 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 455 long groupId, java.lang.String articleId) 456 throws com.liferay.portal.kernel.exception.PortalException, 457 com.liferay.portal.kernel.exception.SystemException { 458 return getService().getArticle(groupId, articleId); 459 } 460 461 /** 462 * Returns the web content article matching the group, article ID, and 463 * version. 464 * 465 * @param groupId the primary key of the web content article's group 466 * @param articleId the primary key of the web content article 467 * @param version the web content article's version 468 * @return the matching web content article 469 * @throws PortalException if the user did not have permission to view the 470 web content article or if a matching web content article could 471 not be found 472 * @throws SystemException if a system exception occurred 473 */ 474 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 475 long groupId, java.lang.String articleId, double version) 476 throws com.liferay.portal.kernel.exception.PortalException, 477 com.liferay.portal.kernel.exception.SystemException { 478 return getService().getArticle(groupId, articleId, version); 479 } 480 481 /** 482 * Returns the web content article matching the group, class name, and class 483 * PK. 484 * 485 * @param groupId the primary key of the web content article's group 486 * @param className the DDMStructure class name if the web content article 487 is related to a DDM structure, the primary key of the class name 488 associated with the article, or {@link 489 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 490 * @param classPK the primary key of the DDM structure, if the the 491 DDMStructure class name is given as the <code>className</code> 492 parameter, the primary key of the class associated with the web 493 content article, or <code>0</code> otherwise 494 * @return the matching web content article 495 * @throws PortalException if a matching web content article could not be 496 found or if the user did not have permission to view the web 497 content article 498 * @throws SystemException if a system exception occurred 499 */ 500 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 501 long groupId, java.lang.String className, long classPK) 502 throws com.liferay.portal.kernel.exception.PortalException, 503 com.liferay.portal.kernel.exception.SystemException { 504 return getService().getArticle(groupId, className, classPK); 505 } 506 507 /** 508 * Returns the latest web content article that is approved, or the latest 509 * unapproved article if none are approved. Both approved and unapproved 510 * articles must match the group and URL title. 511 * 512 * @param groupId the primary key of the web content article's group 513 * @param urlTitle the web content article's accessible URL title 514 * @return the matching web content article 515 * @throws PortalException if the user did not have permission to view the 516 web content article or if a portal exception occurred 517 * @throws SystemException if a system exception occurred 518 */ 519 public static com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle( 520 long groupId, java.lang.String urlTitle) 521 throws com.liferay.portal.kernel.exception.PortalException, 522 com.liferay.portal.kernel.exception.SystemException { 523 return getService().getArticleByUrlTitle(groupId, urlTitle); 524 } 525 526 /** 527 * Returns the web content matching the group, article ID, and version. 528 * 529 * @param groupId the primary key of the web content article's group 530 * @param articleId the primary key of the web content article 531 * @param version the web content article's version 532 * @param languageId the primary key of the language translation to get 533 * @param themeDisplay the theme display 534 * @return the matching web content 535 * @throws PortalException if the user did not have permission to view the 536 web content article, if a matching web content article or DDM 537 template could not be found, or if a portal exception occurred 538 * @throws SystemException if a system exception occurred 539 */ 540 public static java.lang.String getArticleContent(long groupId, 541 java.lang.String articleId, double version, 542 java.lang.String languageId, 543 com.liferay.portal.theme.ThemeDisplay themeDisplay) 544 throws com.liferay.portal.kernel.exception.PortalException, 545 com.liferay.portal.kernel.exception.SystemException { 546 return getService() 547 .getArticleContent(groupId, articleId, version, languageId, 548 themeDisplay); 549 } 550 551 /** 552 * Returns the latest web content matching the group and article ID. 553 * 554 * @param groupId the primary key of the web content article's group 555 * @param articleId the primary key of the web content article 556 * @param languageId the primary key of the language translation to get 557 * @param themeDisplay the theme display 558 * @return the matching web content 559 * @throws PortalException if the user did not have permission to view the 560 web content article, if a matching web content article or DDM 561 template could not be found, or if a portal exception occurred 562 * @throws SystemException if a system exception occurred 563 */ 564 public static java.lang.String getArticleContent(long groupId, 565 java.lang.String articleId, java.lang.String languageId, 566 com.liferay.portal.theme.ThemeDisplay themeDisplay) 567 throws com.liferay.portal.kernel.exception.PortalException, 568 com.liferay.portal.kernel.exception.SystemException { 569 return getService() 570 .getArticleContent(groupId, articleId, languageId, 571 themeDisplay); 572 } 573 574 /** 575 * Returns all the web content articles matching the group and folder. 576 * 577 * @param groupId the primary key of the web content article's group 578 * @param folderId the primary key of the web content article folder 579 * @return the matching web content articles 580 * @throws SystemException if a system exception occurred 581 */ 582 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 583 long groupId, long folderId) 584 throws com.liferay.portal.kernel.exception.SystemException { 585 return getService().getArticles(groupId, folderId); 586 } 587 588 /** 589 * Returns an ordered range of all the web content articles matching the 590 * group and folder. 591 * 592 * <p> 593 * Useful when paginating results. Returns a maximum of <code>end - 594 * start</code> instances. <code>start</code> and <code>end</code> are not 595 * primary keys, they are indexes in the result set. Thus, <code>0</code> 596 * refers to the first result in the set. Setting both <code>start</code> 597 * and <code>end</code> to {@link 598 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 599 * result set. 600 * </p> 601 * 602 * @param groupId the primary key of the web content article's group 603 * @param folderId the primary key of the web content article folder 604 * @param start the lower bound of the range of web content articles to 605 return 606 * @param end the upper bound of the range of web content articles to 607 return (not inclusive) 608 * @param obc the comparator to order the web content articles 609 * @return the matching web content articles 610 * @throws SystemException if a system exception occurred 611 */ 612 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 613 long groupId, long folderId, int start, int end, 614 com.liferay.portal.kernel.util.OrderByComparator obc) 615 throws com.liferay.portal.kernel.exception.SystemException { 616 return getService().getArticles(groupId, folderId, start, end, obc); 617 } 618 619 /** 620 * Returns an ordered range of all the web content articles matching the 621 * group and article ID. 622 * 623 * <p> 624 * Useful when paginating results. Returns a maximum of <code>end - 625 * start</code> instances. <code>start</code> and <code>end</code> are not 626 * primary keys, they are indexes in the result set. Thus, <code>0</code> 627 * refers to the first result in the set. Setting both <code>start</code> 628 * and <code>end</code> to {@link 629 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 630 * result set. 631 * </p> 632 * 633 * @param groupId the primary key of the web content article's group 634 * @param articleId the primary key of the web content article 635 * @param start the lower bound of the range of web content articles to 636 return 637 * @param end the upper bound of the range of web content articles to 638 return (not inclusive) 639 * @param obc the comparator to order the web content articles 640 * @return the range of matching web content articles ordered by the 641 comparator 642 * @throws SystemException if a system exception occurred 643 */ 644 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByArticleId( 645 long groupId, java.lang.String articleId, int start, int end, 646 com.liferay.portal.kernel.util.OrderByComparator obc) 647 throws com.liferay.portal.kernel.exception.SystemException { 648 return getService() 649 .getArticlesByArticleId(groupId, articleId, start, end, obc); 650 } 651 652 /** 653 * Returns all the web content articles matching the group and layout UUID. 654 * 655 * @param groupId the primary key of the web content article's group 656 * @param layoutUuid the unique string identifying the web content 657 article's display page 658 * @return the matching web content articles 659 * @throws SystemException if a system exception occurred 660 */ 661 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByLayoutUuid( 662 long groupId, java.lang.String layoutUuid) 663 throws com.liferay.portal.kernel.exception.SystemException { 664 return getService().getArticlesByLayoutUuid(groupId, layoutUuid); 665 } 666 667 /** 668 * Returns an ordered range of all the web content articles matching the 669 * group, class name ID, DDM structure key, and workflow status. 670 * 671 * <p> 672 * Useful when paginating results. Returns a maximum of <code>end - 673 * start</code> instances. <code>start</code> and <code>end</code> are not 674 * primary keys, they are indexes in the result set. Thus, <code>0</code> 675 * refers to the first result in the set. Setting both <code>start</code> 676 * and <code>end</code> to {@link 677 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 678 * result set. 679 * </p> 680 * 681 * @param groupId the primary key of the web content article's group 682 * @param classNameId the primary key of the DDMStructure class if the web 683 content article is related to a DDM structure, the primary key of 684 the class name associated with the article, or {@link 685 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 686 * @param ddmStructureKey the primary key of the web content article's DDM 687 structure 688 * @param status the web content article's workflow status. For more 689 information see {@link WorkflowConstants} for constants starting 690 with the "STATUS_" prefix. 691 * @param start the lower bound of the range of web content articles to 692 return 693 * @param end the upper bound of the range of web content articles to 694 return (not inclusive) 695 * @param obc the comparator to order the web content articles 696 * @return the range of matching web content articles ordered by the 697 comparator 698 * @throws SystemException if a system exception occurred 699 */ 700 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByStructureId( 701 long groupId, long classNameId, java.lang.String ddmStructureKey, 702 int status, int start, int end, 703 com.liferay.portal.kernel.util.OrderByComparator obc) 704 throws com.liferay.portal.kernel.exception.SystemException { 705 return getService() 706 .getArticlesByStructureId(groupId, classNameId, 707 ddmStructureKey, status, start, end, obc); 708 } 709 710 /** 711 * Returns an ordered range of all the web content articles matching the 712 * group, default class name ID, and DDM structure key. 713 * 714 * <p> 715 * Useful when paginating results. Returns a maximum of <code>end - 716 * start</code> instances. <code>start</code> and <code>end</code> are not 717 * primary keys, they are indexes in the result set. Thus, <code>0</code> 718 * refers to the first result in the set. Setting both <code>start</code> 719 * and <code>end</code> to {@link 720 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 721 * result set. 722 * </p> 723 * 724 * @param groupId the primary key of the web content article's group 725 * @param ddmStructureKey the primary key of the web content article's DDM 726 structure 727 * @param start the lower bound of the range of web content articles to 728 return 729 * @param end the upper bound of the range of web content articles to 730 return (not inclusive) 731 * @param obc the comparator to order the web content articles 732 * @return the range of matching web content articles ordered by the 733 comparator 734 * @throws SystemException if a system exception occurred 735 */ 736 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByStructureId( 737 long groupId, java.lang.String ddmStructureKey, int start, int end, 738 com.liferay.portal.kernel.util.OrderByComparator obc) 739 throws com.liferay.portal.kernel.exception.SystemException { 740 return getService() 741 .getArticlesByStructureId(groupId, ddmStructureKey, start, 742 end, obc); 743 } 744 745 /** 746 * Returns the number of web content articles matching the group and folder. 747 * 748 * @param groupId the primary key of the web content article's group 749 * @param folderId the primary key of the web content article folder 750 * @return the number of matching web content articles 751 * @throws SystemException if a system exception occurred 752 */ 753 public static int getArticlesCount(long groupId, long folderId) 754 throws com.liferay.portal.kernel.exception.SystemException { 755 return getService().getArticlesCount(groupId, folderId); 756 } 757 758 public static int getArticlesCount(long groupId, long folderId, int status) 759 throws com.liferay.portal.kernel.exception.SystemException { 760 return getService().getArticlesCount(groupId, folderId, status); 761 } 762 763 /** 764 * Returns the number of web content articles matching the group and article 765 * ID. 766 * 767 * @param groupId the primary key of the web content article's group 768 * @param articleId the primary key of the web content article 769 * @return the number of matching web content articles 770 * @throws SystemException if a system exception occurred 771 */ 772 public static int getArticlesCountByArticleId(long groupId, 773 java.lang.String articleId) 774 throws com.liferay.portal.kernel.exception.SystemException { 775 return getService().getArticlesCountByArticleId(groupId, articleId); 776 } 777 778 /** 779 * Returns the number of web content articles matching the group, class name 780 * ID, DDM structure key, and workflow status. 781 * 782 * @param groupId the primary key of the web content article's group 783 * @param classNameId the primary key of the DDMStructure class if the web 784 content article is related to a DDM structure, the primary key of 785 the class name associated with the article, or {@link 786 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 787 * @param ddmStructureKey the primary key of the web content article's DDM 788 structure 789 * @param status the web content article's workflow status. For more 790 information see {@link WorkflowConstants} for constants starting 791 with the "STATUS_" prefix. 792 * @return the number of matching web content articles 793 * @throws SystemException if a system exception occurred 794 */ 795 public static int getArticlesCountByStructureId(long groupId, 796 long classNameId, java.lang.String ddmStructureKey, int status) 797 throws com.liferay.portal.kernel.exception.SystemException { 798 return getService() 799 .getArticlesCountByStructureId(groupId, classNameId, 800 ddmStructureKey, status); 801 } 802 803 /** 804 * Returns the number of web content articles matching the group, default 805 * class name ID, and DDM structure key. 806 * 807 * @param groupId the primary key of the web content article's group 808 * @param ddmStructureKey the primary key of the web content article's DDM 809 structure 810 * @return the number of matching web content articles 811 * @throws SystemException if a system exception occurred 812 */ 813 public static int getArticlesCountByStructureId(long groupId, 814 java.lang.String ddmStructureKey) 815 throws com.liferay.portal.kernel.exception.SystemException { 816 return getService() 817 .getArticlesCountByStructureId(groupId, ddmStructureKey); 818 } 819 820 /** 821 * Returns the web content article matching the URL title that is currently 822 * displayed or next to be displayed if no article is currently displayed. 823 * 824 * @param groupId the primary key of the web content article's group 825 * @param urlTitle the web content article's accessible URL title 826 * @return the web content article matching the URL title that is currently 827 displayed, or next one to be displayed if no version of the 828 article is currently displayed 829 * @throws PortalException if the user did not have permission to view the 830 web content article or if no approved matching web content 831 articles could be found 832 * @throws SystemException if a system exception occurred 833 */ 834 public static com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle( 835 long groupId, java.lang.String urlTitle) 836 throws com.liferay.portal.kernel.exception.PortalException, 837 com.liferay.portal.kernel.exception.SystemException { 838 return getService().getDisplayArticleByUrlTitle(groupId, urlTitle); 839 } 840 841 /** 842 * Returns the number of folders containing web content articles belonging 843 * to the group. 844 * 845 * @param groupId the primary key of the web content article's group 846 * @param folderIds the primary keys of the web content article folders 847 (optionally {@link java.util.Collections#EMPTY_LIST}) 848 * @return the number of matching folders containing web content articles 849 * @throws SystemException if a system exception occurred 850 */ 851 public static int getFoldersAndArticlesCount(long groupId, 852 java.util.List<java.lang.Long> folderIds) 853 throws com.liferay.portal.kernel.exception.SystemException { 854 return getService().getFoldersAndArticlesCount(groupId, folderIds); 855 } 856 857 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getGroupArticles( 858 long groupId, long userId, long rootFolderId, int status, int start, 859 int end, 860 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 861 throws com.liferay.portal.kernel.exception.PortalException, 862 com.liferay.portal.kernel.exception.SystemException { 863 return getService() 864 .getGroupArticles(groupId, userId, rootFolderId, status, 865 start, end, orderByComparator); 866 } 867 868 /** 869 * Returns an ordered range of all the web content articles matching the 870 * group, user, the root folder or any of its subfolders. 871 * 872 * @param groupId the primary key of the web content article's group 873 * @param userId the primary key of the user (optionally <code>0</code>) 874 * @param rootFolderId the primary key of the root folder to begin the 875 search 876 * @param start the lower bound of the range of web content articles to 877 return 878 * @param end the upper bound of the range of web content articles to 879 return (not inclusive) 880 * @param orderByComparator the comparator to order the web content 881 articles 882 * @return the range of matching web content articles ordered by the 883 comparator 884 * @throws PortalException if the root folder could not be found, if the 885 current user did not have permission to view the root folder, or 886 if a portal exception occurred 887 * @throws SystemException if a system exception occurred 888 */ 889 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getGroupArticles( 890 long groupId, long userId, long rootFolderId, int start, int end, 891 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 892 throws com.liferay.portal.kernel.exception.PortalException, 893 com.liferay.portal.kernel.exception.SystemException { 894 return getService() 895 .getGroupArticles(groupId, userId, rootFolderId, start, end, 896 orderByComparator); 897 } 898 899 /** 900 * Returns the number of web content articles matching the group, user, and 901 * the root folder or any of its subfolders. 902 * 903 * @param groupId the primary key of the web content article's group 904 * @param userId the primary key of the user (optionally <code>0</code>) 905 * @param rootFolderId the primary key of the root folder to begin the 906 search 907 * @return the number of matching web content articles 908 * @throws PortalException if the root folder could not be found, if the 909 current user did not have permission to view the root folder, or 910 if a portal exception occurred 911 * @throws SystemException if a system exception occurred 912 */ 913 public static int getGroupArticlesCount(long groupId, long userId, 914 long rootFolderId) 915 throws com.liferay.portal.kernel.exception.PortalException, 916 com.liferay.portal.kernel.exception.SystemException { 917 return getService().getGroupArticlesCount(groupId, userId, rootFolderId); 918 } 919 920 public static int getGroupArticlesCount(long groupId, long userId, 921 long rootFolderId, int status) 922 throws com.liferay.portal.kernel.exception.PortalException, 923 com.liferay.portal.kernel.exception.SystemException { 924 return getService() 925 .getGroupArticlesCount(groupId, userId, rootFolderId, status); 926 } 927 928 /** 929 * Returns the latest web content article matching the resource primary key, 930 * preferring articles with approved workflow status. 931 * 932 * @param resourcePrimKey the primary key of the resource instance 933 * @return the latest web content article matching the resource primary key, 934 preferring articles with approved workflow status 935 * @throws PortalException if the user did not have permission to view the 936 web content article or if a matching web content article could 937 not be found 938 * @throws SystemException if a system exception occurred 939 */ 940 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 941 long resourcePrimKey) 942 throws com.liferay.portal.kernel.exception.PortalException, 943 com.liferay.portal.kernel.exception.SystemException { 944 return getService().getLatestArticle(resourcePrimKey); 945 } 946 947 /** 948 * Returns the latest web content article matching the group, article ID, 949 * and workflow status. 950 * 951 * @param groupId the primary key of the web content article's group 952 * @param articleId the primary key of the web content article 953 * @param status the web content article's workflow status. For more 954 information see {@link WorkflowConstants} for constants starting 955 with the "STATUS_" prefix. 956 * @return the latest matching web content article 957 * @throws PortalException if the user did not have permission to view the 958 web content article or if a matching web content article could 959 not be found 960 * @throws SystemException if a system exception occurred 961 */ 962 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 963 long groupId, java.lang.String articleId, int status) 964 throws com.liferay.portal.kernel.exception.PortalException, 965 com.liferay.portal.kernel.exception.SystemException { 966 return getService().getLatestArticle(groupId, articleId, status); 967 } 968 969 /** 970 * Returns the latest web content article matching the group, class name ID, 971 * and class PK. 972 * 973 * @param groupId the primary key of the web content article's group 974 * @param className the DDMStructure class name if the web content article 975 is related to a DDM structure, the class name associated with the 976 article, or {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} 977 otherwise 978 * @param classPK the primary key of the DDM structure, if the DDMStructure 979 class name is given as the <code>className</code> parameter, the 980 primary key of the class associated with the web content article, 981 or <code>0</code> otherwise 982 * @return the latest matching web content article 983 * @throws PortalException if a matching web content article could not be 984 found or if the user did not have permission to view the web 985 content article 986 * @throws SystemException if a system exception occurred 987 */ 988 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 989 long groupId, java.lang.String className, long classPK) 990 throws com.liferay.portal.kernel.exception.PortalException, 991 com.liferay.portal.kernel.exception.SystemException { 992 return getService().getLatestArticle(groupId, className, classPK); 993 } 994 995 /** 996 * Moves all versions of the the web content article matching the group and 997 * article ID to the folder. 998 * 999 * @param groupId the primary key of the web content article's group 1000 * @param articleId the primary key of the web content article 1001 * @param newFolderId the primary key of the web content article's new 1002 folder 1003 * @throws PortalException if the user did not have permission to update any 1004 one of the versions of the web content article or if any one of 1005 the versions of the web content article could not be moved to the 1006 folder 1007 * @throws SystemException if a system exception occurred 1008 */ 1009 public static void moveArticle(long groupId, java.lang.String articleId, 1010 long newFolderId) 1011 throws com.liferay.portal.kernel.exception.PortalException, 1012 com.liferay.portal.kernel.exception.SystemException { 1013 getService().moveArticle(groupId, articleId, newFolderId); 1014 } 1015 1016 /** 1017 * Moves the web content article from the Recycle Bin to the folder. 1018 * 1019 * @param groupId the primary key of the web content article's group 1020 * @param resourcePrimKey the primary key of the resource instance 1021 * @param newFolderId the primary key of the web content article's new 1022 folder 1023 * @param serviceContext the service context to be applied. Can set the 1024 modification date, portlet preferences, and can set whether to 1025 add the default command update for the web content article. With 1026 respect to social activities, by setting the service context's 1027 command to {@link 1028 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 1029 is considered a web content update activity; otherwise it is 1030 considered a web content add activity. 1031 * @return the updated web content article, which was moved from the Recycle 1032 Bin to the folder 1033 * @throws PortalException if the user did not have permission to view or 1034 update the web content article, if a matching trashed web content 1035 article could not be found, or if a portal exception occurred 1036 * @throws SystemException if a system exception occurred 1037 */ 1038 public static com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( 1039 long groupId, long resourcePrimKey, long newFolderId, 1040 com.liferay.portal.service.ServiceContext serviceContext) 1041 throws com.liferay.portal.kernel.exception.PortalException, 1042 com.liferay.portal.kernel.exception.SystemException { 1043 return getService() 1044 .moveArticleFromTrash(groupId, resourcePrimKey, newFolderId, 1045 serviceContext); 1046 } 1047 1048 /** 1049 * Moves the web content article from the Recycle Bin to the folder. 1050 * 1051 * @param groupId the primary key of the web content article's group 1052 * @param articleId the primary key of the web content article 1053 * @param newFolderId the primary key of the web content article's new 1054 folder 1055 * @param serviceContext the service context to be applied. Can set the 1056 modification date, portlet preferences, and can set whether to 1057 add the default command update for the web content article. With 1058 respect to social activities, by setting the service context's 1059 command to {@link 1060 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 1061 is considered a web content update activity; otherwise it is 1062 considered a web content add activity. 1063 * @return the updated web content article, which was moved from the Recycle 1064 Bin to the folder 1065 * @throws PortalException if the user did not have permission to view or 1066 update the web content article, if a trashed web content article 1067 with the primary key could not be found, or if a portal exception 1068 occurred 1069 * @throws SystemException if a system exception occurred 1070 */ 1071 public static com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( 1072 long groupId, java.lang.String articleId, long newFolderId, 1073 com.liferay.portal.service.ServiceContext serviceContext) 1074 throws com.liferay.portal.kernel.exception.PortalException, 1075 com.liferay.portal.kernel.exception.SystemException { 1076 return getService() 1077 .moveArticleFromTrash(groupId, articleId, newFolderId, 1078 serviceContext); 1079 } 1080 1081 /** 1082 * Moves the latest version of the web content article matching the group 1083 * and article ID to the recycle bin. 1084 * 1085 * @param groupId the primary key of the web content article's group 1086 * @param articleId the primary key of the web content article 1087 * @return the moved web content article or <code>null</code> if no matching 1088 article was found 1089 * @throws PortalException if the user did not have permission to move the 1090 article to the Recycle Bin or if a portal exception occurred 1091 * @throws SystemException if a system exception occurred 1092 */ 1093 public static com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( 1094 long groupId, java.lang.String articleId) 1095 throws com.liferay.portal.kernel.exception.PortalException, 1096 com.liferay.portal.kernel.exception.SystemException { 1097 return getService().moveArticleToTrash(groupId, articleId); 1098 } 1099 1100 /** 1101 * Removes the web content of all the company's web content articles 1102 * matching the language. 1103 * 1104 * @param companyId the primary key of the web content article's company 1105 * @param languageId the primary key of the language locale to remove 1106 * @throws PortalException if the user did not have permission to update any 1107 one of the the web content articles or if web content matching 1108 the language could not be found for any one of the articles 1109 * @throws SystemException if a system exception occurred 1110 */ 1111 public static void removeArticleLocale(long companyId, 1112 java.lang.String languageId) 1113 throws com.liferay.portal.kernel.exception.PortalException, 1114 com.liferay.portal.kernel.exception.SystemException { 1115 getService().removeArticleLocale(companyId, languageId); 1116 } 1117 1118 /** 1119 * Removes the web content of the web content article matching the group, 1120 * article ID, and version, and language. 1121 * 1122 * @param groupId the primary key of the web content article's group 1123 * @param articleId the primary key of the web content article 1124 * @param version the web content article's version 1125 * @param languageId the primary key of the language locale to remove 1126 * @return the updated web content article with the locale removed 1127 * @throws PortalException if the user did not have permission to update the 1128 web content article or if a matching web content article could 1129 not be found 1130 * @throws SystemException if a system exception occurred 1131 */ 1132 public static com.liferay.portlet.journal.model.JournalArticle removeArticleLocale( 1133 long groupId, java.lang.String articleId, double version, 1134 java.lang.String languageId) 1135 throws com.liferay.portal.kernel.exception.PortalException, 1136 com.liferay.portal.kernel.exception.SystemException { 1137 return getService() 1138 .removeArticleLocale(groupId, articleId, version, languageId); 1139 } 1140 1141 /** 1142 * Restores the web content article associated with the resource primary key 1143 * from the Recycle Bin. 1144 * 1145 * @param resourcePrimKey the primary key of the resource instance 1146 * @throws PortalException if a matching web content article could not be 1147 found in the Recycle Bin, if the user did not have permission to 1148 view or restore the article, or if a portal exception occurred 1149 * @throws SystemException if a system exception occurred 1150 */ 1151 public static void restoreArticleFromTrash(long resourcePrimKey) 1152 throws com.liferay.portal.kernel.exception.PortalException, 1153 com.liferay.portal.kernel.exception.SystemException { 1154 getService().restoreArticleFromTrash(resourcePrimKey); 1155 } 1156 1157 /** 1158 * Restores the web content article from the Recycle Bin. 1159 * 1160 * @param groupId the primary key of the web content article's group 1161 * @param articleId the primary key of the web content article 1162 * @throws PortalException if the web content article with the primary key 1163 could not be found in the Recycle Bin, if the user did not have 1164 permission to restore the article, or if a portal exception 1165 occurred 1166 * @throws SystemException if a system exception occurred 1167 */ 1168 public static void restoreArticleFromTrash(long groupId, 1169 java.lang.String articleId) 1170 throws com.liferay.portal.kernel.exception.PortalException, 1171 com.liferay.portal.kernel.exception.SystemException { 1172 getService().restoreArticleFromTrash(groupId, articleId); 1173 } 1174 1175 public static com.liferay.portal.kernel.search.Hits search(long groupId, 1176 long creatorUserId, int status, int start, int end) 1177 throws com.liferay.portal.kernel.exception.PortalException, 1178 com.liferay.portal.kernel.exception.SystemException { 1179 return getService().search(groupId, creatorUserId, status, start, end); 1180 } 1181 1182 /** 1183 * Returns an ordered range of all the web content articles matching the 1184 * parameters, including a keywords parameter for matching with the 1185 * article's ID, title, description, and content, a DDM structure key 1186 * parameter, and a DDM template key parameter. 1187 * 1188 * <p> 1189 * Useful when paginating results. Returns a maximum of <code>end - 1190 * start</code> instances. <code>start</code> and <code>end</code> are not 1191 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1192 * refers to the first result in the set. Setting both <code>start</code> 1193 * and <code>end</code> to {@link 1194 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1195 * result set. 1196 * </p> 1197 * 1198 * @param companyId the primary key of the web content article's company 1199 * @param groupId the primary key of the group (optionally <code>0</code>) 1200 * @param folderIds the primary keys of the web content article folders 1201 (optionally {@link java.util.Collections#EMPTY_LIST}) 1202 * @param classNameId the primary key of the DDMStructure class if the web 1203 content article is related to a DDM structure, the primary key of 1204 the class name associated with the article, or {@link 1205 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1206 * @param keywords the keywords (space separated), which may occur in the 1207 web content article ID, title, description, or content 1208 (optionally <code>null</code>). If the keywords value is not 1209 <code>null</code>, the search uses the OR operator in connecting 1210 query criteria; otherwise it uses the AND operator. 1211 * @param version the web content article's version (optionally 1212 <code>null</code>) 1213 * @param type the web content article's type (optionally 1214 <code>null</code>) 1215 * @param ddmStructureKey the primary key of the web content article's DDM 1216 structure, if the article is related to a DDM structure, or 1217 <code>null</code> otherwise 1218 * @param ddmTemplateKey the primary key of the web content article's DDM 1219 template (optionally <code>null</code>). If the article is 1220 related to a DDM structure, the template's structure must match 1221 it. 1222 * @param displayDateGT the date after which a matching web content 1223 article's display date must be after (optionally 1224 <code>null</code>) 1225 * @param displayDateLT the date before which a matching web content 1226 article's display date must be before (optionally 1227 <code>null</code>) 1228 * @param status the web content article's workflow status. For more 1229 information see {@link WorkflowConstants} for constants starting 1230 with the "STATUS_" prefix. 1231 * @param reviewDate the web content article's scheduled review date 1232 (optionally <code>null</code>) 1233 * @param start the lower bound of the range of web content articles to 1234 return 1235 * @param end the upper bound of the range of web content articles to 1236 return (not inclusive) 1237 * @param obc the comparator to order the web content articles 1238 * @return the range of matching web content articles ordered by the 1239 comparator 1240 * @throws SystemException if a system exception occurred 1241 */ 1242 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 1243 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 1244 long classNameId, java.lang.String keywords, java.lang.Double version, 1245 java.lang.String type, java.lang.String ddmStructureKey, 1246 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 1247 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 1248 int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) 1249 throws com.liferay.portal.kernel.exception.SystemException { 1250 return getService() 1251 .search(companyId, groupId, folderIds, classNameId, 1252 keywords, version, type, ddmStructureKey, ddmTemplateKey, 1253 displayDateGT, displayDateLT, status, reviewDate, start, end, obc); 1254 } 1255 1256 /** 1257 * Returns an ordered range of all the web content articles matching the 1258 * parameters, including keyword parameters for article ID, title, 1259 * description, and content, a DDM structure key parameter, a DDM template 1260 * key parameter, and an AND operator switch. 1261 * 1262 * <p> 1263 * Useful when paginating results. Returns a maximum of <code>end - 1264 * start</code> instances. <code>start</code> and <code>end</code> are not 1265 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1266 * refers to the first result in the set. Setting both <code>start</code> 1267 * and <code>end</code> to {@link 1268 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1269 * result set. 1270 * </p> 1271 * 1272 * @param companyId the primary key of the web content article's company 1273 * @param groupId the primary key of the group (optionally <code>0</code>) 1274 * @param folderIds the primary keys of the web content article folders 1275 (optionally {@link java.util.Collections#EMPTY_LIST}) 1276 * @param classNameId the primary key of the DDMStructure class if the web 1277 content article is related to a DDM structure, the primary key of 1278 the class name associated with the article, or {@link 1279 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1280 * @param articleId the article ID keywords (space separated, optionally 1281 <code>null</code>) 1282 * @param version the web content article's version (optionally 1283 <code>null</code>) 1284 * @param title the title keywords (space separated, optionally 1285 <code>null</code>) 1286 * @param description the description keywords (space separated, optionally 1287 <code>null</code>) 1288 * @param content the content keywords (space separated, optionally 1289 <code>null</code>) 1290 * @param type the web content article's type (optionally 1291 <code>null</code>) 1292 * @param ddmStructureKey the primary key of the web content article's DDM 1293 structure, if the article is related to a DDM structure, or 1294 <code>null</code> otherwise 1295 * @param ddmTemplateKey the primary key of the web content article's DDM 1296 template (optionally <code>null</code>). If the article is 1297 related to a DDM structure, the template's structure must match 1298 it. 1299 * @param displayDateGT the date after which a matching web content 1300 article's display date must be after (optionally 1301 <code>null</code>) 1302 * @param displayDateLT the date before which a matching web content 1303 article's display date must be before (optionally 1304 <code>null</code>) 1305 * @param status the web content article's workflow status. For more 1306 information see {@link WorkflowConstants} for constants starting 1307 with the "STATUS_" prefix. 1308 * @param reviewDate the web content article's scheduled review date 1309 (optionally <code>null</code>) 1310 * @param andOperator whether every field must match its value or keywords, 1311 or just one field must match. Company, group, folder IDs, class 1312 name ID, and status must all match their values. 1313 * @param start the lower bound of the range of web content articles to 1314 return 1315 * @param end the upper bound of the range of web content articles to 1316 return (not inclusive) 1317 * @param obc the comparator to order the web content articles 1318 * @return the range of matching web content articles ordered by the 1319 comparator 1320 * @throws SystemException if a system exception occurred 1321 */ 1322 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 1323 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 1324 long classNameId, java.lang.String articleId, java.lang.Double version, 1325 java.lang.String title, java.lang.String description, 1326 java.lang.String content, java.lang.String type, 1327 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 1328 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 1329 java.util.Date reviewDate, boolean andOperator, int start, int end, 1330 com.liferay.portal.kernel.util.OrderByComparator obc) 1331 throws com.liferay.portal.kernel.exception.SystemException { 1332 return getService() 1333 .search(companyId, groupId, folderIds, classNameId, 1334 articleId, version, title, description, content, type, 1335 ddmStructureKey, ddmTemplateKey, displayDateGT, displayDateLT, 1336 status, reviewDate, andOperator, start, end, obc); 1337 } 1338 1339 /** 1340 * Returns an ordered range of all the web content articles matching the 1341 * parameters, including keyword parameters for article ID, title, 1342 * description, and content, a DDM structure keys (plural) parameter, a DDM 1343 * template keys (plural) parameter, and an AND operator switch. 1344 * 1345 * <p> 1346 * Useful when paginating results. Returns a maximum of <code>end - 1347 * start</code> instances. <code>start</code> and <code>end</code> are not 1348 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1349 * refers to the first result in the set. Setting both <code>start</code> 1350 * and <code>end</code> to {@link 1351 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full 1352 * result set. 1353 * </p> 1354 * 1355 * @param companyId the primary key of the web content article's company 1356 * @param groupId the primary key of the group (optionally <code>0</code>) 1357 * @param folderIds the primary keys of the web content article folders 1358 (optionally {@link java.util.Collections#EMPTY_LIST}) 1359 * @param classNameId the primary key of the DDMStructure class if the web 1360 content article is related to a DDM structure, the primary key of 1361 the class name associated with the article, or {@link 1362 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1363 * @param articleId the article ID keywords (space separated, optionally 1364 <code>null</code>) 1365 * @param version the web content article's version (optionally 1366 <code>null</code>) 1367 * @param title the title keywords (space separated, optionally 1368 <code>null</code>) 1369 * @param description the description keywords (space separated, optionally 1370 <code>null</code>) 1371 * @param content the content keywords (space separated, optionally 1372 <code>null</code>) 1373 * @param type the web content article's type (optionally 1374 <code>null</code>) 1375 * @param ddmStructureKeys the primary keys of the web content article's 1376 DDM structures, if the article is related to a DDM structure, or 1377 <code>null</code> otherwise 1378 * @param ddmTemplateKeys the primary keys of the web content article's DDM 1379 templates (originally <code>null</code>). If the articles are 1380 related to a DDM structure, the template's structure must match 1381 it. 1382 * @param displayDateGT the date after which a matching web content 1383 article's display date must be after (optionally 1384 <code>null</code>) 1385 * @param displayDateLT the date before which a matching web content 1386 article's display date must be before (optionally 1387 <code>null</code>) 1388 * @param status the web content article's workflow status. For more 1389 information see {@link WorkflowConstants} for constants starting 1390 with the "STATUS_" prefix. 1391 * @param reviewDate the web content article's scheduled review date 1392 (optionally <code>null</code>) 1393 * @param andOperator whether every field must match its value or keywords, 1394 or just one field must match. Company, group, folder IDs, class 1395 name ID, and status must all match their values. 1396 * @param start the lower bound of the range of web content articles to 1397 return 1398 * @param end the upper bound of the range of web content articles to 1399 return (not inclusive) 1400 * @param obc the comparator to order the web content articles 1401 * @return the range of matching web content articles ordered by the 1402 comparator 1403 * @throws SystemException if a system exception occurred 1404 */ 1405 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 1406 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 1407 long classNameId, java.lang.String articleId, java.lang.Double version, 1408 java.lang.String title, java.lang.String description, 1409 java.lang.String content, java.lang.String type, 1410 java.lang.String[] ddmStructureKeys, 1411 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 1412 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 1413 boolean andOperator, int start, int end, 1414 com.liferay.portal.kernel.util.OrderByComparator obc) 1415 throws com.liferay.portal.kernel.exception.SystemException { 1416 return getService() 1417 .search(companyId, groupId, folderIds, classNameId, 1418 articleId, version, title, description, content, type, 1419 ddmStructureKeys, ddmTemplateKeys, displayDateGT, displayDateLT, 1420 status, reviewDate, andOperator, start, end, obc); 1421 } 1422 1423 /** 1424 * Returns the number of web content articles matching the parameters, 1425 * including a keywords parameter for matching with the article's ID, title, 1426 * description, and content, a DDM structure key parameter, and a DDM 1427 * template key parameter. 1428 * 1429 * @param companyId the primary key of the web content article's company 1430 * @param groupId the primary key of the group (optionally <code>0</code>) 1431 * @param folderIds the primary keys of the web content article folders 1432 (optionally {@link java.util.Collections#EMPTY_LIST}) 1433 * @param classNameId the primary key of the DDMStructure class if the web 1434 content article is related to a DDM structure, the primary key of 1435 the class name associated with the article, or {@link 1436 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1437 * @param keywords the keywords (space separated), which may occur in the 1438 web content article ID, title, description, or content 1439 (optionally <code>null</code>). If the keywords value is not 1440 <code>null</code>, the search uses the OR operator in connecting 1441 query criteria; otherwise it uses the AND operator. 1442 * @param version the web content article's version (optionally 1443 <code>null</code>) 1444 * @param type the web content article's type (optionally 1445 <code>null</code>) 1446 * @param ddmStructureKey the primary key of the web content article's DDM 1447 structure, if the article is related to a DDM structure, or 1448 <code>null</code> otherwise 1449 * @param ddmTemplateKey the primary key of the web content article's DDM 1450 template (optionally <code>null</code>). If the article is 1451 related to a DDM structure, the template's structure must match 1452 it. 1453 * @param displayDateGT the date after which a matching web content 1454 article's display date must be after (optionally 1455 <code>null</code>) 1456 * @param displayDateLT the date before which a matching web content 1457 article's display date must be before (optionally 1458 <code>null</code>) 1459 * @param status the web content article's workflow status. For more 1460 information see {@link WorkflowConstants} for constants starting 1461 with the "STATUS_" prefix. 1462 * @param reviewDate the web content article's scheduled review date 1463 (optionally <code>null</code>) 1464 * @return the number of matching web content articles 1465 * @throws SystemException if a system exception occurred 1466 */ 1467 public static int searchCount(long companyId, long groupId, 1468 java.util.List<java.lang.Long> folderIds, long classNameId, 1469 java.lang.String keywords, java.lang.Double version, 1470 java.lang.String type, java.lang.String ddmStructureKey, 1471 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 1472 java.util.Date displayDateLT, int status, java.util.Date reviewDate) 1473 throws com.liferay.portal.kernel.exception.SystemException { 1474 return getService() 1475 .searchCount(companyId, groupId, folderIds, classNameId, 1476 keywords, version, type, ddmStructureKey, ddmTemplateKey, 1477 displayDateGT, displayDateLT, status, reviewDate); 1478 } 1479 1480 /** 1481 * Returns the number of web content articles matching the parameters, 1482 * including keyword parameters for article ID, title, description, and 1483 * content, a DDM structure key parameter, a DDM template key parameter, and 1484 * an AND operator switch. 1485 * 1486 * @param companyId the primary key of the web content article's company 1487 * @param groupId the primary key of the group (optionally <code>0</code>) 1488 * @param folderIds the primary keys of the web content article folders 1489 (optionally {@link java.util.Collections#EMPTY_LIST}) 1490 * @param classNameId the primary key of the DDMStructure class if the web 1491 content article is related to a DDM structure, the primary key of 1492 the class name associated with the article, or {@link 1493 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1494 * @param articleId the article ID keywords (space separated, optionally 1495 <code>null</code>) 1496 * @param version the web content article's version (optionally 1497 <code>null</code>) 1498 * @param title the title keywords (space separated, optionally 1499 <code>null</code>) 1500 * @param description the description keywords (space separated, optionally 1501 <code>null</code>) 1502 * @param content the content keywords (space separated, optionally 1503 <code>null</code>) 1504 * @param type the web content article's type (optionally 1505 <code>null</code>) 1506 * @param ddmStructureKey the primary key of the web content article's DDM 1507 structure, if the article is related to a DDM structure, or 1508 <code>null</code> otherwise 1509 * @param ddmTemplateKey the primary key of the web content article's DDM 1510 template (optionally <code>null</code>). If the article is 1511 related to a DDM structure, the template's structure must match 1512 it. 1513 * @param displayDateGT the date after which a matching web content 1514 article's display date must be after (optionally 1515 <code>null</code>) 1516 * @param displayDateLT the date before which a matching web content 1517 article's display date must be before (optionally 1518 <code>null</code>) 1519 * @param status the web content article's workflow status. For more 1520 information see {@link WorkflowConstants} for constants starting 1521 with the "STATUS_" prefix. 1522 * @param reviewDate the web content article's scheduled review date 1523 (optionally <code>null</code>) 1524 * @param andOperator whether every field must match its value or keywords, 1525 or just one field must match. Group, folder IDs, class name ID, 1526 and status must all match their values. 1527 * @return the number of matching web content articles 1528 * @throws SystemException if a system exception occurred 1529 */ 1530 public static int searchCount(long companyId, long groupId, 1531 java.util.List<java.lang.Long> folderIds, long classNameId, 1532 java.lang.String articleId, java.lang.Double version, 1533 java.lang.String title, java.lang.String description, 1534 java.lang.String content, java.lang.String type, 1535 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 1536 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 1537 java.util.Date reviewDate, boolean andOperator) 1538 throws com.liferay.portal.kernel.exception.SystemException { 1539 return getService() 1540 .searchCount(companyId, groupId, folderIds, classNameId, 1541 articleId, version, title, description, content, type, 1542 ddmStructureKey, ddmTemplateKey, displayDateGT, displayDateLT, 1543 status, reviewDate, andOperator); 1544 } 1545 1546 /** 1547 * Returns the number of web content articles matching the parameters, 1548 * including keyword parameters for article ID, title, description, and 1549 * content, a DDM structure keys (plural) parameter, a DDM template keys 1550 * (plural) parameter, and an AND operator switch. 1551 * 1552 * @param companyId the primary key of the web content article's company 1553 * @param groupId the primary key of the group (optionally <code>0</code>) 1554 * @param folderIds the primary keys of the web content article folders 1555 (optionally {@link java.util.Collections#EMPTY_LIST}) 1556 * @param classNameId the primary key of the DDMStructure class if the web 1557 content article is related to a DDM structure, the primary key of 1558 the class name associated with the article, or {@link 1559 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 1560 * @param articleId the article ID keywords (space separated, optionally 1561 <code>null</code>) 1562 * @param version the web content article's version (optionally 1563 <code>null</code>) 1564 * @param title the title keywords (space separated, optionally 1565 <code>null</code>) 1566 * @param description the description keywords (space separated, optionally 1567 <code>null</code>) 1568 * @param content the content keywords (space separated, optionally 1569 <code>null</code>) 1570 * @param type the web content article's type (optionally 1571 <code>null</code>) 1572 * @param ddmStructureKeys the primary keys of the web content article's 1573 DDM structures, if the article is related to a DDM structure, or 1574 <code>null</code> otherwise 1575 * @param ddmTemplateKeys the primary keys of the web content article's DDM 1576 templates (originally <code>null</code>). If the articles are 1577 related to a DDM structure, the template's structure must match 1578 it. 1579 * @param displayDateGT the date after which a matching web content 1580 article's display date must be after (optionally 1581 <code>null</code>) 1582 * @param displayDateLT the date before which a matching web content 1583 article's display date must be before (optionally 1584 <code>null</code>) 1585 * @param status the web content article's workflow status. For more 1586 information see {@link WorkflowConstants} for constants starting 1587 with the "STATUS_" prefix. 1588 * @param reviewDate the web content article's scheduled review date 1589 (optionally <code>null</code>) 1590 * @param andOperator whether every field must match its value or keywords, 1591 or just one field must match. Group, folder IDs, class name ID, 1592 and status must all match their values. 1593 * @return the number of matching web content articles 1594 * @throws SystemException if a system exception occurred 1595 */ 1596 public static int searchCount(long companyId, long groupId, 1597 java.util.List<java.lang.Long> folderIds, long classNameId, 1598 java.lang.String articleId, java.lang.Double version, 1599 java.lang.String title, java.lang.String description, 1600 java.lang.String content, java.lang.String type, 1601 java.lang.String[] ddmStructureKeys, 1602 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 1603 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 1604 boolean andOperator) 1605 throws com.liferay.portal.kernel.exception.SystemException { 1606 return getService() 1607 .searchCount(companyId, groupId, folderIds, classNameId, 1608 articleId, version, title, description, content, type, 1609 ddmStructureKeys, ddmTemplateKeys, displayDateGT, displayDateLT, 1610 status, reviewDate, andOperator); 1611 } 1612 1613 /** 1614 * Subscribes the user to notifications for the web content article matching 1615 * the group, notifying him the instant versions of the article are created, 1616 * deleted, or modified. 1617 * 1618 * @param groupId the primary key of the group 1619 * @throws PortalException if the user did not have permission to subscribe 1620 to the web content article or if a matching user or group could 1621 not be found 1622 * @throws SystemException if a system exception occurred 1623 */ 1624 public static void subscribe(long groupId) 1625 throws com.liferay.portal.kernel.exception.PortalException, 1626 com.liferay.portal.kernel.exception.SystemException { 1627 getService().subscribe(groupId); 1628 } 1629 1630 /** 1631 * Unsubscribes the user from notifications for the web content article 1632 * matching the group. 1633 * 1634 * @param groupId the primary key of the group 1635 * @throws PortalException if the user did not have permission to subscribe 1636 to the web content article or if a matching user or subscription 1637 could not be found 1638 * @throws SystemException if a system exception occurred 1639 */ 1640 public static void unsubscribe(long groupId) 1641 throws com.liferay.portal.kernel.exception.PortalException, 1642 com.liferay.portal.kernel.exception.SystemException { 1643 getService().unsubscribe(groupId); 1644 } 1645 1646 /** 1647 * Updates the web content article matching the version, replacing its 1648 * folder, title, description, content, and layout UUID. 1649 * 1650 * @param userId the primary key of the user updating the web content 1651 article 1652 * @param groupId the primary key of the web content article's group 1653 * @param folderId the primary key of the web content article folder 1654 * @param articleId the primary key of the web content article 1655 * @param version the web content article's version 1656 * @param titleMap the web content article's locales and localized titles 1657 * @param descriptionMap the web content article's locales and localized 1658 descriptions 1659 * @param content the HTML content wrapped in XML. For more information, 1660 see the content example in the class description for {@link 1661 JournalArticleLocalServiceImpl}. 1662 * @param layoutUuid the unique string identifying the web content 1663 article's display page 1664 * @param serviceContext the service context to be applied. Can set the 1665 modification date, expando bridge attributes, asset category IDs, 1666 asset tag names, asset link entry IDs, workflow actions, the 1667 "defaultLanguageId" and "urlTitle" attributes, and can set 1668 whether to add the default command update for the web content 1669 article. With respect to social activities, by setting the 1670 service context's command to {@link 1671 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 1672 is considered a web content update activity; otherwise it is 1673 considered a web content add activity. 1674 * @return the updated web content article 1675 * @throws PortalException if a user with the primary key or a matching web 1676 content article could not be found, or if a portal exception 1677 occurred 1678 * @throws SystemException if a system exception occurred 1679 */ 1680 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 1681 long userId, long groupId, long folderId, java.lang.String articleId, 1682 double version, 1683 java.util.Map<java.util.Locale, java.lang.String> titleMap, 1684 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1685 java.lang.String content, java.lang.String layoutUuid, 1686 com.liferay.portal.service.ServiceContext serviceContext) 1687 throws com.liferay.portal.kernel.exception.PortalException, 1688 com.liferay.portal.kernel.exception.SystemException { 1689 return getService() 1690 .updateArticle(userId, groupId, folderId, articleId, 1691 version, titleMap, descriptionMap, content, layoutUuid, 1692 serviceContext); 1693 } 1694 1695 /** 1696 * Updates the web content article with additional parameters. 1697 * 1698 * @param groupId the primary key of the web content article's group 1699 * @param folderId the primary key of the web content article folder 1700 * @param articleId the primary key of the web content article 1701 * @param version the web content article's version 1702 * @param titleMap the web content article's locales and localized titles 1703 * @param descriptionMap the web content article's locales and localized 1704 descriptions 1705 * @param content the HTML content wrapped in XML. For more information, 1706 see the content example in the class description for {@link 1707 JournalArticleLocalServiceImpl}. 1708 * @param type the structure's type, if the web content article is related 1709 to a DDM structure. For more information, see {@link 1710 com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. 1711 * @param ddmStructureKey the primary key of the web content article's DDM 1712 structure, if the article is related to a DDM structure, or 1713 <code>null</code> otherwise 1714 * @param ddmTemplateKey the primary key of the web content article's DDM 1715 template (optionally <code>null</code>). If the article is 1716 related to a DDM structure, the template's structure must match 1717 it. 1718 * @param layoutUuid the unique string identifying the web content 1719 article's display page 1720 * @param displayDateMonth the month the web content article is set to 1721 display 1722 * @param displayDateDay the calendar day the web content article is set to 1723 display 1724 * @param displayDateYear the year the web content article is set to 1725 display 1726 * @param displayDateHour the hour the web content article is set to 1727 display 1728 * @param displayDateMinute the minute the web content article is set to 1729 display 1730 * @param expirationDateMonth the month the web content article is set to 1731 expire 1732 * @param expirationDateDay the calendar day the web content article is set 1733 to expire 1734 * @param expirationDateYear the year the web content article is set to 1735 expire 1736 * @param expirationDateHour the hour the web content article is set to 1737 expire 1738 * @param expirationDateMinute the minute the web content article is set to 1739 expire 1740 * @param neverExpire whether the web content article is not set to auto 1741 expire 1742 * @param reviewDateMonth the month the web content article is set for 1743 review 1744 * @param reviewDateDay the calendar day the web content article is set for 1745 review 1746 * @param reviewDateYear the year the web content article is set for review 1747 * @param reviewDateHour the hour the web content article is set for review 1748 * @param reviewDateMinute the minute the web content article is set for 1749 review 1750 * @param neverReview whether the web content article is not set for review 1751 * @param indexable whether the web content is searchable 1752 * @param smallImage whether to update web content article's a small image. 1753 A file must be passed in as <code>smallImageFile</code> value, 1754 otherwise the current small image is deleted. 1755 * @param smallImageURL the web content article's small image URL 1756 (optionally <code>null</code>) 1757 * @param smallFile the web content article's new small image file 1758 (optionally <code>null</code>). Must pass in 1759 <code>smallImage</code> value of <code>true</code> to replace the 1760 article's small image file. 1761 * @param images the web content's images (optionally <code>null</code>) 1762 * @param articleURL the web content article's accessible URL (optionally 1763 <code>null</code>) 1764 * @param serviceContext the service context to be applied. Can set the 1765 modification date, expando bridge attributes, asset category IDs, 1766 asset tag names, asset link entry IDs, workflow actions, the 1767 "defaultLanguageId" and "urlTitle" attributes, and can set 1768 whether to add the default command update for the web content 1769 article. With respect to social activities, by setting the 1770 service context's command to {@link 1771 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 1772 is considered a web content update activity; otherwise it is 1773 considered a web content add activity. 1774 * @return the updated web content article 1775 * @throws PortalException if the user did not have permission to update the 1776 web content article, if a user with the primary key or a matching 1777 web content article could not be found, or if a portal exception 1778 occurred 1779 * @throws SystemException if a system exception occurred 1780 */ 1781 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 1782 long groupId, long folderId, java.lang.String articleId, 1783 double version, 1784 java.util.Map<java.util.Locale, java.lang.String> titleMap, 1785 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 1786 java.lang.String content, java.lang.String type, 1787 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 1788 java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, 1789 int displayDateYear, int displayDateHour, int displayDateMinute, 1790 int expirationDateMonth, int expirationDateDay, int expirationDateYear, 1791 int expirationDateHour, int expirationDateMinute, boolean neverExpire, 1792 int reviewDateMonth, int reviewDateDay, int reviewDateYear, 1793 int reviewDateHour, int reviewDateMinute, boolean neverReview, 1794 boolean indexable, boolean smallImage, java.lang.String smallImageURL, 1795 java.io.File smallFile, java.util.Map<java.lang.String, byte[]> images, 1796 java.lang.String articleURL, 1797 com.liferay.portal.service.ServiceContext serviceContext) 1798 throws com.liferay.portal.kernel.exception.PortalException, 1799 com.liferay.portal.kernel.exception.SystemException { 1800 return getService() 1801 .updateArticle(groupId, folderId, articleId, version, 1802 titleMap, descriptionMap, content, type, ddmStructureKey, 1803 ddmTemplateKey, layoutUuid, displayDateMonth, displayDateDay, 1804 displayDateYear, displayDateHour, displayDateMinute, 1805 expirationDateMonth, expirationDateDay, expirationDateYear, 1806 expirationDateHour, expirationDateMinute, neverExpire, 1807 reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour, 1808 reviewDateMinute, neverReview, indexable, smallImage, 1809 smallImageURL, smallFile, images, articleURL, serviceContext); 1810 } 1811 1812 /** 1813 * Updates the web content article matching the version, replacing its 1814 * folder and content. 1815 * 1816 * @param groupId the primary key of the web content article's group 1817 * @param folderId the primary key of the web content article folder 1818 * @param articleId the primary key of the web content article 1819 * @param version the web content article's version 1820 * @param content the HTML content wrapped in XML. For more information, 1821 see the content example in the class description for {@link 1822 JournalArticleLocalServiceImpl}. 1823 * @param serviceContext the service context to be applied. Can set the 1824 modification date, expando bridge attributes, asset category IDs, 1825 asset tag names, asset link entry IDs, workflow actions, the 1826 "defaultLanguageId" and "urlTitle" attributes, and can set 1827 whether to add the default command update for the web content 1828 article. With respect to social activities, by setting the 1829 service context's command to {@link 1830 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 1831 is considered a web content update activity; otherwise it is 1832 considered a web content add activity. 1833 * @return the updated web content article 1834 * @throws PortalException if the user did not have permission to update the 1835 web content article, if a user with the primary key or a matching 1836 web content article could not be found, or if a portal exception 1837 occurred 1838 * @throws SystemException if a system exception occurred 1839 */ 1840 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 1841 long groupId, long folderId, java.lang.String articleId, 1842 double version, java.lang.String content, 1843 com.liferay.portal.service.ServiceContext serviceContext) 1844 throws com.liferay.portal.kernel.exception.PortalException, 1845 com.liferay.portal.kernel.exception.SystemException { 1846 return getService() 1847 .updateArticle(groupId, folderId, articleId, version, 1848 content, serviceContext); 1849 } 1850 1851 /** 1852 * @deprecated As of 6.2.0, replaced by {@link 1853 #updateArticleTranslation(long, String, double, Locale, 1854 String, String, String, Map, ServiceContext)} 1855 */ 1856 public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 1857 long groupId, java.lang.String articleId, double version, 1858 java.util.Locale locale, java.lang.String title, 1859 java.lang.String description, java.lang.String content, 1860 java.util.Map<java.lang.String, byte[]> images) 1861 throws com.liferay.portal.kernel.exception.PortalException, 1862 com.liferay.portal.kernel.exception.SystemException { 1863 return getService() 1864 .updateArticleTranslation(groupId, articleId, version, 1865 locale, title, description, content, images); 1866 } 1867 1868 /** 1869 * Updates the translation of the web content article. 1870 * 1871 * @param groupId the primary key of the web content article's group 1872 * @param articleId the primary key of the web content article 1873 * @param version the web content article's version 1874 * @param locale the locale of the web content article's display template 1875 * @param title the translated web content article title 1876 * @param description the translated web content article description 1877 * @param content the HTML content wrapped in XML. For more information, 1878 see the content example in the class description for {@link 1879 JournalArticleLocalServiceImpl}. 1880 * @param images the web content's images 1881 * @param serviceContext the service context to be applied. Can set the 1882 modification date and "urlTitle" attribute for the web content 1883 article. 1884 * @return the updated web content article 1885 * @throws PortalException if the user did not have permission to update the 1886 web content article, if a user with the primary key or a matching 1887 web content article could not be found, or if a portal exception 1888 occurred 1889 * @throws SystemException if a system exception occurred 1890 */ 1891 public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 1892 long groupId, java.lang.String articleId, double version, 1893 java.util.Locale locale, java.lang.String title, 1894 java.lang.String description, java.lang.String content, 1895 java.util.Map<java.lang.String, byte[]> images, 1896 com.liferay.portal.service.ServiceContext serviceContext) 1897 throws com.liferay.portal.kernel.exception.PortalException, 1898 com.liferay.portal.kernel.exception.SystemException { 1899 return getService() 1900 .updateArticleTranslation(groupId, articleId, version, 1901 locale, title, description, content, images, serviceContext); 1902 } 1903 1904 /** 1905 * Updates the web content article matching the group, article ID, and 1906 * version, replacing its content. 1907 * 1908 * @param groupId the primary key of the web content article's group 1909 * @param articleId the primary key of the web content article 1910 * @param version the web content article's version 1911 * @param content the HTML content wrapped in XML. For more information, 1912 see the content example in the class description for {@link 1913 JournalArticleLocalServiceImpl}. 1914 * @return the updated web content article 1915 * @throws PortalException if the user did not have permission to update the 1916 web content article or if a matching web content article could 1917 not be found 1918 * @throws SystemException if a system exception occurred 1919 */ 1920 public static com.liferay.portlet.journal.model.JournalArticle updateContent( 1921 long groupId, java.lang.String articleId, double version, 1922 java.lang.String content) 1923 throws com.liferay.portal.kernel.exception.PortalException, 1924 com.liferay.portal.kernel.exception.SystemException { 1925 return getService().updateContent(groupId, articleId, version, content); 1926 } 1927 1928 /** 1929 * Updates the workflow status of the web content article matching the 1930 * group, article ID, and version. 1931 * 1932 * @param groupId the primary key of the web content article's group 1933 * @param articleId the primary key of the web content article 1934 * @param version the web content article's version 1935 * @param status the web content article's workflow status. For more 1936 information see {@link WorkflowConstants} for constants starting 1937 with the "STATUS_" prefix. 1938 * @param articleURL the web content article's accessible URL 1939 * @param serviceContext the service context to be applied. Can set the 1940 modification date, portlet preferences, and can set whether to 1941 add the default command update for the web content article. 1942 * @return the updated web content article 1943 * @throws PortalException if the user did not have permission to update the 1944 web content article, if a matching web content article could not 1945 be found, or if a portal exception occurred 1946 * @throws SystemException if a system exception occurred 1947 */ 1948 public static com.liferay.portlet.journal.model.JournalArticle updateStatus( 1949 long groupId, java.lang.String articleId, double version, int status, 1950 java.lang.String articleURL, 1951 com.liferay.portal.service.ServiceContext serviceContext) 1952 throws com.liferay.portal.kernel.exception.PortalException, 1953 com.liferay.portal.kernel.exception.SystemException { 1954 return getService() 1955 .updateStatus(groupId, articleId, version, status, 1956 articleURL, serviceContext); 1957 } 1958 1959 public static JournalArticleService getService() { 1960 if (_service == null) { 1961 _service = (JournalArticleService)PortalBeanLocatorUtil.locate(JournalArticleService.class.getName()); 1962 1963 ReferenceRegistry.registerReference(JournalArticleServiceUtil.class, 1964 "_service"); 1965 } 1966 1967 return _service; 1968 } 1969 1970 /** 1971 * @deprecated As of 6.2.0 1972 */ 1973 public void setService(JournalArticleService service) { 1974 } 1975 1976 private static JournalArticleService _service; 1977 }