001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.journal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the local service utility for JournalArticle. This utility wraps 024 * {@link com.liferay.portlet.journal.service.impl.JournalArticleLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see JournalArticleLocalService 032 * @see com.liferay.portlet.journal.service.base.JournalArticleLocalServiceBaseImpl 033 * @see com.liferay.portlet.journal.service.impl.JournalArticleLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class JournalArticleLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds a web content article with additional parameters. 046 * 047 * @param userId the primary key of the web content article's creator/owner 048 * @param groupId the primary key of the web content article's group 049 * @param folderId the primary key of the web content article folder 050 * @param classNameId the primary key of the DDMStructure class if the web 051 content article is related to a DDM structure, the primary key of 052 the class name associated with the article, or {@link 053 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 054 * @param classPK the primary key of the DDM structure, if the primary key 055 of the DDMStructure class is given as the 056 <code>classNameId</code> parameter, the primary key of the class 057 associated with the web content article, or <code>0</code> 058 otherwise 059 * @param articleId the primary key of the web content article 060 * @param autoArticleId whether to auto generate the web content article ID 061 * @param version the web content article's version 062 * @param titleMap the web content article's locales and localized titles 063 * @param descriptionMap the web content article's locales and localized 064 descriptions 065 * @param content the HTML content wrapped in XML. For more information, 066 see the content example in the class description for {@link 067 JournalArticleLocalServiceImpl}. 068 * @param ddmStructureKey the primary key of the web content article's DDM 069 structure, if the article is related to a DDM structure, or 070 <code>null</code> otherwise 071 * @param ddmTemplateKey the primary key of the web content article's DDM 072 template 073 * @param layoutUuid the unique string identifying the web content 074 article's display page 075 * @param displayDateMonth the month the web content article is set to 076 display 077 * @param displayDateDay the calendar day the web content article is set to 078 display 079 * @param displayDateYear the year the web content article is set to 080 display 081 * @param displayDateHour the hour the web content article is set to 082 display 083 * @param displayDateMinute the minute the web content article is set to 084 display 085 * @param expirationDateMonth the month the web content article is set to 086 expire 087 * @param expirationDateDay the calendar day the web content article is set 088 to expire 089 * @param expirationDateYear the year the web content article is set to 090 expire 091 * @param expirationDateHour the hour the web content article is set to 092 expire 093 * @param expirationDateMinute the minute the web content article is set to 094 expire 095 * @param neverExpire whether the web content article is not set to auto 096 expire 097 * @param reviewDateMonth the month the web content article is set for 098 review 099 * @param reviewDateDay the calendar day the web content article is set for 100 review 101 * @param reviewDateYear the year the web content article is set for review 102 * @param reviewDateHour the hour the web content article is set for review 103 * @param reviewDateMinute the minute the web content article is set for 104 review 105 * @param neverReview whether the web content article is not set for review 106 * @param indexable whether the web content article is searchable 107 * @param smallImage whether the web content article has a small image 108 * @param smallImageURL the web content article's small image URL 109 * @param smallImageFile the web content article's small image file 110 * @param images the web content's images 111 * @param articleURL the web content article's accessible URL 112 * @param serviceContext the service context to be applied. Can set the 113 UUID, creation date, modification date, expando bridge 114 attributes, guest permissions, group permissions, asset category 115 IDs, asset tag names, asset link entry IDs, the "urlTitle" 116 attribute, and workflow actions for the web content article. Can 117 also set whether to add the default guest and group permissions. 118 * @return the web content article 119 * @throws PortalException if a portal exception occurred 120 */ 121 public static com.liferay.portlet.journal.model.JournalArticle addArticle( 122 long userId, long groupId, long folderId, long classNameId, 123 long classPK, java.lang.String articleId, boolean autoArticleId, 124 double version, 125 java.util.Map<java.util.Locale, java.lang.String> titleMap, 126 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 127 java.lang.String content, java.lang.String ddmStructureKey, 128 java.lang.String ddmTemplateKey, java.lang.String layoutUuid, 129 int displayDateMonth, int displayDateDay, int displayDateYear, 130 int displayDateHour, int displayDateMinute, int expirationDateMonth, 131 int expirationDateDay, int expirationDateYear, int expirationDateHour, 132 int expirationDateMinute, boolean neverExpire, int reviewDateMonth, 133 int reviewDateDay, int reviewDateYear, int reviewDateHour, 134 int reviewDateMinute, boolean neverReview, boolean indexable, 135 boolean smallImage, java.lang.String smallImageURL, 136 java.io.File smallImageFile, 137 java.util.Map<java.lang.String, byte[]> images, 138 java.lang.String articleURL, 139 com.liferay.portal.service.ServiceContext serviceContext) 140 throws com.liferay.portal.kernel.exception.PortalException { 141 return getService() 142 .addArticle(userId, groupId, folderId, classNameId, classPK, 143 articleId, autoArticleId, version, titleMap, descriptionMap, 144 content, ddmStructureKey, ddmTemplateKey, layoutUuid, 145 displayDateMonth, displayDateDay, displayDateYear, displayDateHour, 146 displayDateMinute, expirationDateMonth, expirationDateDay, 147 expirationDateYear, expirationDateHour, expirationDateMinute, 148 neverExpire, reviewDateMonth, reviewDateDay, reviewDateYear, 149 reviewDateHour, reviewDateMinute, neverReview, indexable, 150 smallImage, smallImageURL, smallImageFile, images, articleURL, 151 serviceContext); 152 } 153 154 /** 155 * Adds a web content article. 156 * 157 * @param userId the primary key of the web content article's creator/owner 158 * @param groupId the primary key of the web content article's group 159 * @param folderId the primary key of the web content article folder 160 * @param titleMap the web content article's locales and localized titles 161 * @param descriptionMap the web content article's locales and localized 162 descriptions 163 * @param content the HTML content wrapped in XML. For more information, 164 see the content example in the class description for {@link 165 JournalArticleLocalServiceImpl}. 166 * @param ddmStructureKey the primary key of the web content article's DDM 167 structure, if the article is related to a DDM structure, or 168 <code>null</code> otherwise 169 * @param ddmTemplateKey the primary key of the web content article's DDM 170 template 171 * @param serviceContext the service context to be applied. Can set the 172 UUID, creation date, modification date, expando bridge 173 attributes, guest permissions, group permissions, asset category 174 IDs, asset tag names, asset link entry IDs, the "urlTitle" 175 attribute, and workflow actions for the web content article. Can 176 also set whether to add the default guest and group permissions. 177 * @return the web content article 178 * @throws PortalException if a portal exception occurred 179 */ 180 public static com.liferay.portlet.journal.model.JournalArticle addArticle( 181 long userId, long groupId, long folderId, 182 java.util.Map<java.util.Locale, java.lang.String> titleMap, 183 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 184 java.lang.String content, java.lang.String ddmStructureKey, 185 java.lang.String ddmTemplateKey, 186 com.liferay.portal.service.ServiceContext serviceContext) 187 throws com.liferay.portal.kernel.exception.PortalException { 188 return getService() 189 .addArticle(userId, groupId, folderId, titleMap, 190 descriptionMap, content, ddmStructureKey, ddmTemplateKey, 191 serviceContext); 192 } 193 194 /** 195 * Adds the resources to the web content article. 196 * 197 * @param article the web content article 198 * @param addGroupPermissions whether to add group permissions 199 * @param addGuestPermissions whether to add guest permissions 200 * @throws PortalException if no portal actions could be found associated 201 with the web content article or if a portal exception occurred 202 */ 203 public static void addArticleResources( 204 com.liferay.portlet.journal.model.JournalArticle article, 205 boolean addGroupPermissions, boolean addGuestPermissions) 206 throws com.liferay.portal.kernel.exception.PortalException { 207 getService() 208 .addArticleResources(article, addGroupPermissions, 209 addGuestPermissions); 210 } 211 212 /** 213 * Adds the model resources with the permissions to the web content article. 214 * 215 * @param article the web content article to add resources to 216 * @param groupPermissions the group permissions to be added 217 * @param guestPermissions the guest permissions to be added 218 * @throws PortalException if a portal exception occurred 219 */ 220 public static void addArticleResources( 221 com.liferay.portlet.journal.model.JournalArticle article, 222 java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) 223 throws com.liferay.portal.kernel.exception.PortalException { 224 getService() 225 .addArticleResources(article, groupPermissions, guestPermissions); 226 } 227 228 /** 229 * Adds the resources to the most recently created web content article. 230 * 231 * @param groupId the primary key of the web content article's group 232 * @param articleId the primary key of the web content article 233 * @param addGroupPermissions whether to add group permissions 234 * @param addGuestPermissions whether to add guest permissions 235 * @throws PortalException if a portal exception occurred 236 */ 237 public static void addArticleResources(long groupId, 238 java.lang.String articleId, boolean addGroupPermissions, 239 boolean addGuestPermissions) 240 throws com.liferay.portal.kernel.exception.PortalException { 241 getService() 242 .addArticleResources(groupId, articleId, addGroupPermissions, 243 addGuestPermissions); 244 } 245 246 /** 247 * Adds the resources with the permissions to the most recently created web 248 * content article. 249 * 250 * @param groupId the primary key of the web content article's group 251 * @param articleId the primary key of the web content article 252 * @param groupPermissions the group permissions to be added 253 * @param guestPermissions the guest permissions to be added 254 * @throws PortalException if a portal exception occurred 255 */ 256 public static void addArticleResources(long groupId, 257 java.lang.String articleId, java.lang.String[] groupPermissions, 258 java.lang.String[] guestPermissions) 259 throws com.liferay.portal.kernel.exception.PortalException { 260 getService() 261 .addArticleResources(groupId, articleId, groupPermissions, 262 guestPermissions); 263 } 264 265 /** 266 * Adds the journal article to the database. Also notifies the appropriate model listeners. 267 * 268 * @param journalArticle the journal article 269 * @return the journal article that was added 270 */ 271 public static com.liferay.portlet.journal.model.JournalArticle addJournalArticle( 272 com.liferay.portlet.journal.model.JournalArticle journalArticle) { 273 return getService().addJournalArticle(journalArticle); 274 } 275 276 /** 277 * Returns the web content article with the group, article ID, and version. 278 * This method checks for the article's resource primary key and, if not 279 * found, creates a new one. 280 * 281 * @param groupId the primary key of the web content article's group 282 * @param articleId the primary key of the web content article 283 * @param version the web content article's version 284 * @return the matching web content article 285 * @throws PortalException if a matching web content article could not be 286 found 287 */ 288 public static com.liferay.portlet.journal.model.JournalArticle checkArticleResourcePrimKey( 289 long groupId, java.lang.String articleId, double version) 290 throws com.liferay.portal.kernel.exception.PortalException { 291 return getService() 292 .checkArticleResourcePrimKey(groupId, articleId, version); 293 } 294 295 /** 296 * Checks all web content articles by handling their expirations and sending 297 * review notifications based on their current workflow. 298 * 299 * @throws PortalException if a portal exception occurred 300 */ 301 public static void checkArticles() 302 throws com.liferay.portal.kernel.exception.PortalException { 303 getService().checkArticles(); 304 } 305 306 /** 307 * Checks the web content article matching the group, article ID, and 308 * version, replacing escaped newline and return characters with non-escaped 309 * newline and return characters. 310 * 311 * @param groupId the primary key of the web content article's group 312 * @param articleId the primary key of the web content article 313 * @param version the web content article's version 314 * @throws PortalException if a matching web content article could not be 315 found 316 */ 317 public static void checkNewLine(long groupId, java.lang.String articleId, 318 double version) 319 throws com.liferay.portal.kernel.exception.PortalException { 320 getService().checkNewLine(groupId, articleId, version); 321 } 322 323 /** 324 * Checks the web content article matching the group, article ID, and 325 * version for an associated structure. If no structure is associated, 326 * return; otherwise check that the article and structure match. 327 * 328 * @param groupId the primary key of the web content article's group 329 * @param articleId the primary key of the web content article 330 * @param version the web content article's version 331 * @throws PortalException if a matching web content article could not be 332 found, if the article's structure does not match it, or if a 333 portal exception occurred 334 */ 335 public static void checkStructure(long groupId, java.lang.String articleId, 336 double version) 337 throws com.liferay.portal.kernel.exception.PortalException { 338 getService().checkStructure(groupId, articleId, version); 339 } 340 341 /** 342 * Copies the web content article matching the group, article ID, and 343 * version. This method creates a new article, extracting all the values 344 * from the old one and updating its article ID. 345 * 346 * @param userId the primary key of the web content article's creator/owner 347 * @param groupId the primary key of the web content article's group 348 * @param oldArticleId the primary key of the old web content article 349 * @param newArticleId the primary key of the new web content article 350 * @param autoArticleId whether to auto-generate the web content article ID 351 * @param version the web content article's version 352 * @return the new web content article 353 * @throws PortalException if a matching web content article could not be 354 found or if a portal exception occurred 355 */ 356 public static com.liferay.portlet.journal.model.JournalArticle copyArticle( 357 long userId, long groupId, java.lang.String oldArticleId, 358 java.lang.String newArticleId, boolean autoArticleId, double version) 359 throws com.liferay.portal.kernel.exception.PortalException { 360 return getService() 361 .copyArticle(userId, groupId, oldArticleId, newArticleId, 362 autoArticleId, version); 363 } 364 365 /** 366 * Creates a new journal article with the primary key. Does not add the journal article to the database. 367 * 368 * @param id the primary key for the new journal article 369 * @return the new journal article 370 */ 371 public static com.liferay.portlet.journal.model.JournalArticle createJournalArticle( 372 long id) { 373 return getService().createJournalArticle(id); 374 } 375 376 /** 377 * Deletes the web content article and its resources. 378 * 379 * @param article the web content article 380 * @return the deleted web content article 381 * @throws PortalException if a portal exception occurred 382 */ 383 public static com.liferay.portlet.journal.model.JournalArticle deleteArticle( 384 com.liferay.portlet.journal.model.JournalArticle article) 385 throws com.liferay.portal.kernel.exception.PortalException { 386 return getService().deleteArticle(article); 387 } 388 389 /** 390 * Deletes the web content article and its resources, optionally sending 391 * email notifying denial of the article if it had not yet been approved. 392 * 393 * @param article the web content article 394 * @param articleURL the web content article's accessible URL to include in 395 email notifications (optionally <code>null</code>) 396 * @param serviceContext the service context to be applied (optionally 397 <code>null</code>). Can set the portlet preferences that include 398 email information to notify recipients of the unapproved web 399 content's denial. 400 * @return the deleted web content article 401 * @throws PortalException if a portal exception occurred 402 */ 403 public static com.liferay.portlet.journal.model.JournalArticle deleteArticle( 404 com.liferay.portlet.journal.model.JournalArticle article, 405 java.lang.String articleURL, 406 com.liferay.portal.service.ServiceContext serviceContext) 407 throws com.liferay.portal.kernel.exception.PortalException { 408 return getService().deleteArticle(article, articleURL, serviceContext); 409 } 410 411 /** 412 * Deletes all web content articles and their resources matching the group 413 * and article ID, optionally sending email notifying denial of article if 414 * it had not yet been approved. 415 * 416 * @param groupId the primary key of the web content article's group 417 * @param articleId the primary key of the web content article 418 * @param serviceContext the service context to be applied. Can set the 419 portlet preferences that include email information to notify 420 recipients of the unapproved web content article's denial. 421 * @throws PortalException if a portal exception occurred 422 */ 423 public static void deleteArticle(long groupId, java.lang.String articleId, 424 com.liferay.portal.service.ServiceContext serviceContext) 425 throws com.liferay.portal.kernel.exception.PortalException { 426 getService().deleteArticle(groupId, articleId, serviceContext); 427 } 428 429 /** 430 * Deletes the web content article and its resources matching the group, 431 * article ID, and version, optionally sending email notifying denial of the 432 * web content article if it had not yet been approved. 433 * 434 * @param groupId the primary key of the web content article's group 435 * @param articleId the primary key of the web content article 436 * @param version the web content article's version 437 * @param articleURL the web content article's accessible URL 438 * @param serviceContext the service context to be applied. Can set the 439 portlet preferences that include email information to notify 440 recipients of the unapproved web content article's denial. 441 * @return the deleted web content article 442 * @throws PortalException if a matching web content article could not be 443 found or if a portal exception occurred 444 */ 445 public static com.liferay.portlet.journal.model.JournalArticle deleteArticle( 446 long groupId, java.lang.String articleId, double version, 447 java.lang.String articleURL, 448 com.liferay.portal.service.ServiceContext serviceContext) 449 throws com.liferay.portal.kernel.exception.PortalException { 450 return getService() 451 .deleteArticle(groupId, articleId, version, articleURL, 452 serviceContext); 453 } 454 455 /** 456 * Deletes all the group's web content articles and resources. 457 * 458 * @param groupId the primary key of the web content article's group 459 * @throws PortalException if a portal exception occurred 460 */ 461 public static void deleteArticles(long groupId) 462 throws com.liferay.portal.kernel.exception.PortalException { 463 getService().deleteArticles(groupId); 464 } 465 466 /** 467 * Deletes all the group's web content articles and resources in the folder, 468 * including recycled articles. 469 * 470 * @param groupId the primary key of the web content article's group 471 * @param folderId the primary key of the web content article folder 472 * @throws PortalException if a portal exception occurred 473 */ 474 public static void deleteArticles(long groupId, long folderId) 475 throws com.liferay.portal.kernel.exception.PortalException { 476 getService().deleteArticles(groupId, folderId); 477 } 478 479 /** 480 * Deletes all the group's web content articles and resources in the folder, 481 * optionally including recycled articles. 482 * 483 * @param groupId the primary key of the web content article's group 484 * @param folderId the primary key of the web content article folder 485 * @param includeTrashedEntries whether to include recycled web content 486 articles 487 * @throws PortalException if a portal exception occurred 488 */ 489 public static void deleteArticles(long groupId, long folderId, 490 boolean includeTrashedEntries) 491 throws com.liferay.portal.kernel.exception.PortalException { 492 getService().deleteArticles(groupId, folderId, includeTrashedEntries); 493 } 494 495 /** 496 * Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners. 497 * 498 * @param id the primary key of the journal article 499 * @return the journal article that was removed 500 * @throws PortalException if a journal article with the primary key could not be found 501 */ 502 public static com.liferay.portlet.journal.model.JournalArticle deleteJournalArticle( 503 long id) throws com.liferay.portal.kernel.exception.PortalException { 504 return getService().deleteJournalArticle(id); 505 } 506 507 /** 508 * Deletes the journal article from the database. Also notifies the appropriate model listeners. 509 * 510 * @param journalArticle the journal article 511 * @return the journal article that was removed 512 */ 513 public static com.liferay.portlet.journal.model.JournalArticle deleteJournalArticle( 514 com.liferay.portlet.journal.model.JournalArticle journalArticle) { 515 return getService().deleteJournalArticle(journalArticle); 516 } 517 518 /** 519 * Deletes the layout's association with the web content articles for the 520 * group. 521 * 522 * @param groupId the primary key of the web content article's group 523 * @param layoutUuid the unique string identifying the web content article's 524 display page 525 */ 526 public static void deleteLayoutArticleReferences(long groupId, 527 java.lang.String layoutUuid) { 528 getService().deleteLayoutArticleReferences(groupId, layoutUuid); 529 } 530 531 /** 532 * @throws PortalException 533 */ 534 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 535 com.liferay.portal.model.PersistedModel persistedModel) 536 throws com.liferay.portal.kernel.exception.PortalException { 537 return getService().deletePersistedModel(persistedModel); 538 } 539 540 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 541 return getService().dynamicQuery(); 542 } 543 544 /** 545 * Performs a dynamic query on the database and returns the matching rows. 546 * 547 * @param dynamicQuery the dynamic query 548 * @return the matching rows 549 */ 550 public static <T> java.util.List<T> dynamicQuery( 551 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 552 return getService().dynamicQuery(dynamicQuery); 553 } 554 555 /** 556 * Performs a dynamic query on the database and returns a range of the matching rows. 557 * 558 * <p> 559 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 560 * </p> 561 * 562 * @param dynamicQuery the dynamic query 563 * @param start the lower bound of the range of model instances 564 * @param end the upper bound of the range of model instances (not inclusive) 565 * @return the range of matching rows 566 */ 567 public static <T> java.util.List<T> dynamicQuery( 568 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 569 int end) { 570 return getService().dynamicQuery(dynamicQuery, start, end); 571 } 572 573 /** 574 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 575 * 576 * <p> 577 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 578 * </p> 579 * 580 * @param dynamicQuery the dynamic query 581 * @param start the lower bound of the range of model instances 582 * @param end the upper bound of the range of model instances (not inclusive) 583 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 584 * @return the ordered range of matching rows 585 */ 586 public static <T> java.util.List<T> dynamicQuery( 587 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 588 int end, 589 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { 590 return getService() 591 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 592 } 593 594 /** 595 * Returns the number of rows matching the dynamic query. 596 * 597 * @param dynamicQuery the dynamic query 598 * @return the number of rows matching the dynamic query 599 */ 600 public static long dynamicQueryCount( 601 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 602 return getService().dynamicQueryCount(dynamicQuery); 603 } 604 605 /** 606 * Returns the number of rows matching the dynamic query. 607 * 608 * @param dynamicQuery the dynamic query 609 * @param projection the projection to apply to the query 610 * @return the number of rows matching the dynamic query 611 */ 612 public static long dynamicQueryCount( 613 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 614 com.liferay.portal.kernel.dao.orm.Projection projection) { 615 return getService().dynamicQueryCount(dynamicQuery, projection); 616 } 617 618 /** 619 * Expires the web content article matching the group and article ID, 620 * expiring all of its versions if the 621 * <code>journal.article.expire.all.versions</code> portal property is 622 * <code>true</code>, otherwise expiring only its latest approved version. 623 * 624 * @param userId the primary key of the user updating the web content 625 article 626 * @param groupId the primary key of the web content article's group 627 * @param articleId the primary key of the web content article 628 * @param articleURL the web content article's accessible URL 629 * @param serviceContext the service context to be applied. Can set the 630 modification date, status date, portlet preferences, and can set 631 whether to add the default command update for the web content 632 article. With respect to social activities, by setting the 633 service context's command to {@link 634 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 635 is considered a web content update activity; otherwise it is 636 considered a web content add activity. 637 * @throws PortalException if a matching web content article could not be 638 found or if a portal exception occurred 639 */ 640 public static void expireArticle(long userId, long groupId, 641 java.lang.String articleId, java.lang.String articleURL, 642 com.liferay.portal.service.ServiceContext serviceContext) 643 throws com.liferay.portal.kernel.exception.PortalException { 644 getService() 645 .expireArticle(userId, groupId, articleId, articleURL, 646 serviceContext); 647 } 648 649 /** 650 * Expires the web content article matching the group, article ID, and 651 * version. 652 * 653 * @param userId the primary key of the user updating the web content 654 article 655 * @param groupId the primary key of the web content article's group 656 * @param articleId the primary key of the web content article 657 * @param version the web content article's version 658 * @param articleURL the web content article's accessible URL 659 * @param serviceContext the service context to be applied. Can set the 660 modification date, status date, portlet preferences, and can set 661 whether to add the default command update for the web content 662 article. With respect to social activities, by setting the 663 service context's command to {@link 664 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 665 is considered a web content update activity; otherwise it is 666 considered a web content add activity. 667 * @return the web content article 668 * @throws PortalException if a matching web content article could not be 669 found or if a portal exception occurred 670 */ 671 public static com.liferay.portlet.journal.model.JournalArticle expireArticle( 672 long userId, long groupId, java.lang.String articleId, double version, 673 java.lang.String articleURL, 674 com.liferay.portal.service.ServiceContext serviceContext) 675 throws com.liferay.portal.kernel.exception.PortalException { 676 return getService() 677 .expireArticle(userId, groupId, articleId, version, 678 articleURL, serviceContext); 679 } 680 681 /** 682 * Returns the web content article matching the group, article ID, and 683 * version. 684 * 685 * @param groupId the primary key of the web content article's group 686 * @param articleId the primary key of the web content article 687 * @param version the web content article's version 688 * @return the web content article matching the group, article ID, and 689 version, or <code>null</code> if no web content article could be 690 found 691 */ 692 public static com.liferay.portlet.journal.model.JournalArticle fetchArticle( 693 long groupId, java.lang.String articleId, double version) { 694 return getService().fetchArticle(groupId, articleId, version); 695 } 696 697 public static com.liferay.portlet.journal.model.JournalArticle fetchJournalArticle( 698 long id) { 699 return getService().fetchJournalArticle(id); 700 } 701 702 /** 703 * Returns the journal article matching the UUID and group. 704 * 705 * @param uuid the journal article's UUID 706 * @param groupId the primary key of the group 707 * @return the matching journal article, or <code>null</code> if a matching journal article could not be found 708 */ 709 public static com.liferay.portlet.journal.model.JournalArticle fetchJournalArticleByUuidAndGroupId( 710 java.lang.String uuid, long groupId) { 711 return getService().fetchJournalArticleByUuidAndGroupId(uuid, groupId); 712 } 713 714 /** 715 * Returns the latest web content article matching the group, article ID, 716 * and workflow status. 717 * 718 * @param groupId the primary key of the web content article's group 719 * @param articleId the primary key of the web content article 720 * @param status the web content article's workflow status. For more 721 information see {@link WorkflowConstants} for constants starting 722 with the "STATUS_" prefix. 723 * @return the latest matching web content article, or <code>null</code> if 724 no matching web content article could be found 725 */ 726 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestArticle( 727 long groupId, java.lang.String articleId, int status) { 728 return getService().fetchLatestArticle(groupId, articleId, status); 729 } 730 731 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestArticle( 732 long resourcePrimKey) { 733 return getService().fetchLatestArticle(resourcePrimKey); 734 } 735 736 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestArticle( 737 long resourcePrimKey, int status) { 738 return getService().fetchLatestArticle(resourcePrimKey, status); 739 } 740 741 /** 742 * Returns the latest web content article matching the resource primary key 743 * and workflow status, optionally preferring articles with approved 744 * workflow status. 745 * 746 * @param resourcePrimKey the primary key of the resource instance 747 * @param status the web content article's workflow status. For more 748 information see {@link WorkflowConstants} for constants starting 749 with the "STATUS_" prefix. 750 * @param preferApproved whether to prefer returning the latest matching 751 article that has workflow status {@link 752 WorkflowConstants#STATUS_APPROVED} over returning one that has a 753 different status 754 * @return the latest web content article matching the resource primary key 755 and workflow status, optionally preferring articles with an 756 approved workflow status, or <code>null</code> if no matching web 757 content article could be found 758 */ 759 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestArticle( 760 long resourcePrimKey, int status, boolean preferApproved) { 761 return getService() 762 .fetchLatestArticle(resourcePrimKey, status, preferApproved); 763 } 764 765 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestArticle( 766 long resourcePrimKey, int[] statuses) { 767 return getService().fetchLatestArticle(resourcePrimKey, statuses); 768 } 769 770 /** 771 * Returns the latest indexable web content article matching the resource 772 * primary key. 773 * 774 * @param resourcePrimKey the primary key of the resource instance 775 * @return the latest indexable web content article matching the resource 776 primary key, or <code>null</code> if no matching web content 777 article could be found 778 */ 779 public static com.liferay.portlet.journal.model.JournalArticle fetchLatestIndexableArticle( 780 long resourcePrimKey) { 781 return getService().fetchLatestIndexableArticle(resourcePrimKey); 782 } 783 784 public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { 785 return getService().getActionableDynamicQuery(); 786 } 787 788 /** 789 * Returns the latest approved web content article, or the latest unapproved 790 * article if none are approved. Both approved and unapproved articles must 791 * match the group and article ID. 792 * 793 * @param groupId the primary key of the web content article's group 794 * @param articleId the primary key of the web content article 795 * @return the matching web content article 796 * @throws PortalException if a matching web content article could not be 797 found 798 */ 799 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 800 long groupId, java.lang.String articleId) 801 throws com.liferay.portal.kernel.exception.PortalException { 802 return getService().getArticle(groupId, articleId); 803 } 804 805 /** 806 * Returns the web content article matching the group, article ID, and 807 * version. 808 * 809 * @param groupId the primary key of the web content article's group 810 * @param articleId the primary key of the web content article 811 * @param version the web content article's version 812 * @return the matching web content article 813 * @throws PortalException if a matching web content article could not be 814 found 815 */ 816 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 817 long groupId, java.lang.String articleId, double version) 818 throws com.liferay.portal.kernel.exception.PortalException { 819 return getService().getArticle(groupId, articleId, version); 820 } 821 822 /** 823 * Returns the web content article matching the group, class name, and class 824 * PK. 825 * 826 * @param groupId the primary key of the web content article's group 827 * @param className the DDMStructure class name if the web content article 828 is related to a DDM structure, the primary key of the class name 829 associated with the article, or {@link 830 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 831 * @param classPK the primary key of the DDM structure, if the the 832 DDMStructure class name is given as the <code>className</code> 833 parameter, the primary key of the class associated with the web 834 content article, or <code>0</code> otherwise 835 * @return the matching web content article 836 * @throws PortalException if a matching web content article could not be 837 found 838 */ 839 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 840 long groupId, java.lang.String className, long classPK) 841 throws com.liferay.portal.kernel.exception.PortalException { 842 return getService().getArticle(groupId, className, classPK); 843 } 844 845 /** 846 * Returns the web content article with the ID. 847 * 848 * @param id the primary key of the web content article 849 * @return the web content article with the ID 850 * @throws PortalException if a matching web content article could not be 851 found 852 */ 853 public static com.liferay.portlet.journal.model.JournalArticle getArticle( 854 long id) throws com.liferay.portal.kernel.exception.PortalException { 855 return getService().getArticle(id); 856 } 857 858 /** 859 * Returns the latest web content article that is approved, or the latest 860 * unapproved article if none are approved. Both approved and unapproved 861 * articles must match the group and URL title. 862 * 863 * @param groupId the primary key of the web content article's group 864 * @param urlTitle the web content article's accessible URL title 865 * @return the matching web content article 866 * @throws PortalException if a portal exception occurred 867 */ 868 public static com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle( 869 long groupId, java.lang.String urlTitle) 870 throws com.liferay.portal.kernel.exception.PortalException { 871 return getService().getArticleByUrlTitle(groupId, urlTitle); 872 } 873 874 /** 875 * Returns the web content from the web content article associated with the 876 * portlet request model and the DDM template. 877 * 878 * @param article the web content article 879 * @param ddmTemplateKey the primary key of the web content article's DDM 880 template 881 * @param viewMode the mode in which the web content is being viewed 882 * @param languageId the primary key of the language translation to get 883 * @param portletRequestModel the portlet request model 884 * @param themeDisplay the theme display 885 * @return the web content from the web content article associated with the 886 portlet request model and the DDM template 887 * @throws PortalException if a matching DDM template could not be found, or 888 if a portal exception occurred 889 */ 890 public static java.lang.String getArticleContent( 891 com.liferay.portlet.journal.model.JournalArticle article, 892 java.lang.String ddmTemplateKey, java.lang.String viewMode, 893 java.lang.String languageId, 894 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 895 com.liferay.portal.theme.ThemeDisplay themeDisplay) 896 throws com.liferay.portal.kernel.exception.PortalException { 897 return getService() 898 .getArticleContent(article, ddmTemplateKey, viewMode, 899 languageId, portletRequestModel, themeDisplay); 900 } 901 902 /** 903 * Returns the web content from the web content article associated with the 904 * DDM template. 905 * 906 * @param article the web content article 907 * @param ddmTemplateKey the primary key of the web content article's 908 DDM template 909 * @param viewMode the mode in which the web content is being viewed 910 * @param languageId the primary key of the language translation to get 911 * @param themeDisplay the theme display 912 * @return the web content from the matching web content article 913 * @throws PortalException if a matching DDM template could not be 914 found, or if a portal exception occurred 915 * @deprecated As of 7.0.0, replaced by {@link 916 #getArticleContent(JournalArticle, String, String, String, 917 PortletRequestModel,ThemeDisplay)} 918 */ 919 @Deprecated 920 public static java.lang.String getArticleContent( 921 com.liferay.portlet.journal.model.JournalArticle article, 922 java.lang.String ddmTemplateKey, java.lang.String viewMode, 923 java.lang.String languageId, 924 com.liferay.portal.theme.ThemeDisplay themeDisplay) 925 throws com.liferay.portal.kernel.exception.PortalException { 926 return getService() 927 .getArticleContent(article, ddmTemplateKey, viewMode, 928 languageId, themeDisplay); 929 } 930 931 /** 932 * Returns the web content from the web content article matching the group, 933 * article ID, and version, and associated with the portlet request model 934 * and the DDM template. 935 * 936 * @param groupId the primary key of the web content article's group 937 * @param articleId the primary key of the web content article 938 * @param version the web content article's version 939 * @param viewMode the mode in which the web content is being viewed 940 * @param ddmTemplateKey the primary key of the web content article's DDM 941 template 942 * @param languageId the primary key of the language translation to get 943 * @param portletRequestModel the portlet request model 944 * @param themeDisplay the theme display 945 * @return the web content from the matching web content article 946 * @throws PortalException if a matching web content article or DDM template 947 could not be found, or if a portal exception occurred 948 */ 949 public static java.lang.String getArticleContent(long groupId, 950 java.lang.String articleId, double version, java.lang.String viewMode, 951 java.lang.String ddmTemplateKey, java.lang.String languageId, 952 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 953 com.liferay.portal.theme.ThemeDisplay themeDisplay) 954 throws com.liferay.portal.kernel.exception.PortalException { 955 return getService() 956 .getArticleContent(groupId, articleId, version, viewMode, 957 ddmTemplateKey, languageId, portletRequestModel, themeDisplay); 958 } 959 960 /** 961 * Returns the web content from the web content article matching the group, 962 * article ID, and version, and associated with the DDM template. 963 * 964 * @param groupId the primary key of the web content article's group 965 * @param articleId the primary key of the web content article 966 * @param version the web content article's version 967 * @param viewMode the mode in which the web content is being viewed 968 * @param ddmTemplateKey the primary key of the web content article's 969 DDM template (optionally <code>null</code>). If the article 970 is related to a DDM structure, the template's structure must 971 match it. 972 * @param languageId the primary key of the language translation to get 973 * @param themeDisplay the theme display 974 * @return the web content from the matching web content article 975 * @throws PortalException if a matching web content article or DDM 976 template could not be found, or if a portal exception 977 occurred 978 * @deprecated As of 7.0.0, replaced by {@link #getArticleContent(long, 979 String, double, String, String, String, PortletRequestModel, 980 ThemeDisplay)} 981 */ 982 @Deprecated 983 public static java.lang.String getArticleContent(long groupId, 984 java.lang.String articleId, double version, java.lang.String viewMode, 985 java.lang.String ddmTemplateKey, java.lang.String languageId, 986 com.liferay.portal.theme.ThemeDisplay themeDisplay) 987 throws com.liferay.portal.kernel.exception.PortalException { 988 return getService() 989 .getArticleContent(groupId, articleId, version, viewMode, 990 ddmTemplateKey, languageId, themeDisplay); 991 } 992 993 /** 994 * Returns the web content from the web content article matching the group, 995 * article ID, and version. 996 * 997 * @param groupId the primary key of the web content article's group 998 * @param articleId the primary key of the web content article 999 * @param version the web content article's version 1000 * @param viewMode the mode in which the web content is being viewed 1001 * @param languageId the primary key of the language translation to get 1002 * @param themeDisplay the theme display 1003 * @return the web content from the matching web content article 1004 * @throws PortalException if a matching web content article or DDM 1005 template could not be found, or if a portal exception 1006 occurred 1007 * @deprecated As of 7.0.0, replaced by {@link #getArticleContent(long, 1008 String, double, String, String, String, PortletRequestModel, 1009 ThemeDisplay)} 1010 */ 1011 @Deprecated 1012 public static java.lang.String getArticleContent(long groupId, 1013 java.lang.String articleId, double version, java.lang.String viewMode, 1014 java.lang.String languageId, 1015 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1016 throws com.liferay.portal.kernel.exception.PortalException { 1017 return getService() 1018 .getArticleContent(groupId, articleId, version, viewMode, 1019 languageId, themeDisplay); 1020 } 1021 1022 /** 1023 * Returns the latest web content from the web content article matching the 1024 * group and article ID, and associated with the portlet request model and 1025 * the DDM template. 1026 * 1027 * @param groupId the primary key of the web content article's group 1028 * @param articleId the primary key of the web content article 1029 * @param viewMode the mode in which the web content is being viewed 1030 * @param ddmTemplateKey the primary key of the web content article's DDM 1031 template 1032 * @param languageId the primary key of the language translation to get 1033 * @param portletRequestModel the portlet request model 1034 * @param themeDisplay the theme display 1035 * @return the latest web content from the matching web content article 1036 * @throws PortalException if a matching web content article or DDM template 1037 could not be found, or if a portal exception occurred 1038 */ 1039 public static java.lang.String getArticleContent(long groupId, 1040 java.lang.String articleId, java.lang.String viewMode, 1041 java.lang.String ddmTemplateKey, java.lang.String languageId, 1042 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 1043 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1044 throws com.liferay.portal.kernel.exception.PortalException { 1045 return getService() 1046 .getArticleContent(groupId, articleId, viewMode, 1047 ddmTemplateKey, languageId, portletRequestModel, themeDisplay); 1048 } 1049 1050 /** 1051 * Returns the latest web content from the web content article matching the 1052 * group and article ID, and associated with the DDM template. 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 viewMode the mode in which the web content is being viewed 1057 * @param ddmTemplateKey the primary key of the web content article's 1058 DDM template 1059 * @param languageId the primary key of the language translation to get 1060 * @param themeDisplay the theme display 1061 * @return the latest web content from the matching web content article 1062 * @throws PortalException if a matching web content article or DDM 1063 template could not be found, or if a portal exception 1064 occurred 1065 * @deprecated As of 7.0.0, replaced by {@link #getArticleContent(long, 1066 String, String, String, String, PortletRequestModel, 1067 ThemeDisplay)} 1068 */ 1069 @Deprecated 1070 public static java.lang.String getArticleContent(long groupId, 1071 java.lang.String articleId, java.lang.String viewMode, 1072 java.lang.String ddmTemplateKey, java.lang.String languageId, 1073 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1074 throws com.liferay.portal.kernel.exception.PortalException { 1075 return getService() 1076 .getArticleContent(groupId, articleId, viewMode, 1077 ddmTemplateKey, languageId, themeDisplay); 1078 } 1079 1080 /** 1081 * Returns the latest web content from the web content article matching the 1082 * group and article ID. 1083 * 1084 * @param groupId the primary key of the web content article's group 1085 * @param articleId the primary key of the web content article 1086 * @param viewMode the mode in which the web content is being viewed 1087 * @param languageId the primary key of the language translation to get 1088 * @param themeDisplay the theme display 1089 * @return the latest web content from the matching web content article 1090 * @throws PortalException if a matching web content article or DDM 1091 template could not be found, or if a portal exception 1092 occurred 1093 * @deprecated As of 7.0.0, replaced by {@link #getArticleContent(long, 1094 String, String, String, String, PortletRequestModel, 1095 ThemeDisplay)} 1096 */ 1097 @Deprecated 1098 public static java.lang.String getArticleContent(long groupId, 1099 java.lang.String articleId, java.lang.String viewMode, 1100 java.lang.String languageId, 1101 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1102 throws com.liferay.portal.kernel.exception.PortalException { 1103 return getService() 1104 .getArticleContent(groupId, articleId, viewMode, languageId, 1105 themeDisplay); 1106 } 1107 1108 /** 1109 * Returns a web content article display for the specified page of the 1110 * latest version of the web content article, based on the DDM template. Web 1111 * content transformation tokens are added using the portlet request model 1112 * and theme display. 1113 * 1114 * @param article the primary key of the web content article 1115 * @param ddmTemplateKey the primary key of the web content article's DDM 1116 template 1117 * @param viewMode the mode in which the web content is being viewed 1118 * @param languageId the primary key of the language translation to get 1119 * @param page the web content article page to display 1120 * @param portletRequestModel the portlet request model 1121 * @param themeDisplay the theme display 1122 * @return the web content article display, or <code>null</code> if the 1123 article has expired or if article's display date/time is after 1124 the current date/time 1125 * @throws PortalException if a portal exception occurred 1126 */ 1127 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1128 com.liferay.portlet.journal.model.JournalArticle article, 1129 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1130 java.lang.String languageId, int page, 1131 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 1132 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1133 throws com.liferay.portal.kernel.exception.PortalException { 1134 return getService() 1135 .getArticleDisplay(article, ddmTemplateKey, viewMode, 1136 languageId, page, portletRequestModel, themeDisplay); 1137 } 1138 1139 /** 1140 * Returns a web content article display for the specified page of the 1141 * latest version of the web content article matching the group, article ID, 1142 * and DDM template. Web content transformation tokens are added using the 1143 * portlet request model and theme display. 1144 * 1145 * @param groupId the primary key of the web content article's group 1146 * @param articleId the primary key of the web content article 1147 * @param ddmTemplateKey the primary key of the web content article's DDM 1148 template 1149 * @param viewMode the mode in which the web content is being viewed 1150 * @param languageId the primary key of the language translation to get 1151 * @param page the web content article page to display 1152 * @param portletRequestModel the portlet request model 1153 * @param themeDisplay the theme display 1154 * @return the web content article display, or <code>null</code> if the 1155 article has expired or if article's display date/time is after 1156 the current date/time 1157 * @throws PortalException if a portal exception occurred 1158 */ 1159 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1160 long groupId, java.lang.String articleId, 1161 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1162 java.lang.String languageId, int page, 1163 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 1164 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1165 throws com.liferay.portal.kernel.exception.PortalException { 1166 return getService() 1167 .getArticleDisplay(groupId, articleId, ddmTemplateKey, 1168 viewMode, languageId, page, portletRequestModel, themeDisplay); 1169 } 1170 1171 /** 1172 * Returns a web content article display for the first page of the latest 1173 * version of the web content article matching the group, article ID, and 1174 * DDM template. Web content transformation tokens are added from the theme 1175 * display (if not <code>null</code>). 1176 * 1177 * @param groupId the primary key of the web content article's group 1178 * @param articleId the primary key of the web content article 1179 * @param ddmTemplateKey the primary key of the web content article's DDM 1180 template 1181 * @param viewMode the mode in which the web content is being viewed 1182 * @param languageId the primary key of the language translation to get 1183 * @param themeDisplay the theme display 1184 * @return the web content article display, or <code>null</code> if the 1185 article has expired or if article's display date/time is after 1186 the current date/time 1187 * @throws PortalException if a matching web content article or DDM template 1188 could not be found, or if a portal exception occurred 1189 */ 1190 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1191 long groupId, java.lang.String articleId, 1192 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1193 java.lang.String languageId, 1194 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1195 throws com.liferay.portal.kernel.exception.PortalException { 1196 return getService() 1197 .getArticleDisplay(groupId, articleId, ddmTemplateKey, 1198 viewMode, languageId, themeDisplay); 1199 } 1200 1201 /** 1202 * Returns a web content article display for the specified page of the 1203 * specified version of the web content article matching the group, article 1204 * ID, and DDM template. Web content transformation tokens are added using 1205 * the portlet request model and theme display. 1206 * 1207 * @param groupId the primary key of the web content article's group 1208 * @param articleId the primary key of the web content article 1209 * @param version the web content article's version 1210 * @param ddmTemplateKey the primary key of the web content article's DDM 1211 template 1212 * @param viewMode the mode in which the web content is being viewed 1213 * @param languageId the primary key of the language translation to get 1214 * @param page the web content article page to display 1215 * @param portletRequestModel the portlet request model 1216 * @param themeDisplay the theme display 1217 * @return the web content article display, or <code>null</code> if the 1218 article has expired or if article's display date/time is after 1219 the current date/time 1220 * @throws PortalException if a portal exception occurred 1221 */ 1222 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1223 long groupId, java.lang.String articleId, double version, 1224 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1225 java.lang.String languageId, int page, 1226 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 1227 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1228 throws com.liferay.portal.kernel.exception.PortalException { 1229 return getService() 1230 .getArticleDisplay(groupId, articleId, version, 1231 ddmTemplateKey, viewMode, languageId, page, portletRequestModel, 1232 themeDisplay); 1233 } 1234 1235 /** 1236 * Returns a web content article display for the first page of the specified 1237 * version of the web content article matching the group, article ID, and 1238 * DDM template. Web content transformation tokens are added from the theme 1239 * display (if not <code>null</code>). 1240 * 1241 * @param groupId the primary key of the web content article's group 1242 * @param articleId the primary key of the web content article 1243 * @param version the web content article's version 1244 * @param ddmTemplateKey the primary key of the web content article's DDM 1245 template 1246 * @param viewMode the mode in which the web content is being viewed 1247 * @param languageId the primary key of the language translation to get 1248 * @param themeDisplay the theme display 1249 * @return the web content article display, or <code>null</code> if the 1250 article has expired or if article's display date/time is after 1251 the current date/time 1252 * @throws PortalException if a matching web content article or DDM template 1253 could not be found, or if a portal exception occurred 1254 */ 1255 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1256 long groupId, java.lang.String articleId, double version, 1257 java.lang.String ddmTemplateKey, java.lang.String viewMode, 1258 java.lang.String languageId, 1259 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1260 throws com.liferay.portal.kernel.exception.PortalException { 1261 return getService() 1262 .getArticleDisplay(groupId, articleId, version, 1263 ddmTemplateKey, viewMode, languageId, themeDisplay); 1264 } 1265 1266 /** 1267 * Returns a web content article display for the specified page of the 1268 * latest version of the web content article matching the group and article 1269 * ID. Web content transformation tokens are added from the theme display 1270 * (if not <code>null</code>). 1271 * 1272 * @param groupId the primary key of the web content article's group 1273 * @param articleId the primary key of the web content article 1274 * @param viewMode the mode in which the web content is being viewed 1275 * @param languageId the primary key of the language translation to get 1276 * @param page the web content article page to display 1277 * @param portletRequestModel the portlet request model 1278 * @param themeDisplay the theme display 1279 * @return the web content article display, or <code>null</code> if the 1280 article has expired or if article's display date/time is after 1281 the current date/time 1282 * @throws PortalException if a portal exception occurred 1283 */ 1284 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1285 long groupId, java.lang.String articleId, java.lang.String viewMode, 1286 java.lang.String languageId, int page, 1287 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 1288 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1289 throws com.liferay.portal.kernel.exception.PortalException { 1290 return getService() 1291 .getArticleDisplay(groupId, articleId, viewMode, languageId, 1292 page, portletRequestModel, themeDisplay); 1293 } 1294 1295 /** 1296 * Returns a web content article display for the first page of the latest 1297 * version of the web content article matching the group and article ID. Web 1298 * content transformation tokens are added from the theme display (if not 1299 * <code>null</code>). 1300 * 1301 * @param groupId the primary key of the web content article's group 1302 * @param articleId the primary key of the web content article 1303 * @param viewMode the mode in which the web content is being viewed 1304 * @param languageId the primary key of the language translation to get 1305 * @param themeDisplay the theme display 1306 * @return the web content article display, or <code>null</code> if the 1307 article has expired or if article's display date/time is after 1308 the current date/time 1309 * @throws PortalException if a matching web content article or DDM template 1310 could not be found, or if a portal exception occurred 1311 */ 1312 public static com.liferay.portlet.journal.model.JournalArticleDisplay getArticleDisplay( 1313 long groupId, java.lang.String articleId, java.lang.String viewMode, 1314 java.lang.String languageId, 1315 com.liferay.portal.theme.ThemeDisplay themeDisplay) 1316 throws com.liferay.portal.kernel.exception.PortalException { 1317 return getService() 1318 .getArticleDisplay(groupId, articleId, viewMode, languageId, 1319 themeDisplay); 1320 } 1321 1322 /** 1323 * Returns all the web content articles present in the system. 1324 * 1325 * @return the web content articles present in the system 1326 */ 1327 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles() { 1328 return getService().getArticles(); 1329 } 1330 1331 /** 1332 * Returns all the web content articles belonging to the group. 1333 * 1334 * @param groupId the primary key of the web content article's group 1335 * @return the web content articles belonging to the group 1336 */ 1337 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1338 long groupId) { 1339 return getService().getArticles(groupId); 1340 } 1341 1342 /** 1343 * Returns all the web content articles matching the group and article ID. 1344 * 1345 * @param groupId the primary key of the web content article's group 1346 * @param articleId the primary key of the web content article 1347 * @return the matching web content articles 1348 */ 1349 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1350 long groupId, java.lang.String articleId) { 1351 return getService().getArticles(groupId, articleId); 1352 } 1353 1354 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1355 long groupId, java.lang.String articleId, int start, int end, 1356 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> orderByComparator) { 1357 return getService() 1358 .getArticles(groupId, articleId, start, end, 1359 orderByComparator); 1360 } 1361 1362 /** 1363 * Returns all the web content articles matching the group and folder. 1364 * 1365 * @param groupId the primary key of the web content article's group 1366 * @param folderId the primary key of the web content article folder 1367 * @return the matching web content articles 1368 */ 1369 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1370 long groupId, long folderId) { 1371 return getService().getArticles(groupId, folderId); 1372 } 1373 1374 /** 1375 * Returns a range of all the web content articles matching the group and 1376 * folder. 1377 * 1378 * <p> 1379 * Useful when paginating results. Returns a maximum of <code>end - 1380 * start</code> instances. <code>start</code> and <code>end</code> are not 1381 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1382 * refers to the first result in the set. Setting both <code>start</code> 1383 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1384 * result set. 1385 * </p> 1386 * 1387 * @param groupId the primary key of the web content article's group 1388 * @param folderId the primary key of the web content article's folder 1389 * @param start the lower bound of the range of web content articles to 1390 return 1391 * @param end the upper bound of the range of web content articles to 1392 return (not inclusive) 1393 * @return the range of matching web content articles 1394 */ 1395 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1396 long groupId, long folderId, int start, int end) { 1397 return getService().getArticles(groupId, folderId, start, end); 1398 } 1399 1400 /** 1401 * Returns an ordered range of all the web content articles matching the 1402 * group and folder. 1403 * 1404 * <p> 1405 * Useful when paginating results. Returns a maximum of <code>end - 1406 * start</code> instances. <code>start</code> and <code>end</code> are not 1407 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1408 * refers to the first result in the set. Setting both <code>start</code> 1409 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1410 * result set. 1411 * </p> 1412 * 1413 * @param groupId the primary key of the web content article's group 1414 * @param folderId the primary key of the web content article's folder 1415 * @param start the lower bound of the range of web content articles to 1416 return 1417 * @param end the upper bound of the range of web content articles to 1418 return (not inclusive) 1419 * @param orderByComparator the comparator to order the web content 1420 articles 1421 * @return the range of matching web content articles ordered by the 1422 comparator 1423 */ 1424 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1425 long groupId, long folderId, int start, int end, 1426 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> orderByComparator) { 1427 return getService() 1428 .getArticles(groupId, folderId, start, end, orderByComparator); 1429 } 1430 1431 /** 1432 * Returns a range of all the web content articles matching the group, 1433 * folder, and status. 1434 * 1435 * <p> 1436 * Useful when paginating results. Returns a maximum of <code>end - 1437 * start</code> instances. <code>start</code> and <code>end</code> are not 1438 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1439 * refers to the first result in the set. Setting both <code>start</code> 1440 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1441 * result set. 1442 * </p> 1443 * 1444 * @param groupId the primary key of the web content article's group 1445 * @param folderId the primary key of the web content article's folder 1446 * @param status the web content article's workflow status. For more 1447 information see {@link WorkflowConstants} for constants starting 1448 with the "STATUS_" prefix. 1449 * @param start the lower bound of the range of web content articles to 1450 return 1451 * @param end the upper bound of the range of web content articles to 1452 return (not inclusive) 1453 * @return the range of matching web content articles 1454 */ 1455 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1456 long groupId, long folderId, int status, int start, int end) { 1457 return getService().getArticles(groupId, folderId, status, start, end); 1458 } 1459 1460 /** 1461 * Returns a range of all the web content articles belonging to the group. 1462 * 1463 * <p> 1464 * Useful when paginating results. Returns a maximum of <code>end - 1465 * start</code> instances. <code>start</code> and <code>end</code> are not 1466 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1467 * refers to the first result in the set. Setting both <code>start</code> 1468 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1469 * result set. 1470 * </p> 1471 * 1472 * @param groupId the primary key of the web content article's group 1473 * @param start the lower bound of the range of web content articles to 1474 return 1475 * @param end the upper bound of the range of web content articles to 1476 return (not inclusive) 1477 * @return the range of matching web content articles 1478 */ 1479 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1480 long groupId, int start, int end) { 1481 return getService().getArticles(groupId, start, end); 1482 } 1483 1484 /** 1485 * Returns an ordered range of all the web content articles belonging to the 1486 * group. 1487 * 1488 * <p> 1489 * Useful when paginating results. Returns a maximum of <code>end - 1490 * start</code> instances. <code>start</code> and <code>end</code> are not 1491 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1492 * refers to the first result in the set. Setting both <code>start</code> 1493 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1494 * result set. 1495 * </p> 1496 * 1497 * @param groupId the primary key of the web content article's group 1498 * @param start the lower bound of the range of web content articles to 1499 return 1500 * @param end the upper bound of the range of web content articles to 1501 return (not inclusive) 1502 * @param obc the comparator to order the web content articles 1503 * @return the range of matching web content articles ordered by the 1504 comparator 1505 */ 1506 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticles( 1507 long groupId, int start, int end, 1508 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 1509 return getService().getArticles(groupId, start, end, obc); 1510 } 1511 1512 /** 1513 * Returns all the web content articles matching the resource primary key. 1514 * 1515 * @param resourcePrimKey the primary key of the resource instance 1516 * @return the web content articles matching the resource primary key 1517 */ 1518 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesByResourcePrimKey( 1519 long resourcePrimKey) { 1520 return getService().getArticlesByResourcePrimKey(resourcePrimKey); 1521 } 1522 1523 /** 1524 * Returns all the web content articles matching the small image ID. 1525 * 1526 * @param smallImageId the primary key of the web content article's small 1527 image 1528 * @return the web content articles matching the small image ID 1529 */ 1530 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getArticlesBySmallImageId( 1531 long smallImageId) { 1532 return getService().getArticlesBySmallImageId(smallImageId); 1533 } 1534 1535 /** 1536 * Returns the number of web content articles belonging to the group. 1537 * 1538 * @param groupId the primary key of the web content article's group 1539 * @return the number of web content articles belonging to the group 1540 */ 1541 public static int getArticlesCount(long groupId) { 1542 return getService().getArticlesCount(groupId); 1543 } 1544 1545 public static int getArticlesCount(long groupId, java.lang.String articleId) { 1546 return getService().getArticlesCount(groupId, articleId); 1547 } 1548 1549 /** 1550 * Returns the number of web content articles matching the group and folder. 1551 * 1552 * @param groupId the primary key of the web content article's group 1553 * @param folderId the primary key of the web content article's folder 1554 * @return the number of matching web content articles 1555 */ 1556 public static int getArticlesCount(long groupId, long folderId) { 1557 return getService().getArticlesCount(groupId, folderId); 1558 } 1559 1560 /** 1561 * Returns the number of web content articles matching the group, folder, 1562 * and status. 1563 * 1564 * @param groupId the primary key of the web content article's group 1565 * @param folderId the primary key of the web content article's folder 1566 * @param status the web content article's workflow status. For more 1567 information see {@link WorkflowConstants} for constants starting 1568 with the "STATUS_" prefix. 1569 * @return the number of matching web content articles 1570 */ 1571 public static int getArticlesCount(long groupId, long folderId, int status) { 1572 return getService().getArticlesCount(groupId, folderId, status); 1573 } 1574 1575 /** 1576 * Returns the Spring bean ID for this bean. 1577 * 1578 * @return the Spring bean ID for this bean 1579 */ 1580 public static java.lang.String getBeanIdentifier() { 1581 return getService().getBeanIdentifier(); 1582 } 1583 1584 /** 1585 * Returns an ordered range of all the web content articles matching the 1586 * company and workflow status. 1587 * 1588 * <p> 1589 * Useful when paginating results. Returns a maximum of <code>end - 1590 * start</code> instances. <code>start</code> and <code>end</code> are not 1591 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1592 * refers to the first result in the set. Setting both <code>start</code> 1593 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1594 * result set. 1595 * </p> 1596 * 1597 * @param companyId the primary key of the web content article's company 1598 * @param status the web content article's workflow status. For more 1599 information see {@link WorkflowConstants} for constants starting 1600 with the "STATUS_" prefix. 1601 * @param start the lower bound of the range of web content articles to 1602 return 1603 * @param end the upper bound of the range of web content articles to 1604 return (not inclusive) 1605 * @return the range of matching web content articles ordered by article ID 1606 */ 1607 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getCompanyArticles( 1608 long companyId, int status, int start, int end) { 1609 return getService().getCompanyArticles(companyId, status, start, end); 1610 } 1611 1612 /** 1613 * Returns an ordered range of all the web content articles matching the 1614 * company, version, and workflow status. 1615 * 1616 * <p> 1617 * Useful when paginating results. Returns a maximum of <code>end - 1618 * start</code> instances. <code>start</code> and <code>end</code> are not 1619 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1620 * refers to the first result in the set. Setting both <code>start</code> 1621 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1622 * result set. 1623 * </p> 1624 * 1625 * @param companyId the primary key of the web content article's company 1626 * @param version the web content article's version 1627 * @param status the web content article's workflow status. For more 1628 information see {@link WorkflowConstants} for constants starting 1629 with the "STATUS_" prefix. 1630 * @param start the lower bound of the range of web content articles to 1631 return 1632 * @param end the upper bound of the range of web content articles to 1633 return (not inclusive) 1634 * @return the range of matching web content articles ordered by article ID 1635 */ 1636 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getCompanyArticles( 1637 long companyId, double version, int status, int start, int end) { 1638 return getService() 1639 .getCompanyArticles(companyId, version, status, start, end); 1640 } 1641 1642 /** 1643 * Returns the number of web content articles matching the company and 1644 * workflow status. 1645 * 1646 * @param companyId the primary key of the web content article's company 1647 * @param status the web content article's workflow status. For more 1648 information see {@link WorkflowConstants} for constants starting 1649 with the "STATUS_" prefix. 1650 * @return the number of matching web content articles 1651 */ 1652 public static int getCompanyArticlesCount(long companyId, int status) { 1653 return getService().getCompanyArticlesCount(companyId, status); 1654 } 1655 1656 /** 1657 * Returns the number of web content articles matching the company, version, 1658 * and workflow status. 1659 * 1660 * <p> 1661 * Useful when paginating results. Returns a maximum of <code>end - 1662 * start</code> instances. <code>start</code> and <code>end</code> are not 1663 * primary keys, they are indexes in the result set. Thus, <code>0</code> 1664 * refers to the first result in the set. Setting both <code>start</code> 1665 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 1666 * result set. 1667 * </p> 1668 * 1669 * @param companyId the primary key of the web content article's company 1670 * @param version the web content article's version 1671 * @param status the web content article's workflow status. For more 1672 information see {@link WorkflowConstants} for constants starting 1673 with the "STATUS_" prefix. 1674 * @param start the lower bound of the range of web content articles to 1675 return 1676 * @param end the upper bound of the range of web content articles to 1677 return (not inclusive) 1678 * @return the number of matching web content articles 1679 */ 1680 public static int getCompanyArticlesCount(long companyId, double version, 1681 int status, int start, int end) { 1682 return getService() 1683 .getCompanyArticlesCount(companyId, version, status, start, 1684 end); 1685 } 1686 1687 /** 1688 * Returns the matching web content article currently displayed or next to 1689 * be displayed if no article is currently displayed. 1690 * 1691 * @param groupId the primary key of the web content article's group 1692 * @param articleId the primary key of the web content article 1693 * @return the matching web content article currently displayed, or the next 1694 one to be displayed if no version of the article is currently 1695 displayed 1696 * @throws PortalException if no approved matching web content articles 1697 could be found 1698 */ 1699 public static com.liferay.portlet.journal.model.JournalArticle getDisplayArticle( 1700 long groupId, java.lang.String articleId) 1701 throws com.liferay.portal.kernel.exception.PortalException { 1702 return getService().getDisplayArticle(groupId, articleId); 1703 } 1704 1705 /** 1706 * Returns the web content article matching the URL title that is currently 1707 * displayed or next to be displayed if no article is currently displayed. 1708 * 1709 * @param groupId the primary key of the web content article's group 1710 * @param urlTitle the web content article's accessible URL title 1711 * @return the web content article matching the URL title that is currently 1712 displayed, or next one to be displayed if no version of the 1713 article is currently displayed 1714 * @throws PortalException if no approved matching web content articles 1715 could be found 1716 */ 1717 public static com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle( 1718 long groupId, java.lang.String urlTitle) 1719 throws com.liferay.portal.kernel.exception.PortalException { 1720 return getService().getDisplayArticleByUrlTitle(groupId, urlTitle); 1721 } 1722 1723 public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 1724 com.liferay.portal.kernel.lar.PortletDataContext portletDataContext) { 1725 return getService().getExportActionableDynamicQuery(portletDataContext); 1726 } 1727 1728 /** 1729 * Returns the indexable web content articles matching the resource primary 1730 * key. 1731 * 1732 * @param resourcePrimKey the primary key of the resource instance 1733 * @return the indexable web content articles matching the resource primary 1734 key 1735 */ 1736 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getIndexableArticlesByResourcePrimKey( 1737 long resourcePrimKey) { 1738 return getService() 1739 .getIndexableArticlesByResourcePrimKey(resourcePrimKey); 1740 } 1741 1742 /** 1743 * Returns the journal article with the primary key. 1744 * 1745 * @param id the primary key of the journal article 1746 * @return the journal article 1747 * @throws PortalException if a journal article with the primary key could not be found 1748 */ 1749 public static com.liferay.portlet.journal.model.JournalArticle getJournalArticle( 1750 long id) throws com.liferay.portal.kernel.exception.PortalException { 1751 return getService().getJournalArticle(id); 1752 } 1753 1754 /** 1755 * Returns the journal article matching the UUID and group. 1756 * 1757 * @param uuid the journal article's UUID 1758 * @param groupId the primary key of the group 1759 * @return the matching journal article 1760 * @throws PortalException if a matching journal article could not be found 1761 */ 1762 public static com.liferay.portlet.journal.model.JournalArticle getJournalArticleByUuidAndGroupId( 1763 java.lang.String uuid, long groupId) 1764 throws com.liferay.portal.kernel.exception.PortalException { 1765 return getService().getJournalArticleByUuidAndGroupId(uuid, groupId); 1766 } 1767 1768 /** 1769 * Returns a range of all the journal articles. 1770 * 1771 * <p> 1772 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalArticleModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 1773 * </p> 1774 * 1775 * @param start the lower bound of the range of journal articles 1776 * @param end the upper bound of the range of journal articles (not inclusive) 1777 * @return the range of journal articles 1778 */ 1779 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getJournalArticles( 1780 int start, int end) { 1781 return getService().getJournalArticles(start, end); 1782 } 1783 1784 /** 1785 * Returns all the journal articles matching the UUID and company. 1786 * 1787 * @param uuid the UUID of the journal articles 1788 * @param companyId the primary key of the company 1789 * @return the matching journal articles, or an empty list if no matches were found 1790 */ 1791 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getJournalArticlesByUuidAndCompanyId( 1792 java.lang.String uuid, long companyId) { 1793 return getService().getJournalArticlesByUuidAndCompanyId(uuid, companyId); 1794 } 1795 1796 /** 1797 * Returns a range of journal articles matching the UUID and company. 1798 * 1799 * @param uuid the UUID of the journal articles 1800 * @param companyId the primary key of the company 1801 * @param start the lower bound of the range of journal articles 1802 * @param end the upper bound of the range of journal articles (not inclusive) 1803 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 1804 * @return the range of matching journal articles, or an empty list if no matches were found 1805 */ 1806 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getJournalArticlesByUuidAndCompanyId( 1807 java.lang.String uuid, long companyId, int start, int end, 1808 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> orderByComparator) { 1809 return getService() 1810 .getJournalArticlesByUuidAndCompanyId(uuid, companyId, 1811 start, end, orderByComparator); 1812 } 1813 1814 /** 1815 * Returns the number of journal articles. 1816 * 1817 * @return the number of journal articles 1818 */ 1819 public static int getJournalArticlesCount() { 1820 return getService().getJournalArticlesCount(); 1821 } 1822 1823 /** 1824 * Returns the latest web content article with the group and article ID. 1825 * 1826 * @param groupId the primary key of the web content article's group 1827 * @param articleId the primary key of the web content article 1828 * @return the latest matching web content article 1829 * @throws PortalException if a matching web content article could not be 1830 found 1831 */ 1832 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1833 long groupId, java.lang.String articleId) 1834 throws com.liferay.portal.kernel.exception.PortalException { 1835 return getService().getLatestArticle(groupId, articleId); 1836 } 1837 1838 /** 1839 * Returns the latest web content article matching the group, article ID, 1840 * and workflow status. 1841 * 1842 * @param groupId the primary key of the web content article's group 1843 * @param articleId the primary key of the web content article 1844 * @param status the web content article's workflow status. For more 1845 information see {@link WorkflowConstants} for constants starting 1846 with the "STATUS_" prefix. 1847 * @return the latest matching web content article 1848 * @throws PortalException if a matching web content article could not be 1849 found 1850 */ 1851 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1852 long groupId, java.lang.String articleId, int status) 1853 throws com.liferay.portal.kernel.exception.PortalException { 1854 return getService().getLatestArticle(groupId, articleId, status); 1855 } 1856 1857 /** 1858 * Returns the latest web content article matching the group, class name ID, 1859 * and class PK. 1860 * 1861 * @param groupId the primary key of the web content article's group 1862 * @param className the DDMStructure class name if the web content article 1863 is related to a DDM structure, the class name associated with the 1864 article, or {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} 1865 otherwise 1866 * @param classPK the primary key of the DDM structure, if the DDMStructure 1867 class name is given as the <code>className</code> parameter, the 1868 primary key of the class associated with the web content article, 1869 or <code>0</code> otherwise 1870 * @return the latest matching web content article 1871 * @throws PortalException if a matching web content article could not be 1872 found 1873 */ 1874 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1875 long groupId, java.lang.String className, long classPK) 1876 throws com.liferay.portal.kernel.exception.PortalException { 1877 return getService().getLatestArticle(groupId, className, classPK); 1878 } 1879 1880 /** 1881 * Returns the latest web content article matching the resource primary key, 1882 * preferring articles with approved workflow status. 1883 * 1884 * @param resourcePrimKey the primary key of the resource instance 1885 * @return the latest web content article matching the resource primary key, 1886 preferring articles with approved workflow status 1887 * @throws PortalException if a matching web content article could not be 1888 found 1889 */ 1890 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1891 long resourcePrimKey) 1892 throws com.liferay.portal.kernel.exception.PortalException { 1893 return getService().getLatestArticle(resourcePrimKey); 1894 } 1895 1896 /** 1897 * Returns the latest web content article matching the resource primary key 1898 * and workflow status, preferring articles with approved workflow status. 1899 * 1900 * @param resourcePrimKey the primary key of the resource instance 1901 * @param status the web content article's workflow status. For more 1902 information see {@link WorkflowConstants} for constants starting 1903 with the "STATUS_" prefix. 1904 * @return the latest web content article matching the resource primary key 1905 and workflow status, preferring articles with approved workflow 1906 status 1907 * @throws PortalException if a matching web content article could not be 1908 found 1909 */ 1910 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1911 long resourcePrimKey, int status) 1912 throws com.liferay.portal.kernel.exception.PortalException { 1913 return getService().getLatestArticle(resourcePrimKey, status); 1914 } 1915 1916 /** 1917 * Returns the latest web content article matching the resource primary key 1918 * and workflow status, optionally preferring articles with approved 1919 * workflow status. 1920 * 1921 * @param resourcePrimKey the primary key of the resource instance 1922 * @param status the web content article's workflow status. For more 1923 information see {@link WorkflowConstants} for constants starting 1924 with the "STATUS_" prefix. 1925 * @param preferApproved whether to prefer returning the latest matching 1926 article that has workflow status {@link 1927 WorkflowConstants#STATUS_APPROVED} over returning one that has a 1928 different status 1929 * @return the latest web content article matching the resource primary key 1930 and workflow status, optionally preferring articles with approved 1931 workflow status 1932 * @throws PortalException if a matching web content article could not be 1933 found 1934 */ 1935 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticle( 1936 long resourcePrimKey, int status, boolean preferApproved) 1937 throws com.liferay.portal.kernel.exception.PortalException { 1938 return getService() 1939 .getLatestArticle(resourcePrimKey, status, preferApproved); 1940 } 1941 1942 /** 1943 * Returns the latest web content article matching the group, URL title, and 1944 * workflow status. 1945 * 1946 * @param groupId the primary key of the web content article's group 1947 * @param urlTitle the web content article's accessible URL title 1948 * @param status the web content article's workflow status. For more 1949 information see {@link WorkflowConstants} for constants starting 1950 with the "STATUS_" prefix. 1951 * @return the latest matching web content article 1952 * @throws PortalException if a matching web content article could not be 1953 found 1954 */ 1955 public static com.liferay.portlet.journal.model.JournalArticle getLatestArticleByUrlTitle( 1956 long groupId, java.lang.String urlTitle, int status) 1957 throws com.liferay.portal.kernel.exception.PortalException { 1958 return getService().getLatestArticleByUrlTitle(groupId, urlTitle, status); 1959 } 1960 1961 /** 1962 * Returns the latest version number of the web content with the group and 1963 * article ID. 1964 * 1965 * @param groupId the primary key of the web content article's group 1966 * @param articleId the primary key of the web content article 1967 * @return the latest version number of the matching web content 1968 * @throws PortalException if a matching web content article could not be 1969 found 1970 */ 1971 public static double getLatestVersion(long groupId, 1972 java.lang.String articleId) 1973 throws com.liferay.portal.kernel.exception.PortalException { 1974 return getService().getLatestVersion(groupId, articleId); 1975 } 1976 1977 /** 1978 * Returns the latest version number of the web content with the group, 1979 * article ID, and workflow status. 1980 * 1981 * @param groupId the primary key of the web content article's group 1982 * @param articleId the primary key of the web content article 1983 * @param status the web content article's workflow status. For more 1984 information see {@link WorkflowConstants} for constants starting 1985 with the "STATUS_" prefix. 1986 * @return the latest version number of the matching web content 1987 * @throws PortalException if a matching web content article could not be 1988 found 1989 */ 1990 public static double getLatestVersion(long groupId, 1991 java.lang.String articleId, int status) 1992 throws com.liferay.portal.kernel.exception.PortalException { 1993 return getService().getLatestVersion(groupId, articleId, status); 1994 } 1995 1996 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getNoAssetArticles() { 1997 return getService().getNoAssetArticles(); 1998 } 1999 2000 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getNoPermissionArticles() { 2001 return getService().getNoPermissionArticles(); 2002 } 2003 2004 /** 2005 * Returns the number of web content articles that are not recycled. 2006 * 2007 * @param groupId the primary key of the web content article's group 2008 * @param folderId the primary key of the web content article folder 2009 * @return the number of web content articles that are not recycled 2010 */ 2011 public static int getNotInTrashArticlesCount(long groupId, long folderId) { 2012 return getService().getNotInTrashArticlesCount(groupId, folderId); 2013 } 2014 2015 /** 2016 * Returns the oldest web content article with the group and article ID. 2017 * 2018 * @param groupId the primary key of the web content article's group 2019 * @param articleId the primary key of the web content article 2020 * @return the oldest matching web content article 2021 * @throws PortalException if a matching web content article could not be 2022 found 2023 */ 2024 public static com.liferay.portlet.journal.model.JournalArticle getOldestArticle( 2025 long groupId, java.lang.String articleId) 2026 throws com.liferay.portal.kernel.exception.PortalException { 2027 return getService().getOldestArticle(groupId, articleId); 2028 } 2029 2030 /** 2031 * Returns the oldest web content article matching the group, article ID, 2032 * and workflow status. 2033 * 2034 * @param groupId the primary key of the web content article's group 2035 * @param articleId the primary key of the web content article 2036 * @param status the web content article's workflow status. For more 2037 information see {@link WorkflowConstants} for constants starting 2038 with the "STATUS_" prefix. 2039 * @return the oldest matching web content article 2040 * @throws PortalException if a matching web content article could not be 2041 found 2042 */ 2043 public static com.liferay.portlet.journal.model.JournalArticle getOldestArticle( 2044 long groupId, java.lang.String articleId, int status) 2045 throws com.liferay.portal.kernel.exception.PortalException { 2046 return getService().getOldestArticle(groupId, articleId, status); 2047 } 2048 2049 public static com.liferay.portal.model.PersistedModel getPersistedModel( 2050 java.io.Serializable primaryKeyObj) 2051 throws com.liferay.portal.kernel.exception.PortalException { 2052 return getService().getPersistedModel(primaryKeyObj); 2053 } 2054 2055 /** 2056 * Returns the previously approved version of the web content article. For 2057 * more information on the approved workflow status, see {@link 2058 * WorkflowConstants#STATUS_APPROVED}. 2059 * 2060 * @param article the web content article 2061 * @return the previously approved version of the web content article, or 2062 the current web content article if there are no previously 2063 approved web content articles 2064 */ 2065 public static com.liferay.portlet.journal.model.JournalArticle getPreviousApprovedArticle( 2066 com.liferay.portlet.journal.model.JournalArticle article) { 2067 return getService().getPreviousApprovedArticle(article); 2068 } 2069 2070 /** 2071 * Returns the web content articles matching the DDM structure keys. 2072 * 2073 * @param ddmStructureKeys the primary keys of the web content article's 2074 DDM structures 2075 * @return the web content articles matching the DDM structure keys 2076 */ 2077 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 2078 java.lang.String[] ddmStructureKeys) { 2079 return getService().getStructureArticles(ddmStructureKeys); 2080 } 2081 2082 /** 2083 * Returns the web content articles matching the group and DDM structure 2084 * key. 2085 * 2086 * @param groupId the primary key of the web content article's group 2087 * @param ddmStructureKey the primary key of the web content article's DDM 2088 structure 2089 * @return the matching web content articles 2090 */ 2091 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 2092 long groupId, java.lang.String ddmStructureKey) { 2093 return getService().getStructureArticles(groupId, ddmStructureKey); 2094 } 2095 2096 /** 2097 * Returns an ordered range of all the web content articles matching the 2098 * group and DDM structure key. 2099 * 2100 * <p> 2101 * Useful when paginating results. Returns a maximum of <code>end - 2102 * start</code> instances. <code>start</code> and <code>end</code> are not 2103 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2104 * refers to the first result in the set. Setting both <code>start</code> 2105 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2106 * result set. 2107 * </p> 2108 * 2109 * @param groupId the primary key of the web content article's group 2110 * @param ddmStructureKey the primary key of the web content article's DDM 2111 structure 2112 * @param start the lower bound of the range of web content articles to 2113 return 2114 * @param end the upper bound of the range of web content articles to 2115 return (not inclusive) 2116 * @param obc the comparator to order the web content articles 2117 * @return the range of matching web content articles ordered by the 2118 comparator 2119 */ 2120 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getStructureArticles( 2121 long groupId, java.lang.String ddmStructureKey, int start, int end, 2122 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 2123 return getService() 2124 .getStructureArticles(groupId, ddmStructureKey, start, end, 2125 obc); 2126 } 2127 2128 /** 2129 * Returns the number of web content articles matching the group and DDM 2130 * structure key. 2131 * 2132 * @param groupId the primary key of the web content article's group 2133 * @param ddmStructureKey the primary key of the web content article's DDM 2134 structure 2135 * @return the number of matching web content articles 2136 */ 2137 public static int getStructureArticlesCount(long groupId, 2138 java.lang.String ddmStructureKey) { 2139 return getService().getStructureArticlesCount(groupId, ddmStructureKey); 2140 } 2141 2142 /** 2143 * Returns the web content articles matching the group and DDM template key. 2144 * 2145 * @param groupId the primary key of the web content article's group 2146 * @param ddmTemplateKey the primary key of the web content article's DDM 2147 template 2148 * @return the matching web content articles 2149 */ 2150 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getTemplateArticles( 2151 long groupId, java.lang.String ddmTemplateKey) { 2152 return getService().getTemplateArticles(groupId, ddmTemplateKey); 2153 } 2154 2155 /** 2156 * Returns an ordered range of all the web content articles matching the 2157 * group and DDM template key. 2158 * 2159 * <p> 2160 * Useful when paginating results. Returns a maximum of <code>end - 2161 * start</code> instances. <code>start</code> and <code>end</code> are not 2162 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2163 * refers to the first result in the set. Setting both <code>start</code> 2164 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2165 * result set. 2166 * </p> 2167 * 2168 * @param groupId the primary key of the web content article's group 2169 * @param ddmTemplateKey the primary key of the web content article's DDM 2170 template 2171 * @param start the lower bound of the range of web content articles to 2172 return 2173 * @param end the upper bound of the range of web content articles to 2174 return (not inclusive) 2175 * @param obc the comparator to order the web content articles 2176 * @return the range of matching web content articles ordered by the 2177 comparator 2178 */ 2179 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> getTemplateArticles( 2180 long groupId, java.lang.String ddmTemplateKey, int start, int end, 2181 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 2182 return getService() 2183 .getTemplateArticles(groupId, ddmTemplateKey, start, end, obc); 2184 } 2185 2186 /** 2187 * Returns the number of web content articles matching the group and DDM 2188 * template key. 2189 * 2190 * @param groupId the primary key of the web content article's group 2191 * @param ddmTemplateKey the primary key of the web content article's DDM 2192 template 2193 * @return the number of matching web content articles 2194 */ 2195 public static int getTemplateArticlesCount(long groupId, 2196 java.lang.String ddmTemplateKey) { 2197 return getService().getTemplateArticlesCount(groupId, ddmTemplateKey); 2198 } 2199 2200 /** 2201 * Returns the web content article's unique URL title. 2202 * 2203 * @param groupId the primary key of the web content article's group 2204 * @param articleId the primary key of the web content article 2205 * @param urlTitle the web content article's accessible URL title 2206 * @return the web content article's unique URL title 2207 * @throws PortalException if a portal exception occurred 2208 */ 2209 public static java.lang.String getUniqueUrlTitle(long groupId, 2210 java.lang.String articleId, java.lang.String urlTitle) 2211 throws com.liferay.portal.kernel.exception.PortalException { 2212 return getService().getUniqueUrlTitle(groupId, articleId, urlTitle); 2213 } 2214 2215 /** 2216 * Returns <code>true</code> if the specified web content article exists. 2217 * 2218 * @param groupId the primary key of the group 2219 * @param articleId the primary key of the web content article 2220 * @return <code>true</code> if the specified web content article exists; 2221 <code>false</code> otherwise 2222 */ 2223 public static boolean hasArticle(long groupId, java.lang.String articleId) { 2224 return getService().hasArticle(groupId, articleId); 2225 } 2226 2227 /** 2228 * Returns <code>true</code> if the web content article, specified by group 2229 * and article ID, is the latest version. 2230 * 2231 * @param groupId the primary key of the web content article's group 2232 * @param articleId the primary key of the web content article 2233 * @param version the web content article's version 2234 * @return <code>true</code> if the specified web content article is the 2235 latest version; <code>false</code> otherwise 2236 * @throws PortalException if a matching web content article could not be 2237 found 2238 */ 2239 public static boolean isLatestVersion(long groupId, 2240 java.lang.String articleId, double version) 2241 throws com.liferay.portal.kernel.exception.PortalException { 2242 return getService().isLatestVersion(groupId, articleId, version); 2243 } 2244 2245 /** 2246 * Returns <code>true</code> if the web content article, specified by group, 2247 * article ID, and workflow status, is the latest version. 2248 * 2249 * @param groupId the primary key of the web content article's group 2250 * @param articleId the primary key of the web content article 2251 * @param version the web content article's version 2252 * @param status the web content article's workflow status. For more 2253 information see {@link WorkflowConstants} for constants starting 2254 with the "STATUS_" prefix. 2255 * @return <code>true</code> if the specified web content article is the 2256 latest version; <code>false</code> otherwise 2257 * @throws PortalException if a matching web content article could not be 2258 found 2259 */ 2260 public static boolean isLatestVersion(long groupId, 2261 java.lang.String articleId, double version, int status) 2262 throws com.liferay.portal.kernel.exception.PortalException { 2263 return getService().isLatestVersion(groupId, articleId, version, status); 2264 } 2265 2266 public static boolean isRenderable( 2267 com.liferay.portlet.journal.model.JournalArticle article, 2268 com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, 2269 com.liferay.portal.theme.ThemeDisplay themeDisplay) { 2270 return getService() 2271 .isRenderable(article, portletRequestModel, themeDisplay); 2272 } 2273 2274 /** 2275 * Moves the web content article matching the group and article ID to a new 2276 * folder. 2277 * 2278 * @param groupId the primary key of the web content article's group 2279 * @param articleId the primary key of the web content article 2280 * @param newFolderId the primary key of the web content article's new 2281 folder 2282 * @return the updated web content article, which was moved to a new folder 2283 * @throws PortalException if a matching web content article could not be 2284 found 2285 */ 2286 public static com.liferay.portlet.journal.model.JournalArticle moveArticle( 2287 long groupId, java.lang.String articleId, long newFolderId) 2288 throws com.liferay.portal.kernel.exception.PortalException { 2289 return getService().moveArticle(groupId, articleId, newFolderId); 2290 } 2291 2292 /** 2293 * Moves the web content article from the Recycle Bin to a new folder. 2294 * 2295 * @param userId the primary key of the user updating the web content 2296 article 2297 * @param groupId the primary key of the web content article's group 2298 * @param article the web content article 2299 * @param newFolderId the primary key of the web content article's new 2300 folder 2301 * @param serviceContext the service context to be applied. Can set the 2302 modification date, portlet preferences, and can set whether to 2303 add the default command update for the web content article. With 2304 respect to social activities, by setting the service context's 2305 command to {@link 2306 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 2307 is considered a web content update activity; otherwise it is 2308 considered a web content add activity. 2309 * @return the updated web content article, which was moved from the Recycle 2310 Bin to a new folder 2311 * @throws PortalException if a trashed web content article with the primary 2312 key could not be found or if a portal exception occurred 2313 */ 2314 public static com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( 2315 long userId, long groupId, 2316 com.liferay.portlet.journal.model.JournalArticle article, 2317 long newFolderId, 2318 com.liferay.portal.service.ServiceContext serviceContext) 2319 throws com.liferay.portal.kernel.exception.PortalException { 2320 return getService() 2321 .moveArticleFromTrash(userId, groupId, article, newFolderId, 2322 serviceContext); 2323 } 2324 2325 /** 2326 * Moves the latest version of the web content article matching the group 2327 * and article ID to the recycle bin. 2328 * 2329 * @param userId the primary key of the user updating the web content 2330 article 2331 * @param article the web content article 2332 * @return the updated web content article, which was moved to the Recycle 2333 Bin 2334 * @throws PortalException if the user did not have permission to move the 2335 article to the Recycle Bin or if a portal exception occurred 2336 */ 2337 public static com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( 2338 long userId, com.liferay.portlet.journal.model.JournalArticle article) 2339 throws com.liferay.portal.kernel.exception.PortalException { 2340 return getService().moveArticleToTrash(userId, article); 2341 } 2342 2343 /** 2344 * Moves the latest version of the web content article matching the group 2345 * and article ID to the recycle bin. 2346 * 2347 * @param userId the primary key of the user updating the web content 2348 article 2349 * @param groupId the primary key of the web content article's group 2350 * @param articleId the primary key of the web content article 2351 * @return the moved web content article or <code>null</code> if no matching 2352 article was found 2353 * @throws PortalException if the user did not have permission to move the 2354 article to the Recycle Bin or if a portal exception occurred 2355 */ 2356 public static com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( 2357 long userId, long groupId, java.lang.String articleId) 2358 throws com.liferay.portal.kernel.exception.PortalException { 2359 return getService().moveArticleToTrash(userId, groupId, articleId); 2360 } 2361 2362 /** 2363 * Rebuilds the web content article's tree path using tree traversal. 2364 * 2365 * <p> 2366 * For example, here is a conceptualization of a web content article tree 2367 * path: 2368 * </p> 2369 * 2370 * <p> 2371 * <pre> 2372 * <code> 2373 * /(Folder's folderId)/(Subfolder's folderId)/(article's articleId) 2374 * </code> 2375 * </pre> 2376 * </p> 2377 * 2378 * @param companyId the primary key of the web content article's company 2379 * @throws PortalException if a portal exception occurred 2380 */ 2381 public static void rebuildTree(long companyId) 2382 throws com.liferay.portal.kernel.exception.PortalException { 2383 getService().rebuildTree(companyId); 2384 } 2385 2386 /** 2387 * Removes the web content of the web content article matching the group, 2388 * article ID, and version, and language. 2389 * 2390 * @param groupId the primary key of the web content article's group 2391 * @param articleId the primary key of the web content article 2392 * @param version the web content article's version 2393 * @param languageId the primary key of the language locale to remove 2394 * @return the updated web content article with the locale removed 2395 * @throws PortalException if a matching web content article could not be 2396 found 2397 */ 2398 public static com.liferay.portlet.journal.model.JournalArticle removeArticleLocale( 2399 long groupId, java.lang.String articleId, double version, 2400 java.lang.String languageId) 2401 throws com.liferay.portal.kernel.exception.PortalException { 2402 return getService() 2403 .removeArticleLocale(groupId, articleId, version, languageId); 2404 } 2405 2406 /** 2407 * Restores the web content article from the Recycle Bin. 2408 * 2409 * @param userId the primary key of the user restoring the web content 2410 article 2411 * @param article the web content article 2412 * @return the restored web content article from the Recycle Bin 2413 * @throws PortalException if the web content article with the primary key 2414 could not be found in the Recycle Bin, if the user did not have 2415 permission to restore the article, or if a portal exception 2416 occurred 2417 */ 2418 public static com.liferay.portlet.journal.model.JournalArticle restoreArticleFromTrash( 2419 long userId, com.liferay.portlet.journal.model.JournalArticle article) 2420 throws com.liferay.portal.kernel.exception.PortalException { 2421 return getService().restoreArticleFromTrash(userId, article); 2422 } 2423 2424 /** 2425 * Returns an ordered range of all the web content articles matching the 2426 * parameters using the indexer, including a keywords parameter for matching 2427 * an article's ID, title, description, or content, a DDM structure key 2428 * parameter, a DDM template key parameter, an AND operator switch, and 2429 * parameters for type, status, a finder hash map. It is preferable to use 2430 * this method instead of the non-indexed version whenever possible for 2431 * performance reasons. 2432 * 2433 * <p> 2434 * Useful when paginating results. Returns a maximum of <code>end - 2435 * start</code> instances. <code>start</code> and <code>end</code> are not 2436 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2437 * refers to the first result in the set. Setting both <code>start</code> 2438 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2439 * result set. 2440 * </p> 2441 * 2442 * @param companyId the primary key of the web content article's company 2443 * @param groupId the primary key of the group (optionally <code>0</code>) 2444 * @param folderIds the primary keys of the web content article folders 2445 (optionally {@link java.util.Collections#EMPTY_LIST}) 2446 * @param classNameId the primary key of the DDMStructure class if the web 2447 content article is related to a DDM structure, the primary key of 2448 the class name associated with the article, or {@link 2449 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2450 * @param articleId the article ID keywords (space separated, optionally 2451 <code>null</code>) 2452 * @param title the title keywords (space separated, optionally 2453 <code>null</code>) 2454 * @param description the description keywords (space separated, optionally 2455 <code>null</code>) 2456 * @param content the content keywords (space separated, optionally 2457 <code>null</code>) 2458 * @param status the web content article's workflow status. For more 2459 information see {@link WorkflowConstants} for constants starting 2460 with the "STATUS_" prefix. 2461 * @param ddmStructureKey the primary key of the web content article's DDM 2462 structure, if the article is related to a DDM structure, or 2463 <code>null</code> otherwise 2464 * @param ddmTemplateKey the primary key of the web content article's DDM 2465 template 2466 * @param params the finder parameters (optionally <code>null</code>). The 2467 <code>includeDiscussions</code> parameter can be set to 2468 <code>true</code> to search for the keywords in the web content 2469 article discussions. 2470 * @param andSearch whether every field must match its value or keywords, 2471 or just one field must match 2472 * @param start the lower bound of the range of web content articles to 2473 return 2474 * @param end the upper bound of the range of web content articles to 2475 return (not inclusive) 2476 * @param sort the field, type, and direction by which to sort (optionally 2477 <code>null</code>) 2478 * @return the matching web content articles ordered by <code>sort</code> 2479 */ 2480 public static com.liferay.portal.kernel.search.Hits search(long companyId, 2481 long groupId, java.util.List<java.lang.Long> folderIds, 2482 long classNameId, java.lang.String articleId, java.lang.String title, 2483 java.lang.String description, java.lang.String content, int status, 2484 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2485 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2486 boolean andSearch, int start, int end, 2487 com.liferay.portal.kernel.search.Sort sort) { 2488 return getService() 2489 .search(companyId, groupId, folderIds, classNameId, 2490 articleId, title, description, content, status, ddmStructureKey, 2491 ddmTemplateKey, params, andSearch, start, end, sort); 2492 } 2493 2494 /** 2495 * @deprecated As of 7.0.0, replaced by {@link #search(long, long, List, 2496 long, String, String, String, String, int, String, String, 2497 LinkedHashMap, boolean, int, int, Sort)} 2498 */ 2499 @Deprecated 2500 public static com.liferay.portal.kernel.search.Hits search(long companyId, 2501 long groupId, java.util.List<java.lang.Long> folderIds, 2502 long classNameId, java.lang.String articleId, java.lang.String title, 2503 java.lang.String description, java.lang.String content, 2504 java.lang.String type, java.lang.String statusString, 2505 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2506 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2507 boolean andSearch, int start, int end, 2508 com.liferay.portal.kernel.search.Sort sort) { 2509 return getService() 2510 .search(companyId, groupId, folderIds, classNameId, 2511 articleId, title, description, content, type, statusString, 2512 ddmStructureKey, ddmTemplateKey, params, andSearch, start, end, sort); 2513 } 2514 2515 /** 2516 * Returns an ordered range of all the web content articles matching the 2517 * parameters without using the indexer, including keyword parameters for 2518 * article ID, title, description, and content, a DDM structure key 2519 * parameter, a DDM template key parameter, and an AND operator switch. It 2520 * is preferable to use the indexed version {@link #search(long, long, List, 2521 * long, String, String, String, String, int, String, String, LinkedHashMap, 2522 * boolean, int, int, Sort)} instead of this method wherever possible for 2523 * performance reasons. 2524 * 2525 * <p> 2526 * Useful when paginating results. Returns a maximum of <code>end - 2527 * start</code> instances. <code>start</code> and <code>end</code> are not 2528 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2529 * refers to the first result in the set. Setting both <code>start</code> 2530 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2531 * result set. 2532 * </p> 2533 * 2534 * @param companyId the primary key of the web content article's company 2535 * @param groupId the primary key of the group (optionally <code>0</code>) 2536 * @param folderIds the primary keys of the web content article folders 2537 (optionally {@link java.util.Collections#EMPTY_LIST}) 2538 * @param classNameId the primary key of the DDMStructure class if the web 2539 content article is related to a DDM structure, the primary key of 2540 the class name associated with the article, or {@link 2541 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2542 * @param articleId the article ID keywords (space separated, optionally 2543 <code>null</code>) 2544 * @param version the web content article's version (optionally 2545 <code>null</code>) 2546 * @param title the title keywords (space separated, optionally 2547 <code>null</code>) 2548 * @param description the description keywords (space separated, optionally 2549 <code>null</code>) 2550 * @param content the content keywords (space separated, optionally 2551 <code>null</code>) 2552 * @param ddmStructureKey the primary key of the web content article's DDM 2553 structure, if the article is related to a DDM structure, or 2554 <code>null</code> otherwise 2555 * @param ddmTemplateKey the primary key of the web content article's DDM 2556 template 2557 * @param displayDateGT the date after which a matching web content 2558 article's display date must be after (optionally 2559 <code>null</code>) 2560 * @param displayDateLT the date before which a matching web content 2561 article's display date must be before (optionally 2562 <code>null</code>) 2563 * @param status the web content article's workflow status. For more 2564 information see {@link WorkflowConstants} for constants starting 2565 with the "STATUS_" prefix. 2566 * @param reviewDate the web content article's scheduled review date 2567 (optionally <code>null</code>) 2568 * @param andOperator whether every field must match its value or keywords, 2569 or just one field must match. Company, group, folder IDs, class 2570 name ID, and status must all match their values. 2571 * @param start the lower bound of the range of web content articles to 2572 return 2573 * @param end the upper bound of the range of web content articles to 2574 return (not inclusive) 2575 * @param obc the comparator to order the web content articles 2576 * @return the range of matching web content articles ordered by the 2577 comparator 2578 */ 2579 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2580 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2581 long classNameId, java.lang.String articleId, java.lang.Double version, 2582 java.lang.String title, java.lang.String description, 2583 java.lang.String content, java.lang.String ddmStructureKey, 2584 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 2585 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2586 boolean andOperator, int start, int end, 2587 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 2588 return getService() 2589 .search(companyId, groupId, folderIds, classNameId, 2590 articleId, version, title, description, content, ddmStructureKey, 2591 ddmTemplateKey, displayDateGT, displayDateLT, status, reviewDate, 2592 andOperator, start, end, obc); 2593 } 2594 2595 /** 2596 * Returns an ordered range of all the web content articles matching the 2597 * parameters without using the indexer, including keyword parameters for 2598 * article ID, title, description, and content, a DDM structure keys 2599 * (plural) parameter, a DDM template keys (plural) parameter, and an AND 2600 * operator switch. 2601 * 2602 * <p> 2603 * Useful when paginating results. Returns a maximum of <code>end - 2604 * start</code> instances. <code>start</code> and <code>end</code> are not 2605 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2606 * refers to the first result in the set. Setting both <code>start</code> 2607 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2608 * result set. 2609 * </p> 2610 * 2611 * @param companyId the primary key of the web content article's company 2612 * @param groupId the primary key of the group (optionally <code>0</code>) 2613 * @param folderIds the primary keys of the web content article folders 2614 (optionally {@link java.util.Collections#EMPTY_LIST}) 2615 * @param classNameId the primary key of the DDMStructure class if the web 2616 content article is related to a DDM structure, the primary key of 2617 the class name associated with the article, or {@link 2618 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2619 * @param articleId the article ID keywords (space separated, optionally 2620 <code>null</code>) 2621 * @param version the web content article's version (optionally 2622 <code>null</code>) 2623 * @param title the title keywords (space separated, optionally 2624 <code>null</code>) 2625 * @param description the description keywords (space separated, optionally 2626 <code>null</code>) 2627 * @param content the content keywords (space separated, optionally 2628 <code>null</code>) 2629 * @param ddmStructureKeys the primary keys of the web content article's 2630 DDM structures, if the article is related to a DDM structure, or 2631 <code>null</code> otherwise 2632 * @param ddmTemplateKeys the primary keys of the web content article's DDM 2633 templates (originally <code>null</code>). If the articles are 2634 related to a DDM structure, the template's structure must match 2635 it. 2636 * @param displayDateGT the date after which a matching web content 2637 article's display date must be after (optionally 2638 <code>null</code>) 2639 * @param displayDateLT the date before which a matching web content 2640 article's display date must be before (optionally 2641 <code>null</code>) 2642 * @param status the web content article's workflow status. For more 2643 information see {@link WorkflowConstants} for constants starting 2644 with the "STATUS_" prefix. 2645 * @param reviewDate the web content article's scheduled review date 2646 (optionally <code>null</code>) 2647 * @param andOperator whether every field must match its value or keywords, 2648 or just one field must match. Company, group, folder IDs, class 2649 name ID, and status must all match their values. 2650 * @param start the lower bound of the range of web content articles to 2651 return 2652 * @param end the upper bound of the range of web content articles to 2653 return (not inclusive) 2654 * @param obc the comparator to order the web content articles 2655 * @return the range of matching web content articles ordered by the 2656 comparator 2657 */ 2658 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2659 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2660 long classNameId, java.lang.String articleId, java.lang.Double version, 2661 java.lang.String title, java.lang.String description, 2662 java.lang.String content, java.lang.String[] ddmStructureKeys, 2663 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 2664 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2665 boolean andOperator, int start, int end, 2666 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 2667 return getService() 2668 .search(companyId, groupId, folderIds, classNameId, 2669 articleId, version, title, description, content, ddmStructureKeys, 2670 ddmTemplateKeys, displayDateGT, displayDateLT, status, reviewDate, 2671 andOperator, start, end, obc); 2672 } 2673 2674 /** 2675 * Returns an ordered range of all the web content articles matching the 2676 * parameters using the indexer, including a keywords parameter for matching 2677 * an article's ID, title, description, or content, a DDM structure key 2678 * parameter, a DDM template key parameter, and a finder hash map parameter. 2679 * It is preferable to use this method instead of the non-indexed version 2680 * whenever possible for performance reasons. 2681 * 2682 * <p> 2683 * Useful when paginating results. Returns a maximum of <code>end - 2684 * start</code> instances. <code>start</code> and <code>end</code> are not 2685 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2686 * refers to the first result in the set. Setting both <code>start</code> 2687 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2688 * result set. 2689 * </p> 2690 * 2691 * @param companyId the primary key of the web content article's company 2692 * @param groupId the primary key of the group (optionally <code>0</code>) 2693 * @param folderIds the primary keys of the web content article folders 2694 (optionally {@link java.util.Collections#EMPTY_LIST}) 2695 * @param classNameId the primary key of the DDMStructure class if the web 2696 content article is related to a DDM structure, the primary key of 2697 the class name associated with the article, or {@link 2698 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2699 * @param ddmStructureKey the primary key of the web content article's DDM 2700 structure, if the article is related to a DDM structure, or 2701 <code>null</code> otherwise 2702 * @param ddmTemplateKey the primary key of the web content article's DDM 2703 template 2704 * @param keywords the keywords (space separated), which may occur in the 2705 web content article ID, title, description, or content 2706 (optionally <code>null</code>). If the keywords value is not 2707 <code>null</code>, the search uses the OR operator in connecting 2708 query criteria; otherwise it uses the AND operator. 2709 * @param params the finder parameters (optionally <code>null</code>) 2710 * @param start the lower bound of the range of web content articles to 2711 return 2712 * @param end the upper bound of the range of web content articles to 2713 return (not inclusive) 2714 * @param sort the field, type, and direction by which to sort (optionally 2715 <code>null</code>) 2716 * @return the matching web content articles ordered by <code>sort</code> 2717 */ 2718 public static com.liferay.portal.kernel.search.Hits search(long companyId, 2719 long groupId, java.util.List<java.lang.Long> folderIds, 2720 long classNameId, java.lang.String ddmStructureKey, 2721 java.lang.String ddmTemplateKey, java.lang.String keywords, 2722 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 2723 int start, int end, com.liferay.portal.kernel.search.Sort sort) { 2724 return getService() 2725 .search(companyId, groupId, folderIds, classNameId, 2726 ddmStructureKey, ddmTemplateKey, keywords, params, start, end, sort); 2727 } 2728 2729 /** 2730 * Returns an ordered range of all the web content articles matching the 2731 * parameters without using the indexer, including a keywords parameter for 2732 * matching with the article's ID, title, description, and content, a DDM 2733 * structure key parameter, and a DDM template key parameter. It is 2734 * preferable to use the indexed version {@link #search(long, long, List, 2735 * long, String, String, String, LinkedHashMap, int, int, Sort)} instead of 2736 * this method wherever possible for performance reasons. 2737 * 2738 * <p> 2739 * Useful when paginating results. Returns a maximum of <code>end - 2740 * start</code> instances. <code>start</code> and <code>end</code> are not 2741 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2742 * refers to the first result in the set. Setting both <code>start</code> 2743 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2744 * result set. 2745 * </p> 2746 * 2747 * @param companyId the primary key of the web content article's company 2748 * @param groupId the primary key of the group (optionally <code>0</code>) 2749 * @param folderIds the primary keys of the web content article folders 2750 (optionally {@link java.util.Collections#EMPTY_LIST}) 2751 * @param classNameId the primary key of the DDMStructure class if the web 2752 content article is related to a DDM structure, the primary key of 2753 the class name associated with the article, or {@link 2754 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2755 * @param keywords the keywords (space separated), which may occur in the 2756 web content article ID, title, description, or content 2757 (optionally <code>null</code>). If the keywords value is not 2758 <code>null</code>, the search uses the OR operator in connecting 2759 query criteria; otherwise it uses the AND operator. 2760 * @param version the web content article's version (optionally 2761 <code>null</code>) 2762 * @param ddmStructureKey the primary key of the web content article's DDM 2763 structure, if the article is related to a DDM structure, or 2764 <code>null</code> otherwise 2765 * @param ddmTemplateKey the primary key of the web content article's DDM 2766 template 2767 * @param displayDateGT the date after which a matching web content 2768 article's display date must be after (optionally 2769 <code>null</code>) 2770 * @param displayDateLT the date before which a matching web content 2771 article's display date must be before (optionally 2772 <code>null</code>) 2773 * @param status the web content article's workflow status. For more 2774 information see {@link WorkflowConstants} for constants starting 2775 with the "STATUS_" prefix. 2776 * @param reviewDate the web content article's scheduled review date 2777 (optionally <code>null</code>) 2778 * @param start the lower bound of the range of web content articles to 2779 return 2780 * @param end the upper bound of the range of web content articles to 2781 return (not inclusive) 2782 * @param obc the comparator to order the web content articles 2783 * @return the range of matching web content articles ordered by the 2784 comparator 2785 */ 2786 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2787 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 2788 long classNameId, java.lang.String keywords, java.lang.Double version, 2789 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 2790 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 2791 java.util.Date reviewDate, int start, int end, 2792 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.journal.model.JournalArticle> obc) { 2793 return getService() 2794 .search(companyId, groupId, folderIds, classNameId, 2795 keywords, version, ddmStructureKey, ddmTemplateKey, displayDateGT, 2796 displayDateLT, status, reviewDate, start, end, obc); 2797 } 2798 2799 /** 2800 * Returns a range of all the web content articles in a single folder 2801 * matching the parameters without using the indexer. It is preferable to 2802 * use the indexed version {@link #search(long, long, long, int, int, int)} 2803 * instead of this method wherever possible for performance reasons. 2804 * 2805 * <p> 2806 * Useful when paginating results. Returns a maximum of <code>end - 2807 * start</code> instances. <code>start</code> and <code>end</code> are not 2808 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2809 * refers to the first result in the set. Setting both <code>start</code> 2810 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2811 * result set. 2812 * </p> 2813 * 2814 * @param groupId the primary key of the group (optionally <code>0</code>) 2815 * @param folderId the primary key of the web content article folder 2816 * @param status the web content article's workflow status. For more 2817 information see {@link WorkflowConstants} for constants starting 2818 with the "STATUS_" prefix. 2819 * @param start the lower bound of the range of web content articles to 2820 return 2821 * @param end the upper bound of the range of web content articles to 2822 return (not inclusive) 2823 * @return the matching web content articles 2824 */ 2825 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2826 long groupId, long folderId, int status, int start, int end) { 2827 return getService().search(groupId, folderId, status, start, end); 2828 } 2829 2830 /** 2831 * Returns a range of all the web content articles matching the parameters 2832 * without using the indexer. It is preferable to use the indexed version 2833 * {@link #search(long, long, long, int, int, int)} instead of this method 2834 * wherever possible for performance reasons. 2835 * 2836 * <p> 2837 * Useful when paginating results. Returns a maximum of <code>end - 2838 * start</code> instances. <code>start</code> and <code>end</code> are not 2839 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2840 * refers to the first result in the set. Setting both <code>start</code> 2841 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2842 * result set. 2843 * </p> 2844 * 2845 * @param groupId the primary key of the group (optionally <code>0</code>) 2846 * @param folderIds the primary keys of the web content article folders 2847 (optionally {@link java.util.Collections#EMPTY_LIST}) 2848 * @param status the web content article's workflow status. For more 2849 information see {@link WorkflowConstants} for constants starting 2850 with the "STATUS_" prefix. 2851 * @param start the lower bound of the range of web content articles to 2852 return 2853 * @param end the upper bound of the range of web content articles to 2854 return (not inclusive) 2855 * @return the matching web content articles 2856 */ 2857 public static java.util.List<com.liferay.portlet.journal.model.JournalArticle> search( 2858 long groupId, java.util.List<java.lang.Long> folderIds, int status, 2859 int start, int end) { 2860 return getService().search(groupId, folderIds, status, start, end); 2861 } 2862 2863 /** 2864 * Returns a range of all the web content articles matching the group, 2865 * creator, and status using the indexer. It is preferable to use this 2866 * method instead of the non-indexed version whenever possible for 2867 * performance reasons. 2868 * 2869 * <p> 2870 * Useful when paginating results. Returns a maximum of <code>end - 2871 * start</code> instances. <code>start</code> and <code>end</code> are not 2872 * primary keys, they are indexes in the result set. Thus, <code>0</code> 2873 * refers to the first result in the set. Setting both <code>start</code> 2874 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 2875 * result set. 2876 * </p> 2877 * 2878 * @param groupId the primary key of the group (optionally <code>0</code>) 2879 * @param userId the primary key of the user searching for web content 2880 articles 2881 * @param creatorUserId the primary key of the web content article's 2882 creator 2883 * @param status the web content article's workflow status. For more 2884 information see {@link WorkflowConstants} for constants starting 2885 with the "STATUS_" prefix. 2886 * @param start the lower bound of the range of web content articles to 2887 return 2888 * @param end the upper bound of the range of web content articles to 2889 return (not inclusive) 2890 * @return the matching web content articles 2891 * @throws PortalException if a portal exception occurred 2892 */ 2893 public static com.liferay.portal.kernel.search.Hits search(long groupId, 2894 long userId, long creatorUserId, int status, int start, int end) 2895 throws com.liferay.portal.kernel.exception.PortalException { 2896 return getService() 2897 .search(groupId, userId, creatorUserId, status, start, end); 2898 } 2899 2900 /** 2901 * Returns the number of web content articles matching the parameters, 2902 * including keyword parameters for article ID, title, description, and 2903 * content, a DDM structure key parameter, a DDM template key parameter, and 2904 * an AND operator switch. 2905 * 2906 * @param companyId the primary key of the web content article's company 2907 * @param groupId the primary key of the group (optionally <code>0</code>) 2908 * @param folderIds the primary keys of the web content article folders 2909 (optionally {@link java.util.Collections#EMPTY_LIST}) 2910 * @param classNameId the primary key of the DDMStructure class if the web 2911 content article is related to a DDM structure, the primary key of 2912 the class name associated with the article, or {@link 2913 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2914 * @param articleId the article ID keywords (space separated, optionally 2915 <code>null</code>) 2916 * @param version the web content article's version (optionally 2917 <code>null</code>) 2918 * @param title the title keywords (space separated, optionally 2919 <code>null</code>) 2920 * @param description the description keywords (space separated, optionally 2921 <code>null</code>) 2922 * @param content the content keywords (space separated, optionally 2923 <code>null</code>) 2924 * @param ddmStructureKey the primary key of the web content article's DDM 2925 structure, if the article is related to a DDM structure, or 2926 <code>null</code> otherwise 2927 * @param ddmTemplateKey the primary key of the web content article's DDM 2928 template 2929 * @param displayDateGT the date after which a matching web content 2930 article's display date must be after (optionally 2931 <code>null</code>) 2932 * @param displayDateLT the date before which a matching web content 2933 article's display date must be before (optionally 2934 <code>null</code>) 2935 * @param status the web content article's workflow status. For more 2936 information see {@link WorkflowConstants} for constants starting 2937 with the "STATUS_" prefix. 2938 * @param reviewDate the web content article's scheduled review date 2939 (optionally <code>null</code>) 2940 * @param andOperator whether every field must match its value or keywords, 2941 or just one field must match. Group, folder IDs, class name ID, 2942 and status must all match their values. 2943 * @return the number of matching web content articles 2944 */ 2945 public static int searchCount(long companyId, long groupId, 2946 java.util.List<java.lang.Long> folderIds, long classNameId, 2947 java.lang.String articleId, java.lang.Double version, 2948 java.lang.String title, java.lang.String description, 2949 java.lang.String content, java.lang.String ddmStructureKey, 2950 java.lang.String ddmTemplateKey, java.util.Date displayDateGT, 2951 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 2952 boolean andOperator) { 2953 return getService() 2954 .searchCount(companyId, groupId, folderIds, classNameId, 2955 articleId, version, title, description, content, ddmStructureKey, 2956 ddmTemplateKey, displayDateGT, displayDateLT, status, reviewDate, 2957 andOperator); 2958 } 2959 2960 /** 2961 * Returns the number of web content articles matching the parameters, 2962 * including keyword parameters for article ID, title, description, and 2963 * content, a DDM structure keys (plural) parameter, a DDM template keys 2964 * (plural) parameter, and an AND operator switch. 2965 * 2966 * @param companyId the primary key of the web content article's company 2967 * @param groupId the primary key of the group (optionally <code>0</code>) 2968 * @param folderIds the primary keys of the web content article folders 2969 (optionally {@link java.util.Collections#EMPTY_LIST}) 2970 * @param classNameId the primary key of the DDMStructure class if the web 2971 content article is related to a DDM structure, the primary key of 2972 the class name associated with the article, or {@link 2973 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 2974 * @param articleId the article ID keywords (space separated, optionally 2975 <code>null</code>) 2976 * @param version the web content article's version (optionally 2977 <code>null</code>) 2978 * @param title the title keywords (space separated, optionally 2979 <code>null</code>) 2980 * @param description the description keywords (space separated, optionally 2981 <code>null</code>) 2982 * @param content the content keywords (space separated, optionally 2983 <code>null</code>) 2984 * @param ddmStructureKeys the primary keys of the web content article's 2985 DDM structures, if the article is related to a DDM structure, or 2986 <code>null</code> otherwise 2987 * @param ddmTemplateKeys the primary keys of the web content article's DDM 2988 templates (originally <code>null</code>). If the articles are 2989 related to a DDM structure, the template's structure must match 2990 it. 2991 * @param displayDateGT the date after which a matching web content 2992 article's display date must be after (optionally 2993 <code>null</code>) 2994 * @param displayDateLT the date before which a matching web content 2995 article's display date must be before (optionally 2996 <code>null</code>) 2997 * @param status the web content article's workflow status. For more 2998 information see {@link WorkflowConstants} for constants starting 2999 with the "STATUS_" prefix. 3000 * @param reviewDate the web content article's scheduled review date 3001 (optionally <code>null</code>) 3002 * @param andOperator whether every field must match its value or keywords, 3003 or just one field must match. Group, folder IDs, class name ID, 3004 and status must all match their values. 3005 * @return the number of matching web content articles 3006 */ 3007 public static int searchCount(long companyId, long groupId, 3008 java.util.List<java.lang.Long> folderIds, long classNameId, 3009 java.lang.String articleId, java.lang.Double version, 3010 java.lang.String title, java.lang.String description, 3011 java.lang.String content, java.lang.String[] ddmStructureKeys, 3012 java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, 3013 java.util.Date displayDateLT, int status, java.util.Date reviewDate, 3014 boolean andOperator) { 3015 return getService() 3016 .searchCount(companyId, groupId, folderIds, classNameId, 3017 articleId, version, title, description, content, ddmStructureKeys, 3018 ddmTemplateKeys, displayDateGT, displayDateLT, status, reviewDate, 3019 andOperator); 3020 } 3021 3022 /** 3023 * Returns the number of web content articles matching the parameters, 3024 * including a keywords parameter for matching with the article's ID, title, 3025 * description, and content, a DDM structure key parameter, and a DDM 3026 * template key parameter. 3027 * 3028 * @param companyId the primary key of the web content article's company 3029 * @param groupId the primary key of the group (optionally <code>0</code>) 3030 * @param folderIds the primary keys of the web content article folders 3031 (optionally {@link java.util.Collections#EMPTY_LIST}) 3032 * @param classNameId the primary key of the DDMStructure class if the web 3033 content article is related to a DDM structure, the primary key of 3034 the class name associated with the article, or {@link 3035 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 3036 * @param keywords the keywords (space separated), which may occur in the 3037 web content article ID, title, description, or content 3038 (optionally <code>null</code>). If the keywords value is not 3039 <code>null</code>, the search uses the OR operator in connecting 3040 query criteria; otherwise it uses the AND operator. 3041 * @param version the web content article's version (optionally 3042 <code>null</code>) 3043 * @param ddmStructureKey the primary key of the web content article's DDM 3044 structure, if the article is related to a DDM structure, or 3045 <code>null</code> otherwise 3046 * @param ddmTemplateKey the primary key of the web content article's DDM 3047 template 3048 * @param displayDateGT the date after which a matching web content 3049 article's display date must be after (optionally 3050 <code>null</code>) 3051 * @param displayDateLT the date before which a matching web content 3052 article's display date must be before (optionally 3053 <code>null</code>) 3054 * @param status the web content article's workflow status. For more 3055 information see {@link WorkflowConstants} for constants starting 3056 with the "STATUS_" prefix. 3057 * @param reviewDate the web content article's scheduled review date 3058 (optionally <code>null</code>) 3059 * @return the number of matching web content articles 3060 */ 3061 public static int searchCount(long companyId, long groupId, 3062 java.util.List<java.lang.Long> folderIds, long classNameId, 3063 java.lang.String keywords, java.lang.Double version, 3064 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 3065 java.util.Date displayDateGT, java.util.Date displayDateLT, int status, 3066 java.util.Date reviewDate) { 3067 return getService() 3068 .searchCount(companyId, groupId, folderIds, classNameId, 3069 keywords, version, ddmStructureKey, ddmTemplateKey, displayDateGT, 3070 displayDateLT, status, reviewDate); 3071 } 3072 3073 /** 3074 * Returns the number of web content articles matching the group, folder, 3075 * and status. 3076 * 3077 * @param groupId the primary key of the group (optionally <code>0</code>) 3078 * @param folderId the primary key of the web content article folder 3079 * @param status the web content article's workflow status. For more 3080 information see {@link WorkflowConstants} for constants starting 3081 with the "STATUS_" prefix. 3082 * @return the number of matching web content articles 3083 */ 3084 public static int searchCount(long groupId, long folderId, int status) { 3085 return getService().searchCount(groupId, folderId, status); 3086 } 3087 3088 /** 3089 * Returns the number of web content articles matching the group, folders, 3090 * and status. 3091 * 3092 * @param groupId the primary key of the group (optionally <code>0</code>) 3093 * @param folderIds the primary keys of the web content article folders 3094 (optionally {@link java.util.Collections#EMPTY_LIST}) 3095 * @param status the web content article's workflow status. For more 3096 information see {@link WorkflowConstants} for constants starting 3097 with the "STATUS_" prefix. 3098 * @return the number of matching web content articles 3099 */ 3100 public static int searchCount(long groupId, 3101 java.util.List<java.lang.Long> folderIds, int status) { 3102 return getService().searchCount(groupId, folderIds, status); 3103 } 3104 3105 /** 3106 * Returns a {@link BaseModelSearchResult} containing the total number of 3107 * hits and an ordered range of all the web content articles matching the 3108 * parameters using the indexer, including keyword parameters for article 3109 * ID, title, description, or content, a DDM structure key parameter, a DDM 3110 * template key parameter, an AND operator switch, and parameters for type, 3111 * status, and a finder hash map. It is preferable to use this method 3112 * instead of the non-indexed version whenever possible for performance 3113 * reasons. 3114 * 3115 * <p> 3116 * The <code>start</code> and <code>end</code> parameters only affect the 3117 * amount of web content articles returned as results, not the total number 3118 * of hits. 3119 * </p> 3120 * 3121 * <p> 3122 * Useful when paginating results. Returns a maximum of <code>end - 3123 * start</code> instances. <code>start</code> and <code>end</code> are not 3124 * primary keys, they are indexes in the result set. Thus, <code>0</code> 3125 * refers to the first result in the set. Setting both <code>start</code> 3126 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 3127 * result set. 3128 * </p> 3129 * 3130 * @param companyId the primary key of the web content article's company 3131 * @param groupId the primary key of the group (optionally <code>0</code>) 3132 * @param folderIds the primary keys of the web content article folders 3133 (optionally {@link java.util.Collections#EMPTY_LIST}) 3134 * @param classNameId the primary key of the DDMStructure class, the 3135 primary key of the class name associated with the article, or 3136 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 3137 * @param articleId the article ID keywords (space separated, optionally 3138 <code>null</code>) 3139 * @param title the title keywords (space separated, optionally 3140 <code>null</code>) 3141 * @param description the description keywords (space separated, optionally 3142 <code>null</code>) 3143 * @param content the content keywords (space separated, optionally 3144 <code>null</code>) 3145 * @param status the web content article's workflow status. For more 3146 information see {@link WorkflowConstants} for constants starting 3147 with the "STATUS_" prefix. 3148 * @param ddmStructureKey the primary key of the web content article's DDM 3149 structure 3150 * @param ddmTemplateKey the primary key of the web content article's DDM 3151 template 3152 * @param params the finder parameters (optionally <code>null</code>). The 3153 <code>includeDiscussions</code> parameter can be set to 3154 <code>true</code> to search for the keywords in the web content 3155 article discussions. 3156 * @param andSearch whether every field must match its value or keywords, 3157 or just one field must match 3158 * @param start the lower bound of the range of web content articles to 3159 return 3160 * @param end the upper bound of the range of web content articles to 3161 return (not inclusive) 3162 * @param sort the field, type, and direction by which to sort (optionally 3163 <code>null</code>) 3164 * @return a {@link BaseModelSearchResult} containing the total number of 3165 hits and an ordered range of all the matching web content 3166 articles ordered by <code>sort</code> 3167 * @throws PortalException if a portal exception occurred 3168 */ 3169 public static com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.journal.model.JournalArticle> searchJournalArticles( 3170 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 3171 long classNameId, java.lang.String articleId, java.lang.String title, 3172 java.lang.String description, java.lang.String content, int status, 3173 java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, 3174 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 3175 boolean andSearch, int start, int end, 3176 com.liferay.portal.kernel.search.Sort sort) 3177 throws com.liferay.portal.kernel.exception.PortalException { 3178 return getService() 3179 .searchJournalArticles(companyId, groupId, folderIds, 3180 classNameId, articleId, title, description, content, status, 3181 ddmStructureKey, ddmTemplateKey, params, andSearch, start, end, sort); 3182 } 3183 3184 /** 3185 * Returns a {@link BaseModelSearchResult} containing the total number of 3186 * hits and an ordered range of all the web content articles matching the 3187 * parameters using the indexer, including a keywords parameter for matching 3188 * an article's ID, title, description, or content, a DDM structure key 3189 * parameter, a DDM template key parameter, and a finder hash map parameter. 3190 * It is preferable to use this method instead of the non-indexed version 3191 * whenever possible for performance reasons. 3192 * 3193 * <p> 3194 * The <code>start</code> and <code>end</code> parameters only affect the 3195 * amount of web content articles returned as results, not the total number 3196 * of hits. 3197 * </p> 3198 * 3199 * <p> 3200 * Useful when paginating results. Returns a maximum of <code>end - 3201 * start</code> instances. <code>start</code> and <code>end</code> are not 3202 * primary keys, they are indexes in the result set. Thus, <code>0</code> 3203 * refers to the first result in the set. Setting both <code>start</code> 3204 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 3205 * result set. 3206 * </p> 3207 * 3208 * @param companyId the primary key of the web content article's company 3209 * @param groupId the primary key of the group (optionally <code>0</code>) 3210 * @param folderIds the primary keys of the web content article folders 3211 (optionally {@link java.util.Collections#EMPTY_LIST}) 3212 * @param classNameId the primary key of the DDMStructure class, the 3213 primary key of the class name associated with the article, or 3214 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 3215 * @param ddmStructureKey the primary key of the web content article's DDM 3216 structure 3217 * @param ddmTemplateKey the primary key of the web content article's DDM 3218 template 3219 * @param keywords the keywords (space separated), which may occur in the 3220 web content article ID, title, description, or content 3221 (optionally <code>null</code>). If the keywords value is not 3222 <code>null</code>, the search uses the OR operator in connecting 3223 query criteria; otherwise it uses the AND operator. 3224 * @param params the finder parameters (optionally <code>null</code>) 3225 * @param start the lower bound of the range of web content articles to 3226 return 3227 * @param end the upper bound of the range of web content articles to 3228 return (not inclusive) 3229 * @param sort the field, type, and direction by which to sort (optionally 3230 <code>null</code>) 3231 * @return a {@link BaseModelSearchResult} containing the total number of 3232 hits and an ordered range of all the matching web content 3233 articles ordered by <code>sort</code> 3234 * @throws PortalException if a portal exception occurred 3235 */ 3236 public static com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.journal.model.JournalArticle> searchJournalArticles( 3237 long companyId, long groupId, java.util.List<java.lang.Long> folderIds, 3238 long classNameId, java.lang.String ddmStructureKey, 3239 java.lang.String ddmTemplateKey, java.lang.String keywords, 3240 java.util.LinkedHashMap<java.lang.String, java.lang.Object> params, 3241 int start, int end, com.liferay.portal.kernel.search.Sort sort) 3242 throws com.liferay.portal.kernel.exception.PortalException { 3243 return getService() 3244 .searchJournalArticles(companyId, groupId, folderIds, 3245 classNameId, ddmStructureKey, ddmTemplateKey, keywords, params, 3246 start, end, sort); 3247 } 3248 3249 /** 3250 * Returns a {@link BaseModelSearchResult} containing the total number of 3251 * hits and an ordered range of all the web content articles matching the 3252 * parameters using the indexer, including the web content article's creator 3253 * ID and status. It is preferable to use this method instead of the 3254 * non-indexed version whenever possible for performance reasons. 3255 * 3256 * <p> 3257 * The <code>start</code> and <code>end</code> parameters only affect the 3258 * amount of web content articles returned as results, not the total number 3259 * of hits. 3260 * </p> 3261 * 3262 * <p> 3263 * Useful when paginating results. Returns a maximum of <code>end - 3264 * start</code> instances. <code>start</code> and <code>end</code> are not 3265 * primary keys, they are indexes in the result set. Thus, <code>0</code> 3266 * refers to the first result in the set. Setting both <code>start</code> 3267 * and <code>end</code> to {@link QueryUtil#ALL_POS} will return the full 3268 * result set. 3269 * </p> 3270 * 3271 * @param groupId the primary key of the group (optionally <code>0</code>) 3272 * @param userId the primary key of the user searching for web content 3273 articles 3274 * @param creatorUserId the primary key of the web content article's 3275 creator 3276 * @param status the web content article's workflow status. For more 3277 information see {@link WorkflowConstants} for constants starting 3278 with the "STATUS_" prefix. 3279 * @param start the lower bound of the range of web content articles to 3280 return 3281 * @param end the upper bound of the range of web content articles to 3282 return (not inclusive) 3283 * @return a {@link BaseModelSearchResult} containing the total number of 3284 hits and an ordered range of all the matching web content 3285 articles ordered by <code>sort</code> 3286 * @throws PortalException if a portal exception occurred 3287 */ 3288 public static com.liferay.portal.kernel.search.BaseModelSearchResult<com.liferay.portlet.journal.model.JournalArticle> searchJournalArticles( 3289 long groupId, long userId, long creatorUserId, int status, int start, 3290 int end) throws com.liferay.portal.kernel.exception.PortalException { 3291 return getService() 3292 .searchJournalArticles(groupId, userId, creatorUserId, 3293 status, start, end); 3294 } 3295 3296 /** 3297 * Sets the Spring bean ID for this bean. 3298 * 3299 * @param beanIdentifier the Spring bean ID for this bean 3300 */ 3301 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 3302 getService().setBeanIdentifier(beanIdentifier); 3303 } 3304 3305 public static void setTreePaths(long folderId, java.lang.String treePath, 3306 boolean reindex) 3307 throws com.liferay.portal.kernel.exception.PortalException { 3308 getService().setTreePaths(folderId, treePath, reindex); 3309 } 3310 3311 /** 3312 * Subscribes the user to changes in elements that belong to the web content 3313 * article's DDM structure. 3314 * 3315 * @param groupId the primary key of the folder's group 3316 * @param userId the primary key of the user to be subscribed 3317 * @param ddmStructureId the primary key of the structure to subscribe to 3318 * @throws PortalException if a matching user or group could not be found 3319 */ 3320 public static void subscribeStructure(long groupId, long userId, 3321 long ddmStructureId) 3322 throws com.liferay.portal.kernel.exception.PortalException { 3323 getService().subscribeStructure(groupId, userId, ddmStructureId); 3324 } 3325 3326 /** 3327 * Unsubscribes the user from changes in elements that belong to the web 3328 * content article's DDM structure. 3329 * 3330 * @param groupId the primary key of the folder's group 3331 * @param userId the primary key of the user to be subscribed 3332 * @param ddmStructureId the primary key of the structure to subscribe to 3333 * @throws PortalException if a matching user or subscription could not be 3334 found 3335 */ 3336 public static void unsubscribeStructure(long groupId, long userId, 3337 long ddmStructureId) 3338 throws com.liferay.portal.kernel.exception.PortalException { 3339 getService().unsubscribeStructure(groupId, userId, ddmStructureId); 3340 } 3341 3342 /** 3343 * Updates the web content article matching the version, replacing its 3344 * folder and content. 3345 * 3346 * @param userId the primary key of the user updating the web content 3347 article 3348 * @param groupId the primary key of the web content article's group 3349 * @param folderId the primary key of the web content article folder 3350 * @param articleId the primary key of the web content article 3351 * @param version the web content article's version 3352 * @param content the HTML content wrapped in XML. For more information, 3353 see the content example in the class description for {@link 3354 JournalArticleLocalServiceImpl}. 3355 * @param serviceContext the service context to be applied. Can set the 3356 modification date, expando bridge attributes, asset category IDs, 3357 asset tag names, asset link entry IDs, workflow actions, the and 3358 "urlTitle" attributes, and can set whether to add the default 3359 command update for the web content article. With respect to 3360 social activities, by setting the service context's command to 3361 {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the 3362 invocation is considered a web content update activity; otherwise 3363 it is considered a web content add activity. 3364 * @return the updated web content article 3365 * @throws PortalException if a user with the primary key or a matching web 3366 content article could not be found, or if a portal exception 3367 occurred 3368 */ 3369 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 3370 long userId, long groupId, long folderId, java.lang.String articleId, 3371 double version, java.lang.String content, 3372 com.liferay.portal.service.ServiceContext serviceContext) 3373 throws com.liferay.portal.kernel.exception.PortalException { 3374 return getService() 3375 .updateArticle(userId, groupId, folderId, articleId, 3376 version, content, serviceContext); 3377 } 3378 3379 /** 3380 * Updates the web content article with additional parameters. 3381 * 3382 * @param userId the primary key of the user updating the web content 3383 article 3384 * @param groupId the primary key of the web content article's group 3385 * @param folderId the primary key of the web content article folder 3386 * @param articleId the primary key of the web content article 3387 * @param version the web content article's version 3388 * @param titleMap the web content article's locales and localized titles 3389 * @param descriptionMap the web content article's locales and localized 3390 descriptions 3391 * @param content the HTML content wrapped in XML. For more information, 3392 see the content example in the class description for {@link 3393 JournalArticleLocalServiceImpl}. 3394 * @param ddmStructureKey the primary key of the web content article's DDM 3395 structure, if the article is related to a DDM structure, or 3396 <code>null</code> otherwise 3397 * @param ddmTemplateKey the primary key of the web content article's DDM 3398 template 3399 * @param layoutUuid the unique string identifying the web content 3400 article's display page 3401 * @param displayDateMonth the month the web content article is set to 3402 display 3403 * @param displayDateDay the calendar day the web content article is set to 3404 display 3405 * @param displayDateYear the year the web content article is set to 3406 display 3407 * @param displayDateHour the hour the web content article is set to 3408 display 3409 * @param displayDateMinute the minute the web content article is set to 3410 display 3411 * @param expirationDateMonth the month the web content article is set to 3412 expire 3413 * @param expirationDateDay the calendar day the web content article is set 3414 to expire 3415 * @param expirationDateYear the year the web content article is set to 3416 expire 3417 * @param expirationDateHour the hour the web content article is set to 3418 expire 3419 * @param expirationDateMinute the minute the web content article is set to 3420 expire 3421 * @param neverExpire whether the web content article is not set to auto 3422 expire 3423 * @param reviewDateMonth the month the web content article is set for 3424 review 3425 * @param reviewDateDay the calendar day the web content article is set for 3426 review 3427 * @param reviewDateYear the year the web content article is set for review 3428 * @param reviewDateHour the hour the web content article is set for review 3429 * @param reviewDateMinute the minute the web content article is set for 3430 review 3431 * @param neverReview whether the web content article is not set for review 3432 * @param indexable whether the web content is searchable 3433 * @param smallImage whether to update web content article's a small image. 3434 A file must be passed in as <code>smallImageFile</code> value, 3435 otherwise the current small image is deleted. 3436 * @param smallImageURL the web content article's small image URL 3437 (optionally <code>null</code>) 3438 * @param smallImageFile the web content article's new small image file 3439 (optionally <code>null</code>). Must pass in 3440 <code>smallImage</code> value of <code>true</code> to replace the 3441 article's small image file. 3442 * @param images the web content's images (optionally <code>null</code>) 3443 * @param articleURL the web content article's accessible URL (optionally 3444 <code>null</code>) 3445 * @param serviceContext the service context to be applied. Can set the 3446 modification date, expando bridge attributes, asset category IDs, 3447 asset tag names, asset link entry IDs, workflow actions, the and 3448 "urlTitle" attributes, and can set whether to add the default 3449 command update for the web content article. With respect to 3450 social activities, by setting the service context's command to 3451 {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the 3452 invocation is considered a web content update activity; otherwise 3453 it is considered a web content add activity. 3454 * @return the updated web content article 3455 * @throws PortalException if a user with the primary key or a matching web 3456 content article could not be found, or if a portal exception 3457 occurred 3458 */ 3459 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 3460 long userId, long groupId, long folderId, java.lang.String articleId, 3461 double version, 3462 java.util.Map<java.util.Locale, java.lang.String> titleMap, 3463 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 3464 java.lang.String content, java.lang.String ddmStructureKey, 3465 java.lang.String ddmTemplateKey, java.lang.String layoutUuid, 3466 int displayDateMonth, int displayDateDay, int displayDateYear, 3467 int displayDateHour, int displayDateMinute, int expirationDateMonth, 3468 int expirationDateDay, int expirationDateYear, int expirationDateHour, 3469 int expirationDateMinute, boolean neverExpire, int reviewDateMonth, 3470 int reviewDateDay, int reviewDateYear, int reviewDateHour, 3471 int reviewDateMinute, boolean neverReview, boolean indexable, 3472 boolean smallImage, java.lang.String smallImageURL, 3473 java.io.File smallImageFile, 3474 java.util.Map<java.lang.String, byte[]> images, 3475 java.lang.String articleURL, 3476 com.liferay.portal.service.ServiceContext serviceContext) 3477 throws com.liferay.portal.kernel.exception.PortalException { 3478 return getService() 3479 .updateArticle(userId, groupId, folderId, articleId, 3480 version, titleMap, descriptionMap, content, ddmStructureKey, 3481 ddmTemplateKey, layoutUuid, displayDateMonth, displayDateDay, 3482 displayDateYear, displayDateHour, displayDateMinute, 3483 expirationDateMonth, expirationDateDay, expirationDateYear, 3484 expirationDateHour, expirationDateMinute, neverExpire, 3485 reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour, 3486 reviewDateMinute, neverReview, indexable, smallImage, 3487 smallImageURL, smallImageFile, images, articleURL, serviceContext); 3488 } 3489 3490 /** 3491 * Updates the web content article matching the version, replacing its 3492 * folder, title, description, content, and layout UUID. 3493 * 3494 * @param userId the primary key of the user updating the web content 3495 article 3496 * @param groupId the primary key of the web content article's group 3497 * @param folderId the primary key of the web content article folder 3498 * @param articleId the primary key of the web content article 3499 * @param version the web content article's version 3500 * @param titleMap the web content article's locales and localized titles 3501 * @param descriptionMap the web content article's locales and localized 3502 descriptions 3503 * @param content the HTML content wrapped in XML. For more information, 3504 see the content example in the class description for {@link 3505 JournalArticleLocalServiceImpl}. 3506 * @param layoutUuid the unique string identifying the web content 3507 article's display page 3508 * @param serviceContext the service context to be applied. Can set the 3509 modification date, expando bridge attributes, asset category IDs, 3510 asset tag names, asset link entry IDs, workflow actions, the and 3511 "urlTitle" attributes, and can set whether to add the default 3512 command update for the web content article. With respect to 3513 social activities, by setting the service context's command to 3514 {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the 3515 invocation is considered a web content update activity; otherwise 3516 it is considered a web content add activity. 3517 * @return the updated web content article 3518 * @throws PortalException if a user with the primary key or a matching web 3519 content article could not be found, or if a portal exception 3520 occurred 3521 */ 3522 public static com.liferay.portlet.journal.model.JournalArticle updateArticle( 3523 long userId, long groupId, long folderId, java.lang.String articleId, 3524 double version, 3525 java.util.Map<java.util.Locale, java.lang.String> titleMap, 3526 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 3527 java.lang.String content, java.lang.String layoutUuid, 3528 com.liferay.portal.service.ServiceContext serviceContext) 3529 throws com.liferay.portal.kernel.exception.PortalException { 3530 return getService() 3531 .updateArticle(userId, groupId, folderId, articleId, 3532 version, titleMap, descriptionMap, content, layoutUuid, 3533 serviceContext); 3534 } 3535 3536 /** 3537 * @deprecated As of 6.2.0, replaced by {@link 3538 #updateArticleTranslation(long, String, double, Locale, 3539 String, String, String, Map, ServiceContext)} 3540 */ 3541 @Deprecated 3542 public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 3543 long groupId, java.lang.String articleId, double version, 3544 java.util.Locale locale, java.lang.String title, 3545 java.lang.String description, java.lang.String content, 3546 java.util.Map<java.lang.String, byte[]> images) 3547 throws com.liferay.portal.kernel.exception.PortalException { 3548 return getService() 3549 .updateArticleTranslation(groupId, articleId, version, 3550 locale, title, description, content, images); 3551 } 3552 3553 /** 3554 * Updates the translation of the web content article. 3555 * 3556 * @param groupId the primary key of the web content article's group 3557 * @param articleId the primary key of the web content article 3558 * @param version the web content article's version 3559 * @param locale the locale of the web content article's display template 3560 * @param title the translated web content article title 3561 * @param description the translated web content article description 3562 * @param content the HTML content wrapped in XML. For more information, 3563 see the content example in the class description for {@link 3564 JournalArticleLocalServiceImpl}. 3565 * @param images the web content's images 3566 * @param serviceContext the service context to be applied. Can set the 3567 modification date and "urlTitle" attribute for the web content 3568 article. 3569 * @return the updated web content article 3570 * @throws PortalException if a user with the primary key or a matching web 3571 content article could not be found, or if a portal exception 3572 occurred 3573 */ 3574 public static com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( 3575 long groupId, java.lang.String articleId, double version, 3576 java.util.Locale locale, java.lang.String title, 3577 java.lang.String description, java.lang.String content, 3578 java.util.Map<java.lang.String, byte[]> images, 3579 com.liferay.portal.service.ServiceContext serviceContext) 3580 throws com.liferay.portal.kernel.exception.PortalException { 3581 return getService() 3582 .updateArticleTranslation(groupId, articleId, version, 3583 locale, title, description, content, images, serviceContext); 3584 } 3585 3586 /** 3587 * Updates the web content article's asset with the new asset categories, 3588 * tag names, and link entries, removing and adding them as necessary. 3589 * 3590 * @param userId the primary key of the user updating the web content 3591 article's asset 3592 * @param article the web content article 3593 * @param assetCategoryIds the primary keys of the new asset categories 3594 * @param assetTagNames the new asset tag names 3595 * @param assetLinkEntryIds the primary keys of the new asset link entries 3596 * @throws PortalException if a portal exception occurred 3597 */ 3598 public static void updateAsset(long userId, 3599 com.liferay.portlet.journal.model.JournalArticle article, 3600 long[] assetCategoryIds, java.lang.String[] assetTagNames, 3601 long[] assetLinkEntryIds) 3602 throws com.liferay.portal.kernel.exception.PortalException { 3603 getService() 3604 .updateAsset(userId, article, assetCategoryIds, assetTagNames, 3605 assetLinkEntryIds); 3606 } 3607 3608 /** 3609 * Updates the web content article matching the group, article ID, and 3610 * version, replacing its content. 3611 * 3612 * @param groupId the primary key of the web content article's group 3613 * @param articleId the primary key of the web content article 3614 * @param version the web content article's version 3615 * @param content the HTML content wrapped in XML. For more information, 3616 see the content example in the class description for {@link 3617 JournalArticleLocalServiceImpl}. 3618 * @return the updated web content article 3619 * @throws PortalException if a matching web content article could not be 3620 found 3621 */ 3622 public static com.liferay.portlet.journal.model.JournalArticle updateContent( 3623 long groupId, java.lang.String articleId, double version, 3624 java.lang.String content) 3625 throws com.liferay.portal.kernel.exception.PortalException { 3626 return getService().updateContent(groupId, articleId, version, content); 3627 } 3628 3629 /** 3630 * Updates the web content articles matching the group, class name ID, and 3631 * DDM template key, replacing the DDM template key with a new one. 3632 * 3633 * @param groupId the primary key of the web content article's group 3634 * @param classNameId the primary key of the DDMStructure class if the web 3635 content article is related to a DDM structure, the primary key of 3636 the class name associated with the article, or {@link 3637 JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise 3638 * @param oldDDMTemplateKey the primary key of the web content article's old 3639 DDM template 3640 * @param newDDMTemplateKey the primary key of the web content article's new 3641 DDM template 3642 */ 3643 public static void updateDDMTemplateKey(long groupId, long classNameId, 3644 java.lang.String oldDDMTemplateKey, java.lang.String newDDMTemplateKey) { 3645 getService() 3646 .updateDDMTemplateKey(groupId, classNameId, oldDDMTemplateKey, 3647 newDDMTemplateKey); 3648 } 3649 3650 /** 3651 * Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 3652 * 3653 * @param journalArticle the journal article 3654 * @return the journal article that was updated 3655 */ 3656 public static com.liferay.portlet.journal.model.JournalArticle updateJournalArticle( 3657 com.liferay.portlet.journal.model.JournalArticle journalArticle) { 3658 return getService().updateJournalArticle(journalArticle); 3659 } 3660 3661 /** 3662 * Updates the workflow status of the web content article. 3663 * 3664 * @param userId the primary key of the user updating the web content 3665 article's status 3666 * @param article the web content article 3667 * @param status the web content article's workflow status. For more 3668 information see {@link WorkflowConstants} for constants starting 3669 with the "STATUS_" prefix. 3670 * @param articleURL the web content article's accessible URL 3671 * @param serviceContext the service context to be applied. Can set the 3672 modification date, status date, and portlet preferences. With 3673 respect to social activities, by setting the service context's 3674 command to {@link 3675 com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation 3676 is considered a web content update activity; otherwise it is 3677 considered a web content add activity. 3678 * @param workflowContext the web content article's configured workflow 3679 context 3680 * @return the updated web content article 3681 * @throws PortalException if a portal exception occurred 3682 */ 3683 public static com.liferay.portlet.journal.model.JournalArticle updateStatus( 3684 long userId, com.liferay.portlet.journal.model.JournalArticle article, 3685 int status, java.lang.String articleURL, 3686 com.liferay.portal.service.ServiceContext serviceContext, 3687 java.util.Map<java.lang.String, java.io.Serializable> workflowContext) 3688 throws com.liferay.portal.kernel.exception.PortalException { 3689 return getService() 3690 .updateStatus(userId, article, status, articleURL, 3691 serviceContext, workflowContext); 3692 } 3693 3694 /** 3695 * Updates the workflow status of the web content article matching the class 3696 * PK. 3697 * 3698 * @param userId the primary key of the user updating the web content 3699 article's status 3700 * @param classPK the primary key of the DDM structure, if the web content 3701 article is related to a DDM structure, the primary key of the 3702 class associated with the article, or <code>0</code> otherwise 3703 * @param status the web content article's workflow status. For more 3704 information see {@link WorkflowConstants} for constants starting 3705 with the "STATUS_" prefix. 3706 * @param workflowContext the web content article's configured workflow 3707 * @param serviceContext the service context to be applied. Can set the 3708 modification date, portlet preferences, and can set whether to 3709 add the default command update for the web content article. 3710 * @return the updated web content article 3711 * @throws PortalException if a matching web content article could not be 3712 found or if a portal exception occurred 3713 */ 3714 public static com.liferay.portlet.journal.model.JournalArticle updateStatus( 3715 long userId, long classPK, int status, 3716 java.util.Map<java.lang.String, java.io.Serializable> workflowContext, 3717 com.liferay.portal.service.ServiceContext serviceContext) 3718 throws com.liferay.portal.kernel.exception.PortalException { 3719 return getService() 3720 .updateStatus(userId, classPK, status, workflowContext, 3721 serviceContext); 3722 } 3723 3724 /** 3725 * Updates the workflow status of the web content article matching the 3726 * group, article ID, and version. 3727 * 3728 * @param userId the primary key of the user updating the web content 3729 article's status 3730 * @param groupId the primary key of the web content article's group 3731 * @param articleId the primary key of the web content article 3732 * @param version the web content article's version 3733 * @param status the web content article's workflow status. For more 3734 information see {@link WorkflowConstants} for constants starting 3735 with the "STATUS_" prefix. 3736 * @param articleURL the web content article's accessible URL 3737 * @param workflowContext the web content article's configured workflow 3738 * @param serviceContext the service context to be applied. Can set the 3739 modification date, portlet preferences, and can set whether to 3740 add the default command update for the web content article. 3741 * @return the updated web content article 3742 * @throws PortalException if a matching web content article could not be 3743 found or if a portal exception occurred 3744 */ 3745 public static com.liferay.portlet.journal.model.JournalArticle updateStatus( 3746 long userId, long groupId, java.lang.String articleId, double version, 3747 int status, java.lang.String articleURL, 3748 java.util.Map<java.lang.String, java.io.Serializable> workflowContext, 3749 com.liferay.portal.service.ServiceContext serviceContext) 3750 throws com.liferay.portal.kernel.exception.PortalException { 3751 return getService() 3752 .updateStatus(userId, groupId, articleId, version, status, 3753 articleURL, workflowContext, serviceContext); 3754 } 3755 3756 /** 3757 * Updates the web content articles matching the group, class name ID, and 3758 * DDM template key, replacing the DDM template key with a new one. 3759 * 3760 * @param groupId the primary key of the web content article's group 3761 * @param classNameId the primary key of the DDMStructure class if the 3762 web content article is related to a DDM structure, the 3763 primary key of the class name associated with the article, or 3764 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} 3765 otherwise 3766 * @param oldDDMTemplateKey the primary key of the web content 3767 article's old DDM template 3768 * @param newDDMTemplateKey the primary key of the web content 3769 article's new DDM template 3770 * @deprecated As of 7.0.0, replaced by {@link #updateDDMTemplateKey} 3771 */ 3772 @Deprecated 3773 public static void updateTemplateId(long groupId, long classNameId, 3774 java.lang.String oldDDMTemplateKey, java.lang.String newDDMTemplateKey) { 3775 getService() 3776 .updateTemplateId(groupId, classNameId, oldDDMTemplateKey, 3777 newDDMTemplateKey); 3778 } 3779 3780 public static JournalArticleLocalService getService() { 3781 if (_service == null) { 3782 _service = (JournalArticleLocalService)PortalBeanLocatorUtil.locate(JournalArticleLocalService.class.getName()); 3783 3784 ReferenceRegistry.registerReference(JournalArticleLocalServiceUtil.class, 3785 "_service"); 3786 } 3787 3788 return _service; 3789 } 3790 3791 /** 3792 * @deprecated As of 6.2.0 3793 */ 3794 @Deprecated 3795 public void setService(JournalArticleLocalService service) { 3796 } 3797 3798 private static JournalArticleLocalService _service; 3799 }