Class JournalArticleServiceWrapper

java.lang.Object
com.liferay.journal.service.JournalArticleServiceWrapper
All Implemented Interfaces:
JournalArticleService, com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.ServiceWrapper<JournalArticleService>

public class JournalArticleServiceWrapper extends Object implements JournalArticleService, com.liferay.portal.kernel.service.ServiceWrapper<JournalArticleService>
Provides a wrapper for JournalArticleService.
See Also:
Generated:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
     
  • Method Summary

    Modifier and Type
    Method
    Description
    addArticle(String externalReferenceCode, long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> friendlyURLMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds a web content article with additional parameters.
    addArticle(String externalReferenceCode, long groupId, long folderId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Adds a web content article.
    addArticleDefaultValues(long groupId, long classNameId, long classPK, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    copyArticle(long groupId, String sourceArticleId, String targetArticleId, boolean autoArticleId, double version)
    Copies the web content article matching the group, article ID, and version.
    void
    deleteArticle(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.
    void
    deleteArticle(long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved.
    void
    deleteArticleDefaultValues(long groupId, String articleId, long ddmStructureId)
     
    expireArticle(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Expires the web content article matching the group, article ID, and version.
    void
    expireArticle(long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Expires the web content article matching the group and article ID, expiring all of its versions if the journal.article.expire.all.versions portal property is true, otherwise expiring only its latest approved version.
    fetchArticle(long groupId, String articleId)
     
    fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode)
    Returns the latest web content article matching the group and the external reference code.
    getArticle(long id)
    Returns the web content article with the ID.
    getArticle(long groupId, String articleId)
    Returns the latest approved web content article, or the latest unapproved article if none are approved.
    getArticle(long groupId, String articleId, double version)
    Returns the web content article matching the group, article ID, and version.
    getArticle(long groupId, String className, long classPK)
    Returns the web content article matching the group, class name, and class PK.
    getArticleByUrlTitle(long groupId, String urlTitle)
    Returns the latest web content article that is approved, or the latest unapproved article if none are approved.
    getArticleContent(long groupId, String articleId, double version, String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
    Returns the web content from the web content article matching the group, article ID, and version.
    getArticleContent(long groupId, String articleId, String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
    Returns the latest web content from the web content article matching the group and article ID.
    getArticles(long groupId, long folderId, Locale locale)
     
    getArticles(long groupId, long folderId, Locale locale, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
     
    getArticlesByArticleId(long groupId, String articleId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
     
    getArticlesByArticleId(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group and article ID.
    getArticlesByLayoutUuid(long groupId, String layoutUuid)
    Returns all the web content articles matching the group and layout UUID.
    getArticlesByLayoutUuid(long groupId, String layoutUuid, int start, int end)
    Returns all the web content articles that the user has permission to view matching the group and layout UUID.
    int
    getArticlesByLayoutUuidCount(long groupId, String layoutUuid)
    Returns the number of web content articles that the user has permission to view matching the group and layout UUID.
    getArticlesByStructureId(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
    getArticlesByStructureId(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
    getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.
    getArticlesByStructureId(long groupId, long folderId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
     
    getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.
    getArticlesByStructureId(long groupId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
    int
    getArticlesCount(long groupId, long folderId)
    Returns the number of web content articles matching the group and folder.
    int
    getArticlesCount(long groupId, long folderId, int status)
    Returns the number of web content articles matching the group, folder, and status.
    int
    getArticlesCountByArticleId(long groupId, String articleId)
    Returns the number of web content articles matching the group and article ID.
    int
    getArticlesCountByArticleId(long groupId, String articleId, int status)
     
    int
    getArticlesCountByStructureId(long groupId, long ddmStructureId)
    Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
    int
    getArticlesCountByStructureId(long groupId, long ddmStructureId, int status)
    Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
    int
    getArticlesCountByStructureId(long groupId, long classNameId, long ddmStructureId, int status)
    Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status.
    int
    getArticlesCountByStructureId(long groupId, long folderId, long classNameId, long ddmStructureId, int status)
     
    getDisplayArticleByUrlTitle(long groupId, String urlTitle)
    Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.
    int
    getFoldersAndArticlesCount(long groupId, List<Long> folderIds)
    Returns the number of folders containing web content articles belonging to the group.
    getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
    getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, Locale locale, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
    getGroupArticles(long groupId, long userId, long rootFolderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
    getGroupArticles(long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
    Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
    int
    getGroupArticlesCount(long groupId, long userId, long rootFolderId)
    Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
    int
    getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status)
    Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
    int
    getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status, boolean includeOwner)
    Returns the number of web content articles matching the group, user, the root folder or any of its subfolders.
    getLatestArticle(long resourcePrimKey)
    Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
    getLatestArticle(long groupId, String articleId, int status)
    Returns the latest web content article matching the group, article ID, and workflow status.
    getLatestArticle(long groupId, String className, long classPK)
    Returns the latest web content article matching the group, class name ID, and class PK.
    getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode)
    Returns the latest web content article matching the group and the external reference code.
    getLatestArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
     
    int
    getLatestArticlesCount(long groupId, int status)
     
    getLayoutArticles(long groupId)
    Returns all the web content articles that the user has permission to view matching the group.
    getLayoutArticles(long groupId, int start, int end)
    Returns all the web content articles that the user has permission to view matching the group.
    int
    getLayoutArticlesCount(long groupId)
    Returns the number of web content articles that the user has permission to view matching the group.
    Returns the OSGi service identifier.
     
    void
    moveArticle(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Moves all versions of the web content article matching the group and article ID to the folder.
    moveArticleFromTrash(long groupId, long resourcePrimKey, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Moves the web content article from the Recycle Bin to the folder.
    moveArticleFromTrash(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Moves the web content article from the Recycle Bin to the folder.
    moveArticleToTrash(long groupId, String articleId)
    Moves the latest version of the web content article matching the group and article ID to the recycle bin.
    void
    removeArticleLocale(long companyId, String languageId)
    Removes the web content of all the company's web content articles matching the language.
    removeArticleLocale(long groupId, String articleId, double version, String languageId)
    Removes the web content of the web content article matching the group, article ID, and version, and language.
    void
    restoreArticleFromTrash(long resourcePrimKey)
    Restores the web content article associated with the resource primary key from the Recycle Bin.
    void
    restoreArticleFromTrash(long groupId, String articleId)
    Restores the web content article from the Recycle Bin.
    void
     
    void
    subscribe(long groupId, long articleId)
     
    void
    subscribeStructure(long groupId, long userId, long ddmStructureId)
    Subscribes the user to changes in elements that belong to the web content article's DDM structure.
    void
    unsubscribe(long groupId, long articleId)
     
    void
    unsubscribeStructure(long groupId, long userId, long ddmStructureId)
    Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.
    updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.
    updateArticle(long groupId, long folderId, String articleId, double version, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the web content article matching the version, replacing its folder and content.
    updateArticle(long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> friendlyURLMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the web content article with additional parameters.
    updateArticleDefaultValues(long groupId, String articleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the translation of the web content article.
    updateStatus(long groupId, String articleId, double version, int status, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the workflow status of the web content article matching the group, article ID, and version.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • JournalArticleServiceWrapper

      public JournalArticleServiceWrapper()
    • JournalArticleServiceWrapper

      public JournalArticleServiceWrapper(JournalArticleService journalArticleService)
  • Method Details

    • addArticle

      public JournalArticle addArticle(String externalReferenceCode, long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> friendlyURLMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds a web content article with additional parameters. All scheduling parameters (display date, expiration date, and review date) use the current user's timezone.
      Specified by:
      addArticle in interface JournalArticleService
      Parameters:
      externalReferenceCode - the external reference code of the web content article
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      classPK - the primary key of the DDM structure, if the primary key of the DDMStructure class is given as the classNameId parameter, the primary key of the class associated with the web content article, or 0 otherwise
      articleId - the primary key of the web content article
      autoArticleId - whether to auto generate the web content article ID
      titleMap - the web content article's locales and localized titles
      descriptionMap - the web content article's locales and localized descriptions
      friendlyURLMap - the web content article's locales and localized friendly URLs
      content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.
      ddmStructureId - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or 0 otherwise
      ddmTemplateKey - the primary key of the web content article's DDM template
      layoutUuid - the unique string identifying the web content article's display page
      displayDateMonth - the month the web content article is set to display
      displayDateDay - the calendar day the web content article is set to display
      displayDateYear - the year the web content article is set to display
      displayDateHour - the hour the web content article is set to display
      displayDateMinute - the minute the web content article is set to display
      expirationDateMonth - the month the web content article is set to expire
      expirationDateDay - the calendar day the web content article is set to expire
      expirationDateYear - the year the web content article is set to expire
      expirationDateHour - the hour the web content article is set to expire
      expirationDateMinute - the minute the web content article is set to expire
      neverExpire - whether the web content article is not set to auto expire
      reviewDateMonth - the month the web content article is set for review
      reviewDateDay - the calendar day the web content article is set for review
      reviewDateYear - the year the web content article is set for review
      reviewDateHour - the hour the web content article is set for review
      reviewDateMinute - the minute the web content article is set for review
      neverReview - whether the web content article is not set for review
      indexable - whether the web content article is searchable
      smallImage - whether the web content article has a small image
      smallImageSource - the web content article's small image source
      smallImageURL - the web content article's small image URL
      smallFile - the web content article's small image file
      images - the web content's images
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, asset priority, URL title, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.
      Returns:
      the web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • addArticle

      public JournalArticle addArticle(String externalReferenceCode, long groupId, long folderId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Adds a web content article.
      Specified by:
      addArticle in interface JournalArticleService
      Parameters:
      externalReferenceCode - the external reference code of the web content article
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      titleMap - the web content article's locales and localized titles
      descriptionMap - the web content article's locales and localized descriptions
      content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.
      ddmStructureId - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or 0 otherwise
      ddmTemplateKey - the primary key of the web content article's DDM template
      serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, asset priority, URL title, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.
      Returns:
      the web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • addArticleDefaultValues

      public JournalArticle addArticleDefaultValues(long groupId, long classNameId, long classPK, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      addArticleDefaultValues in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyArticle

      public JournalArticle copyArticle(long groupId, String sourceArticleId, String targetArticleId, boolean autoArticleId, double version) throws com.liferay.portal.kernel.exception.PortalException
      Copies the web content article matching the group, article ID, and version. This method creates a new article, extracting all the values from the old one and updating its article ID.
      Specified by:
      copyArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      sourceArticleId - the primary key of the old web content article
      targetArticleId - the primary key of the new web content article
      autoArticleId - whether to auto-generate the web content article ID
      version - the web content article's version
      Returns:
      the new web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • deleteArticle

      public void deleteArticle(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.
      Specified by:
      deleteArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the portlet preferences that include email information to notify recipients of the unapproved web content article's denial.
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • deleteArticle

      public void deleteArticle(long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved.
      Specified by:
      deleteArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the portlet preferences that include email information to notify recipients of the unapproved web content article's denial.
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • deleteArticleDefaultValues

      public void deleteArticleDefaultValues(long groupId, String articleId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deleteArticleDefaultValues in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • expireArticle

      public JournalArticle expireArticle(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Expires the web content article matching the group, article ID, and version.
      Specified by:
      expireArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • expireArticle

      public void expireArticle(long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Expires the web content article matching the group and article ID, expiring all of its versions if the journal.article.expire.all.versions portal property is true, otherwise expiring only its latest approved version.
      Specified by:
      expireArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • fetchArticle

      public JournalArticle fetchArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      fetchArticle in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchLatestArticleByExternalReferenceCode

      public JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article matching the group and the external reference code.
      Specified by:
      fetchLatestArticleByExternalReferenceCode in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      externalReferenceCode - the external reference code of the web content article
      Returns:
      the latest matching web content article, or null if no matching web content article could be found
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getArticle

      public JournalArticle getArticle(long id) throws com.liferay.portal.kernel.exception.PortalException
      Returns the web content article with the ID.
      Specified by:
      getArticle in interface JournalArticleService
      Parameters:
      id - the primary key of the web content article
      Returns:
      the web content article with the ID
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticle

      public JournalArticle getArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest approved web content article, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and article ID.
      Specified by:
      getArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      Returns:
      the matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticle

      public JournalArticle getArticle(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
      Returns the web content article matching the group, article ID, and version.
      Specified by:
      getArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      Returns:
      the matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticle

      public JournalArticle getArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Returns the web content article matching the group, class name, and class PK.
      Specified by:
      getArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      className - the DDMStructure class name if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      classPK - the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise
      Returns:
      the matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticleByUrlTitle

      public JournalArticle getArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article that is approved, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and URL title.
      Specified by:
      getArticleByUrlTitle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      urlTitle - the web content article's accessible URL title
      Returns:
      the matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticleContent

      public String getArticleContent(long groupId, String articleId, double version, String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
      Returns the web content from the web content article matching the group, article ID, and version.
      Specified by:
      getArticleContent in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      languageId - the primary key of the language translation to get
      portletRequestModel - the portlet request model
      themeDisplay - the theme display
      Returns:
      the matching web content
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticleContent

      public String getArticleContent(long groupId, String articleId, String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content from the web content article matching the group and article ID.
      Specified by:
      getArticleContent in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      languageId - the primary key of the language translation to get
      portletRequestModel - the portlet request model
      themeDisplay - the theme display
      Returns:
      the matching web content
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getArticles

      public List<JournalArticle> getArticles(long groupId, long folderId, Locale locale)
      Specified by:
      getArticles in interface JournalArticleService
    • getArticles

      public List<JournalArticle> getArticles(long groupId, long folderId, Locale locale, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Specified by:
      getArticles in interface JournalArticleService
    • getArticlesByArticleId

      public List<JournalArticle> getArticlesByArticleId(long groupId, String articleId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Specified by:
      getArticlesByArticleId in interface JournalArticleService
    • getArticlesByArticleId

      public List<JournalArticle> getArticlesByArticleId(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group and article ID.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByArticleId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByLayoutUuid

      public List<JournalArticle> getArticlesByLayoutUuid(long groupId, String layoutUuid)
      Returns all the web content articles matching the group and layout UUID.
      Specified by:
      getArticlesByLayoutUuid in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      layoutUuid - the unique string identifying the web content article's display page
      Returns:
      the matching web content articles
    • getArticlesByLayoutUuid

      public List<JournalArticle> getArticlesByLayoutUuid(long groupId, String layoutUuid, int start, int end)
      Returns all the web content articles that the user has permission to view matching the group and layout UUID.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByLayoutUuid in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      layoutUuid - the unique string identifying the web content article's display page
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      Returns:
      the range of matching web content articles
    • getArticlesByLayoutUuidCount

      public int getArticlesByLayoutUuidCount(long groupId, String layoutUuid)
      Returns the number of web content articles that the user has permission to view matching the group and layout UUID.
      Specified by:
      getArticlesByLayoutUuidCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      layoutUuid - the unique string identifying the web content article's display page
      Returns:
      the matching web content articles
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      ddmStructureId - the primary key of the web content article's DDM structure
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      ddmStructureId - the primary key of the web content article's DDM structure
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      ddmStructureId - the primary key of the web content article's DDM structure
      locale - web content articles locale
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      ddmStructureId - the primary key of the web content article's DDM structure
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getArticlesByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      ddmStructureId - the primary key of the web content article's DDM structure
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
    • getArticlesByStructureId

      public List<JournalArticle> getArticlesByStructureId(long groupId, long folderId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Specified by:
      getArticlesByStructureId in interface JournalArticleService
    • getArticlesCount

      public int getArticlesCount(long groupId, long folderId)
      Returns the number of web content articles matching the group and folder.
      Specified by:
      getArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      Returns:
      the number of matching web content articles
    • getArticlesCount

      public int getArticlesCount(long groupId, long folderId, int status)
      Returns the number of web content articles matching the group, folder, and status.
      Specified by:
      getArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article's folder
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      Returns:
      the number of matching web content articles
    • getArticlesCountByArticleId

      public int getArticlesCountByArticleId(long groupId, String articleId)
      Returns the number of web content articles matching the group and article ID.
      Specified by:
      getArticlesCountByArticleId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      Returns:
      the number of matching web content articles
    • getArticlesCountByArticleId

      public int getArticlesCountByArticleId(long groupId, String articleId, int status)
      Specified by:
      getArticlesCountByArticleId in interface JournalArticleService
    • getArticlesCountByStructureId

      public int getArticlesCountByStructureId(long groupId, long ddmStructureId)
      Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
      Specified by:
      getArticlesCountByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      ddmStructureId - the primary key of the web content article's DDM structure
      Returns:
      the number of matching web content articles
    • getArticlesCountByStructureId

      public int getArticlesCountByStructureId(long groupId, long ddmStructureId, int status)
      Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
      Specified by:
      getArticlesCountByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      ddmStructureId - the primary key of the web content article's DDM structure
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      Returns:
      the number of matching web content articles
    • getArticlesCountByStructureId

      public int getArticlesCountByStructureId(long groupId, long classNameId, long ddmStructureId, int status)
      Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status.
      Specified by:
      getArticlesCountByStructureId in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      ddmStructureId - the primary key of the web content article's DDM structure
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      Returns:
      the number of matching web content articles
    • getArticlesCountByStructureId

      public int getArticlesCountByStructureId(long groupId, long folderId, long classNameId, long ddmStructureId, int status)
      Specified by:
      getArticlesCountByStructureId in interface JournalArticleService
    • getDisplayArticleByUrlTitle

      public JournalArticle getDisplayArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.
      Specified by:
      getDisplayArticleByUrlTitle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      urlTitle - the web content article's accessible URL title
      Returns:
      the web content article matching the URL title that is currently displayed, or next one to be displayed if no version of the article is currently displayed
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getFoldersAndArticlesCount

      public int getFoldersAndArticlesCount(long groupId, List<Long> folderIds)
      Returns the number of folders containing web content articles belonging to the group.
      Specified by:
      getFoldersAndArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      folderIds - the primary keys of the web content article folders (optionally Collections#EMPTY_LIST)
      Returns:
      the number of matching folders containing web content articles
    • getGroupArticles

      public List<JournalArticle> getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
      Specified by:
      getGroupArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      includeOwner - whether to include the user's web content
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticles

      public List<JournalArticle> getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, Locale locale, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
      Specified by:
      getGroupArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      includeOwner - whether to include the user's web content
      locale - web content articles locale
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticles

      public List<JournalArticle> getGroupArticles(long groupId, long userId, long rootFolderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getGroupArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticles

      public List<JournalArticle> getGroupArticles(long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getGroupArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      orderByComparator - the comparator to order the web content articles
      Returns:
      the range of matching web content articles ordered by the comparator
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticlesCount

      public int getGroupArticlesCount(long groupId, long userId, long rootFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
      Specified by:
      getGroupArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      Returns:
      the number of matching web content articles
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticlesCount

      public int getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
      Specified by:
      getGroupArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      Returns:
      the number of matching web content articles
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getGroupArticlesCount

      public int getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status, boolean includeOwner) throws com.liferay.portal.kernel.exception.PortalException
      Returns the number of web content articles matching the group, user, the root folder or any of its subfolders.
      Specified by:
      getGroupArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      userId - the primary key of the user (optionally 0)
      rootFolderId - the primary key of the root folder to begin the search
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      includeOwner - whether to include the user's web content
      Returns:
      the range of matching web content articles ordered by the comparator
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getLatestArticle

      public JournalArticle getLatestArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
      Specified by:
      getLatestArticle in interface JournalArticleService
      Parameters:
      resourcePrimKey - the primary key of the resource instance
      Returns:
      the latest web content article matching the resource primary key, preferring articles with approved workflow status
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getLatestArticle

      public JournalArticle getLatestArticle(long groupId, String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article matching the group, article ID, and workflow status.
      Specified by:
      getLatestArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      Returns:
      the latest matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getLatestArticle

      public JournalArticle getLatestArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article matching the group, class name ID, and class PK.
      Specified by:
      getLatestArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      className - the DDMStructure class name if the web content article is related to a DDM structure, the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwise
      classPK - the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise
      Returns:
      the latest matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getLatestArticleByExternalReferenceCode

      public JournalArticle getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Returns the latest web content article matching the group and the external reference code.
      Specified by:
      getLatestArticleByExternalReferenceCode in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      externalReferenceCode - the external reference code of the web content article
      Returns:
      the latest matching web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getLatestArticles

      public List<JournalArticle> getLatestArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
      Specified by:
      getLatestArticles in interface JournalArticleService
    • getLatestArticlesCount

      public int getLatestArticlesCount(long groupId, int status)
      Specified by:
      getLatestArticlesCount in interface JournalArticleService
    • getLayoutArticles

      public List<JournalArticle> getLayoutArticles(long groupId)
      Returns all the web content articles that the user has permission to view matching the group.
      Specified by:
      getLayoutArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      Returns:
      The matching web content articles
    • getLayoutArticles

      public List<JournalArticle> getLayoutArticles(long groupId, int start, int end)
      Returns all the web content articles that the user has permission to view matching the group.

      Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

      Specified by:
      getLayoutArticles in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      start - the lower bound of the range of web content articles to return
      end - the upper bound of the range of web content articles to return (not inclusive)
      Returns:
      the range of matching web content articles
    • getLayoutArticlesCount

      public int getLayoutArticlesCount(long groupId)
      Returns the number of web content articles that the user has permission to view matching the group.
      Specified by:
      getLayoutArticlesCount in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      Returns:
      the number of matching web content articles
    • getOSGiServiceIdentifier

      public String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Specified by:
      getOSGiServiceIdentifier in interface JournalArticleService
      Returns:
      the OSGi service identifier
    • moveArticle

      public void moveArticle(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Moves all versions of the web content article matching the group and article ID to the folder.
      Specified by:
      moveArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      newFolderId - the primary key of the web content article's new folder
      serviceContext - the service context to be applied. Can set the user ID, language ID, portlet preferences, portlet request, portlet response, theme display, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • moveArticleFromTrash

      public JournalArticle moveArticleFromTrash(long groupId, long resourcePrimKey, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Moves the web content article from the Recycle Bin to the folder.
      Specified by:
      moveArticleFromTrash in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      resourcePrimKey - the primary key of the resource instance
      newFolderId - the primary key of the web content article's new folder
      serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the updated web content article, which was moved from the Recycle Bin to the folder
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • moveArticleFromTrash

      public JournalArticle moveArticleFromTrash(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Moves the web content article from the Recycle Bin to the folder.
      Specified by:
      moveArticleFromTrash in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      newFolderId - the primary key of the web content article's new folder
      serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the updated web content article, which was moved from the Recycle Bin to the folder
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • moveArticleToTrash

      public JournalArticle moveArticleToTrash(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException
      Moves the latest version of the web content article matching the group and article ID to the recycle bin.
      Specified by:
      moveArticleToTrash in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      Returns:
      the moved web content article or null if no matching article was found
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • removeArticleLocale

      public void removeArticleLocale(long companyId, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Removes the web content of all the company's web content articles matching the language.
      Specified by:
      removeArticleLocale in interface JournalArticleService
      Parameters:
      companyId - the primary key of the web content article's company
      languageId - the primary key of the language locale to remove
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • removeArticleLocale

      public JournalArticle removeArticleLocale(long groupId, String articleId, double version, String languageId) throws com.liferay.portal.kernel.exception.PortalException
      Removes the web content of the web content article matching the group, article ID, and version, and language.
      Specified by:
      removeArticleLocale in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      languageId - the primary key of the language locale to remove
      Returns:
      the updated web content article with the locale removed
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • restoreArticleFromTrash

      public void restoreArticleFromTrash(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException
      Restores the web content article associated with the resource primary key from the Recycle Bin.
      Specified by:
      restoreArticleFromTrash in interface JournalArticleService
      Parameters:
      resourcePrimKey - the primary key of the resource instance
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • restoreArticleFromTrash

      public void restoreArticleFromTrash(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException
      Restores the web content article from the Recycle Bin.
      Specified by:
      restoreArticleFromTrash in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • subscribe

      public void subscribe(long groupId, long articleId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      subscribe in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • subscribeStructure

      public void subscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException
      Subscribes the user to changes in elements that belong to the web content article's DDM structure.
      Specified by:
      subscribeStructure in interface JournalArticleService
      Parameters:
      groupId - the primary key of the folder's group
      userId - the primary key of the user to be subscribed
      ddmStructureId - the primary key of the structure to subscribe to
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • unsubscribe

      public void unsubscribe(long groupId, long articleId) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      unsubscribe in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsubscribeStructure

      public void unsubscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException
      Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.
      Specified by:
      unsubscribeStructure in interface JournalArticleService
      Parameters:
      groupId - the primary key of the folder's group
      userId - the primary key of the user to be subscribed
      ddmStructureId - the primary key of the structure to subscribe to
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • updateArticle

      public JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.
      Specified by:
      updateArticle in interface JournalArticleService
      Parameters:
      userId - the primary key of the user updating the web content article
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      articleId - the primary key of the web content article
      version - the web content article's version
      titleMap - the web content article's locales and localized titles
      descriptionMap - the web content article's locales and localized descriptions
      content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.
      layoutUuid - the unique string identifying the web content article's display page
      serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the updated web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • updateArticle

      public JournalArticle updateArticle(long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, Map<Locale,String> friendlyURLMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the web content article with additional parameters. All scheduling parameters (display date, expiration date, and review date) use the current user's timezone.
      Specified by:
      updateArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      articleId - the primary key of the web content article
      version - the web content article's version
      titleMap - the web content article's locales and localized titles
      descriptionMap - the web content article's locales and localized descriptions
      friendlyURLMap - the web content article's locales and localized friendly URLs
      content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.
      ddmTemplateKey - the primary key of the web content article's DDM template
      layoutUuid - the unique string identifying the web content article's display page
      displayDateMonth - the month the web content article is set to display
      displayDateDay - the calendar day the web content article is set to display
      displayDateYear - the year the web content article is set to display
      displayDateHour - the hour the web content article is set to display
      displayDateMinute - the minute the web content article is set to display
      expirationDateMonth - the month the web content article is set to expire
      expirationDateDay - the calendar day the web content article is set to expire
      expirationDateYear - the year the web content article is set to expire
      expirationDateHour - the hour the web content article is set to expire
      expirationDateMinute - the minute the web content article is set to expire
      neverExpire - whether the web content article is not set to auto expire
      reviewDateMonth - the month the web content article is set for review
      reviewDateDay - the calendar day the web content article is set for review
      reviewDateYear - the year the web content article is set for review
      reviewDateHour - the hour the web content article is set for review
      reviewDateMinute - the minute the web content article is set for review
      neverReview - whether the web content article is not set for review
      indexable - whether the web content is searchable
      smallImage - whether to update web content article's a small image. A file must be passed in as smallImageFile value, otherwise the current small image is deleted.
      smallImageSource - the web content article's small image source (optionally null)
      smallImageURL - the web content article's small image URL (optionally null)
      smallFile - the web content article's new small image file (optionally null). Must pass in smallImage value of true to replace the article's small image file.
      images - the web content's images (optionally null)
      articleURL - the web content article's accessible URL (optionally null)
      serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the updated web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • updateArticle

      public JournalArticle updateArticle(long groupId, long folderId, String articleId, double version, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the web content article matching the version, replacing its folder and content.

      The web content articles hold HTML content wrapped in XML. The XML lets you specify the article's default locale and available locales. Here is a content example:

       
       <?xml version='1.0' encoding='UTF-8'?>
       <root default-locale="en_US" available-locales="en_US">
              <static-content language-id="en_US">
                      <![CDATA[<p><b><i>test<i> content<b></p>]]>
              </static-content>
       </root>
       
       

      Specified by:
      updateArticle in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      folderId - the primary key of the web content article folder
      articleId - the primary key of the web content article
      version - the web content article's version
      content - the HTML content wrapped in XML.
      serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
      Returns:
      the updated web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • updateArticleDefaultValues

      public JournalArticle updateArticleDefaultValues(long groupId, String articleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      updateArticleDefaultValues in interface JournalArticleService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateArticleTranslation

      public JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the translation of the web content article.
      Specified by:
      updateArticleTranslation in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      locale - the locale of the web content article's display template
      title - the translated web content article title
      description - the translated web content article description
      content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.
      images - the web content's images
      serviceContext - the service context to be applied. Can set the modification date and URL title for the web content article.
      Returns:
      the updated web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public JournalArticle updateStatus(long groupId, String articleId, double version, int status, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Updates the workflow status of the web content article matching the group, article ID, and version.
      Specified by:
      updateStatus in interface JournalArticleService
      Parameters:
      groupId - the primary key of the web content article's group
      articleId - the primary key of the web content article
      version - the web content article's version
      status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
      articleURL - the web content article's accessible URL
      serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article.
      Returns:
      the updated web content article
      Throws:
      PortalException - if a portal exception occurred
      com.liferay.portal.kernel.exception.PortalException
    • getWrappedService

      public JournalArticleService getWrappedService()
      Specified by:
      getWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<JournalArticleService>
    • setWrappedService

      public void setWrappedService(JournalArticleService journalArticleService)
      Specified by:
      setWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<JournalArticleService>