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