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