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