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