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