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