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