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