Liferay 7.0-ce-m6

com.liferay.portlet.journal.service
Class JournalArticleLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.journal.service.JournalArticleLocalServiceUtil

@ProviderType
public class JournalArticleLocalServiceUtil
extends Object

Provides the local service utility for JournalArticle. This utility wraps JournalArticleLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
JournalArticleLocalService, JournalArticleLocalServiceBaseImpl, JournalArticleLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
JournalArticleLocalServiceUtil()
           
 
Method Summary
static JournalArticle addArticle(long userId, long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String ddmStructureKey, 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, String smallImageURL, File smallImageFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
          Adds a web content article with additional parameters.
static JournalArticle addArticle(long userId, long groupId, long folderId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String ddmStructureKey, String ddmTemplateKey, ServiceContext serviceContext)
          Adds a web content article.
static void addArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions)
          Adds the resources to the web content article.
static void addArticleResources(JournalArticle article, String[] groupPermissions, String[] guestPermissions)
          Adds the model resources with the permissions to the web content article.
static void addArticleResources(long groupId, String articleId, boolean addGroupPermissions, boolean addGuestPermissions)
          Adds the resources to the most recently created web content article.
static void addArticleResources(long groupId, String articleId, String[] groupPermissions, String[] guestPermissions)
          Adds the resources with the permissions to the most recently created web content article.
static JournalArticle addJournalArticle(JournalArticle journalArticle)
          Adds the journal article to the database.
static JournalArticle checkArticleResourcePrimKey(long groupId, String articleId, double version)
          Returns the web content article with the group, article ID, and version.
static void checkArticles()
          Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.
static void checkNewLine(long groupId, String articleId, double version)
          Checks the web content article matching the group, article ID, and version, replacing escaped newline and return characters with non-escaped newline and return characters.
static void checkStructure(long groupId, String articleId, double version)
          Checks the web content article matching the group, article ID, and version for an associated structure.
static JournalArticle copyArticle(long userId, long groupId, String oldArticleId, String newArticleId, boolean autoArticleId, double version)
          Copies the web content article matching the group, article ID, and version.
static JournalArticle createJournalArticle(long id)
          Creates a new journal article with the primary key.
static JournalArticle deleteArticle(JournalArticle article)
          Deletes the web content article and its resources.
static JournalArticle deleteArticle(JournalArticle article, String articleURL, ServiceContext serviceContext)
          Deletes the web content article and its resources, optionally sending email notifying denial of the article if it had not yet been approved.
static JournalArticle deleteArticle(long groupId, String articleId, double version, String articleURL, 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.
static void deleteArticle(long groupId, String articleId, 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.
static void deleteArticles(long groupId)
          Deletes all the group's web content articles and resources.
static void deleteArticles(long groupId, long folderId)
          Deletes all the group's web content articles and resources in the folder, including recycled articles.
static void deleteArticles(long groupId, long folderId, boolean includeTrashedEntries)
          Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.
static JournalArticle deleteJournalArticle(JournalArticle journalArticle)
          Deletes the journal article from the database.
static JournalArticle deleteJournalArticle(long id)
          Deletes the journal article with the primary key from the database.
static void deleteLayoutArticleReferences(long groupId, String layoutUuid)
          Deletes the layout's association with the web content articles for the group.
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static JournalArticle expireArticle(long userId, long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)
          Expires the web content article matching the group, article ID, and version.
static void expireArticle(long userId, long groupId, String articleId, String articleURL, 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.
static JournalArticle fetchArticle(long groupId, String articleId)
           
static JournalArticle fetchArticle(long groupId, String articleId, double version)
          Returns the web content article matching the group, article ID, and version.
static JournalArticle fetchArticleByUrlTitle(long groupId, String urlTitle)
           
static JournalArticle fetchDisplayArticle(long groupId, String articleId)
           
static JournalArticle fetchJournalArticle(long id)
           
static JournalArticle fetchJournalArticleByUuidAndGroupId(String uuid, long groupId)
          Returns the journal article matching the UUID and group.
static JournalArticle fetchLatestArticle(long resourcePrimKey)
           
static JournalArticle fetchLatestArticle(long resourcePrimKey, int status)
           
static JournalArticle fetchLatestArticle(long resourcePrimKey, int[] statuses)
           
static JournalArticle fetchLatestArticle(long resourcePrimKey, int status, boolean preferApproved)
          Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.
static JournalArticle fetchLatestArticle(long groupId, String articleId, int status)
          Returns the latest web content article matching the group, article ID, and workflow status.
static JournalArticle fetchLatestArticleByUrlTitle(long groupId, String urlTitle, int status)
           
static JournalArticle fetchLatestIndexableArticle(long resourcePrimKey)
          Returns the latest indexable web content article matching the resource primary key.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static JournalArticle getArticle(long id)
          Returns the web content article with the ID.
static JournalArticle getArticle(long groupId, String articleId)
          Returns the latest approved web content article, or the latest unapproved article if none are approved.
static JournalArticle getArticle(long groupId, String articleId, double version)
          Returns the web content article matching the group, article ID, and version.
static JournalArticle getArticle(long groupId, String className, long classPK)
          Returns the web content article matching the group, class name, and class PK.
static JournalArticle getArticleByUrlTitle(long groupId, String urlTitle)
          Returns the latest web content article that is approved, or the latest unapproved article if none are approved.
static String getArticleContent(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns the web content from the web content article associated with the portlet request model and the DDM template.
static String getArticleContent(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Deprecated. As of 7.0.0, replaced by getArticleContent(JournalArticle, String, String, String, PortletRequestModel,ThemeDisplay)
static String getArticleContent(long groupId, String articleId, double version, String viewMode, String ddmTemplateKey, String languageId, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns the web content from the web content article matching the group, article ID, and version, and associated with the portlet request model and the DDM template.
static String getArticleContent(long groupId, String articleId, double version, String viewMode, String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)
          Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, double, String, String, String, PortletRequestModel, ThemeDisplay)
static String getArticleContent(long groupId, String articleId, double version, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, double, String, String, String, PortletRequestModel, ThemeDisplay)
static String getArticleContent(long groupId, String articleId, String viewMode, String ddmTemplateKey, String languageId, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns the latest web content from the web content article matching the group and article ID, and associated with the portlet request model and the DDM template.
static String getArticleContent(long groupId, String articleId, String viewMode, String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)
          Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, String, String, String, PortletRequestModel, ThemeDisplay)
static String getArticleContent(long groupId, String articleId, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, String, String, String, PortletRequestModel, ThemeDisplay)
static JournalArticleDisplay getArticleDisplay(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, int page, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns a web content article display for the specified page of the latest version of the web content article, based on the DDM template.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, int page, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns a web content article display for the specified page of the specified version of the web content article matching the group, article ID, and DDM template.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Returns a web content article display for the first page of the specified version of the web content article matching the group, article ID, and DDM template.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String viewMode, String languageId, int page, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns a web content article display for the specified page of the latest version of the web content article matching the group and article ID.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, int page, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
          Returns a web content article display for the specified page of the latest version of the web content article matching the group, article ID, and DDM template.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Returns a web content article display for the first page of the latest version of the web content article matching the group, article ID, and DDM template.
static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String viewMode, String languageId, ThemeDisplay themeDisplay)
          Returns a web content article display for the first page of the latest version of the web content article matching the group and article ID.
static List<JournalArticle> getArticles()
          Returns all the web content articles present in the system.
static List<JournalArticle> getArticles(long groupId)
          Returns all the web content articles belonging to the group.
static List<JournalArticle> getArticles(long groupId, int start, int end)
          Returns a range of all the web content articles belonging to the group.
static List<JournalArticle> getArticles(long groupId, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles belonging to the group.
static List<JournalArticle> getArticles(long groupId, long folderId)
          Returns all the web content articles matching the group and folder.
static List<JournalArticle> getArticles(long groupId, long folderId, int start, int end)
          Returns a range of all the web content articles matching the group and folder.
static List<JournalArticle> getArticles(long groupId, long folderId, int status, int start, int end)
          Returns a range of all the web content articles matching the group, folder, and status.
static List<JournalArticle> getArticles(long groupId, long folderId, int start, int end, OrderByComparator<JournalArticle> orderByComparator)
          Returns an ordered range of all the web content articles matching the group and folder.
static List<JournalArticle> getArticles(long groupId, String articleId)
          Returns all the web content articles matching the group and article ID.
static List<JournalArticle> getArticles(long groupId, String articleId, int start, int end, OrderByComparator<JournalArticle> orderByComparator)
           
static List<JournalArticle> getArticlesByResourcePrimKey(long resourcePrimKey)
          Returns all the web content articles matching the resource primary key.
static List<JournalArticle> getArticlesBySmallImageId(long smallImageId)
          Returns all the web content articles matching the small image ID.
static int getArticlesCount(long groupId)
          Returns the number of web content articles belonging to the group.
static int getArticlesCount(long groupId, long folderId)
          Returns the number of web content articles matching the group and folder.
static int getArticlesCount(long groupId, long folderId, int status)
          Returns the number of web content articles matching the group, folder, and status.
static int getArticlesCount(long groupId, String articleId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<JournalArticle> getCompanyArticles(long companyId, double version, int status, int start, int end)
          Returns an ordered range of all the web content articles matching the company, version, and workflow status.
static List<JournalArticle> getCompanyArticles(long companyId, int status, int start, int end)
          Returns an ordered range of all the web content articles matching the company and workflow status.
static int getCompanyArticlesCount(long companyId, double version, int status, int start, int end)
          Returns the number of web content articles matching the company, version, and workflow status.
static int getCompanyArticlesCount(long companyId, int status)
          Returns the number of web content articles matching the company and workflow status.
static JournalArticle getDisplayArticle(long groupId, String articleId)
          Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed.
static JournalArticle 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.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static List<JournalArticle> getIndexableArticlesByDDMStructureKey(String[] ddmStructureKeys)
           
static List<JournalArticle> getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
          Returns the indexable web content articles matching the resource primary key.
static JournalArticle getJournalArticle(long id)
          Returns the journal article with the primary key.
static JournalArticle getJournalArticleByUuidAndGroupId(String uuid, long groupId)
          Returns the journal article matching the UUID and group.
static List<JournalArticle> getJournalArticles(int start, int end)
          Returns a range of all the journal articles.
static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the journal articles matching the UUID and company.
static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<JournalArticle> orderByComparator)
          Returns a range of journal articles matching the UUID and company.
static int getJournalArticlesCount()
          Returns the number of journal articles.
static JournalArticle getLatestArticle(long resourcePrimKey)
          Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
static JournalArticle getLatestArticle(long resourcePrimKey, int status)
          Returns the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status.
static JournalArticle getLatestArticle(long resourcePrimKey, int status, boolean preferApproved)
          Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.
static JournalArticle getLatestArticle(long groupId, String articleId)
          Returns the latest web content article with the group and article ID.
static JournalArticle getLatestArticle(long groupId, String articleId, int status)
          Returns the latest web content article matching the group, article ID, and workflow status.
static JournalArticle getLatestArticle(long groupId, String className, long classPK)
          Returns the latest web content article matching the group, class name ID, and class PK.
static JournalArticle getLatestArticleByUrlTitle(long groupId, String urlTitle, int status)
          Returns the latest web content article matching the group, URL title, and workflow status.
static double getLatestVersion(long groupId, String articleId)
          Returns the latest version number of the web content with the group and article ID.
static double getLatestVersion(long groupId, String articleId, int status)
          Returns the latest version number of the web content with the group, article ID, and workflow status.
static List<JournalArticle> getNoAssetArticles()
           
static List<JournalArticle> getNoPermissionArticles()
           
static int getNotInTrashArticlesCount(long groupId, long folderId)
          Returns the number of web content articles that are not recycled.
static JournalArticle getOldestArticle(long groupId, String articleId)
          Returns the oldest web content article with the group and article ID.
static JournalArticle getOldestArticle(long groupId, String articleId, int status)
          Returns the oldest web content article matching the group, article ID, and workflow status.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static JournalArticle getPreviousApprovedArticle(JournalArticle article)
          Returns the previously approved version of the web content article.
static JournalArticleLocalService getService()
           
static List<JournalArticle> getStructureArticles(long groupId, String ddmStructureKey)
          Returns the web content articles matching the group and DDM structure key.
static List<JournalArticle> getStructureArticles(long groupId, String ddmStructureKey, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles matching the group and DDM structure key.
static List<JournalArticle> getStructureArticles(String[] ddmStructureKeys)
          Returns the web content articles matching the DDM structure keys.
static int getStructureArticlesCount(long groupId, String ddmStructureKey)
          Returns the number of web content articles matching the group and DDM structure key.
static List<JournalArticle> getTemplateArticles(long groupId, String ddmTemplateKey)
          Returns the web content articles matching the group and DDM template key.
static List<JournalArticle> getTemplateArticles(long groupId, String ddmTemplateKey, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles matching the group and DDM template key.
static int getTemplateArticlesCount(long groupId, String ddmTemplateKey)
          Returns the number of web content articles matching the group and DDM template key.
static String getUniqueUrlTitle(long groupId, String articleId, String urlTitle)
          Returns the web content article's unique URL title.
static boolean hasArticle(long groupId, String articleId)
          Returns true if the specified web content article exists.
static boolean isLatestVersion(long groupId, String articleId, double version)
          Returns true if the web content article, specified by group and article ID, is the latest version.
static boolean isLatestVersion(long groupId, String articleId, double version, int status)
          Returns true if the web content article, specified by group, article ID, and workflow status, is the latest version.
static boolean isRenderable(JournalArticle article, PortletRequestModel portletRequestModel, ThemeDisplay themeDisplay)
           
static JournalArticle moveArticle(long groupId, String articleId, long newFolderId)
          Deprecated. As of 7.0.0, replaced by moveArticle(long, String, long, ServiceContext)
static JournalArticle moveArticle(long groupId, String articleId, long newFolderId, ServiceContext serviceContext)
          Moves the web content article matching the group and article ID to a new folder.
static JournalArticle moveArticleFromTrash(long userId, long groupId, JournalArticle article, long newFolderId, ServiceContext serviceContext)
          Moves the web content article from the Recycle Bin to a new folder.
static JournalArticle moveArticleToTrash(long userId, JournalArticle article)
          Moves the latest version of the web content article matching the group and article ID to the recycle bin.
static JournalArticle moveArticleToTrash(long userId, long groupId, String articleId)
          Moves the latest version of the web content article matching the group and article ID to the recycle bin.
static void rebuildTree(long companyId)
          Rebuilds the web content article's tree path using tree traversal.
static JournalArticle 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.
static JournalArticle restoreArticleFromTrash(long userId, JournalArticle article)
          Restores the web content article from the Recycle Bin.
static List<JournalArticle> search(long groupId, List<Long> folderIds, int status, int start, int end)
          Returns a range of all the web content articles matching the parameters without using the indexer.
static List<JournalArticle> search(long groupId, long folderId, int status, int start, int end)
          Returns a range of all the web content articles in a single folder matching the parameters without using the indexer.
static List<JournalArticle> search(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles matching the parameters without using the indexer, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.
static List<JournalArticle> search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String[] ddmStructureKeys, String[] ddmTemplateKeys, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles matching the parameters without using the indexer, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.
static List<JournalArticle> search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator<JournalArticle> obc)
          Returns an ordered range of all the web content articles matching the parameters without using the indexer, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.
static Hits search(long companyId, long groupId, List<Long> folderIds, long classNameId, String ddmStructureKey, String ddmTemplateKey, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
          Returns an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, and a finder hash map parameter.
static Hits search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, String title, String description, String content, int status, String ddmStructureKey, String ddmTemplateKey, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
          Returns an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, an AND operator switch, and parameters for type, status, a finder hash map.
static Hits search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, String title, String description, String content, String type, String statusString, String ddmStructureKey, String ddmTemplateKey, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
          Deprecated. As of 7.0.0, replaced by search(long, long, List, long, String, String, String, String, int, String, String, LinkedHashMap, boolean, int, int, Sort)
static Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end)
          Returns a range of all the web content articles matching the group, creator, and status using the indexer.
static int searchCount(long groupId, List<Long> folderIds, int status)
          Returns the number of web content articles matching the group, folders, and status.
static int searchCount(long groupId, long folderId, int status)
          Returns the number of web content articles matching the group, folder, and status.
static int searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate)
          Returns the number of web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.
static int searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String[] ddmStructureKeys, String[] ddmTemplateKeys, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)
          Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.
static int searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)
          Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.
static BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId, long groupId, List<Long> folderIds, long classNameId, String ddmStructureKey, String ddmTemplateKey, String keywords, LinkedHashMap<String,Object> params, int start, int end, Sort sort)
          Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, and a finder hash map parameter.
static BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, String title, String description, String content, int status, String ddmStructureKey, String ddmTemplateKey, LinkedHashMap<String,Object> params, boolean andSearch, int start, int end, Sort sort)
          Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including keyword parameters for article ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, an AND operator switch, and parameters for type, status, and a finder hash map.
static BaseModelSearchResult<JournalArticle> searchJournalArticles(long groupId, long userId, long creatorUserId, int status, int start, int end)
          Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including the web content article's creator ID and status.
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(JournalArticleLocalService service)
          Deprecated. As of 6.2.0
static void setTreePaths(long folderId, String treePath, boolean reindex)
           
static 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.
static 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.
static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String layoutUuid, ServiceContext serviceContext)
          Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.
static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String ddmStructureKey, 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, String smallImageURL, File smallImageFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext)
          Updates the web content article with additional parameters.
static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, String content, ServiceContext serviceContext)
          Updates the web content article matching the version, replacing its folder and content.
static JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images)
          Deprecated. As of 6.2.0, replaced by updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)
static JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images, ServiceContext serviceContext)
          Updates the translation of the web content article.
static void updateAsset(long userId, JournalArticle article, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
          Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary.
static JournalArticle updateContent(long groupId, String articleId, double version, String content)
          Updates the web content article matching the group, article ID, and version, replacing its content.
static void updateDDMTemplateKey(long groupId, long classNameId, String oldDDMTemplateKey, String newDDMTemplateKey)
          Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one.
static JournalArticle updateJournalArticle(JournalArticle journalArticle)
          Updates the journal article in the database or adds it if it does not yet exist.
static JournalArticle updateStatus(long userId, JournalArticle article, int status, String articleURL, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
          Updates the workflow status of the web content article.
static JournalArticle updateStatus(long userId, long classPK, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
          Updates the workflow status of the web content article matching the class PK.
static JournalArticle updateStatus(long userId, long groupId, String articleId, double version, int status, String articleURL, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
          Updates the workflow status of the web content article matching the group, article ID, and version.
static void updateTemplateId(long groupId, long classNameId, String oldDDMTemplateKey, String newDDMTemplateKey)
          Deprecated. As of 7.0.0, replaced by updateDDMTemplateKey(long, long, java.lang.String, java.lang.String)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalArticleLocalServiceUtil

public JournalArticleLocalServiceUtil()
Method Detail

addArticle

public static JournalArticle addArticle(long userId,
                                        long groupId,
                                        long folderId,
                                        long classNameId,
                                        long classPK,
                                        String articleId,
                                        boolean autoArticleId,
                                        double version,
                                        Map<Locale,String> titleMap,
                                        Map<Locale,String> descriptionMap,
                                        String content,
                                        String ddmStructureKey,
                                        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,
                                        String smallImageURL,
                                        File smallImageFile,
                                        Map<String,byte[]> images,
                                        String articleURL,
                                        ServiceContext serviceContext)
                                 throws PortalException
Adds a web content article with additional parameters.

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>
 
 

Parameters:
userId - the primary key of the web content article's creator/owner
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#CLASSNAME_ID_DEFAULT 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
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
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null 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
smallImageURL - the web content article's small image URL
smallImageFile - 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, 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

addArticle

public static JournalArticle addArticle(long userId,
                                        long groupId,
                                        long folderId,
                                        Map<Locale,String> titleMap,
                                        Map<Locale,String> descriptionMap,
                                        String content,
                                        String ddmStructureKey,
                                        String ddmTemplateKey,
                                        ServiceContext serviceContext)
                                 throws PortalException
Adds a web content article.

Parameters:
userId - the primary key of the web content article's creator/owner
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 addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, String, ServiceContext) description.
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null 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, 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

addArticleResources

public static void addArticleResources(JournalArticle article,
                                       boolean addGroupPermissions,
                                       boolean addGuestPermissions)
                                throws PortalException
Adds the resources to the web content article.

Parameters:
article - the web content article
addGroupPermissions - whether to add group permissions
addGuestPermissions - whether to add guest permissions
Throws:
PortalException - if no portal actions could be found associated with the web content article or if a portal exception occurred

addArticleResources

public static void addArticleResources(JournalArticle article,
                                       String[] groupPermissions,
                                       String[] guestPermissions)
                                throws PortalException
Adds the model resources with the permissions to the web content article.

Parameters:
article - the web content article to add resources to
groupPermissions - the group permissions to be added
guestPermissions - the guest permissions to be added
Throws:
PortalException - if a portal exception occurred

addArticleResources

public static void addArticleResources(long groupId,
                                       String articleId,
                                       boolean addGroupPermissions,
                                       boolean addGuestPermissions)
                                throws PortalException
Adds the resources to the most recently created web content article.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
addGroupPermissions - whether to add group permissions
addGuestPermissions - whether to add guest permissions
Throws:
PortalException - if a portal exception occurred

addArticleResources

public static void addArticleResources(long groupId,
                                       String articleId,
                                       String[] groupPermissions,
                                       String[] guestPermissions)
                                throws PortalException
Adds the resources with the permissions to the most recently created web content article.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
groupPermissions - the group permissions to be added
guestPermissions - the guest permissions to be added
Throws:
PortalException - if a portal exception occurred

addJournalArticle

public static JournalArticle addJournalArticle(JournalArticle journalArticle)
Adds the journal article to the database. Also notifies the appropriate model listeners.

Parameters:
journalArticle - the journal article
Returns:
the journal article that was added

checkArticleResourcePrimKey

public static JournalArticle checkArticleResourcePrimKey(long groupId,
                                                         String articleId,
                                                         double version)
                                                  throws PortalException
Returns the web content article with the group, article ID, and version. This method checks for the article's resource primary key and, if not found, creates a new one.

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 matching web content article could not be found

checkArticles

public static void checkArticles()
                          throws PortalException
Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.

Throws:
PortalException - if a portal exception occurred

checkNewLine

public static void checkNewLine(long groupId,
                                String articleId,
                                double version)
                         throws PortalException
Checks the web content article matching the group, article ID, and version, replacing escaped newline and return characters with non-escaped newline and return characters.

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
Throws:
PortalException - if a matching web content article could not be found

checkStructure

public static void checkStructure(long groupId,
                                  String articleId,
                                  double version)
                           throws PortalException
Checks the web content article matching the group, article ID, and version for an associated structure. If no structure is associated, return; otherwise check that the article and structure match.

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
Throws:
PortalException - if a matching web content article could not be found, if the article's structure does not match it, or if a portal exception occurred

copyArticle

public static JournalArticle copyArticle(long userId,
                                         long groupId,
                                         String oldArticleId,
                                         String newArticleId,
                                         boolean autoArticleId,
                                         double version)
                                  throws 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.

Parameters:
userId - the primary key of the web content article's creator/owner
groupId - the primary key of the web content article's group
oldArticleId - the primary key of the old web content article
newArticleId - 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 matching web content article could not be found or if a portal exception occurred

createJournalArticle

public static JournalArticle createJournalArticle(long id)
Creates a new journal article with the primary key. Does not add the journal article to the database.

Parameters:
id - the primary key for the new journal article
Returns:
the new journal article

deleteArticle

public static JournalArticle deleteArticle(JournalArticle article)
                                    throws PortalException
Deletes the web content article and its resources.

Parameters:
article - the web content article
Returns:
the deleted web content article
Throws:
PortalException - if a portal exception occurred

deleteArticle

public static JournalArticle deleteArticle(JournalArticle article,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException
Deletes the web content article and its resources, optionally sending email notifying denial of the article if it had not yet been approved.

Parameters:
article - the web content article
articleURL - the web content article's accessible URL to include in email notifications (optionally null)
serviceContext - the service context to be applied (optionally null). Can set the portlet preferences that include email information to notify recipients of the unapproved web content's denial.
Returns:
the deleted web content article
Throws:
PortalException - if a portal exception occurred

deleteArticle

public static void deleteArticle(long groupId,
                                 String articleId,
                                 ServiceContext serviceContext)
                          throws 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.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
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

deleteArticle

public static JournalArticle deleteArticle(long groupId,
                                           String articleId,
                                           double version,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws 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.

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.
Returns:
the deleted web content article
Throws:
PortalException - if a matching web content article could not be found or if a portal exception occurred

deleteArticles

public static void deleteArticles(long groupId)
                           throws PortalException
Deletes all the group's web content articles and resources.

Parameters:
groupId - the primary key of the web content article's group
Throws:
PortalException - if a portal exception occurred

deleteArticles

public static void deleteArticles(long groupId,
                                  long folderId)
                           throws PortalException
Deletes all the group's web content articles and resources in the folder, including recycled articles.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article folder
Throws:
PortalException - if a portal exception occurred

deleteArticles

public static void deleteArticles(long groupId,
                                  long folderId,
                                  boolean includeTrashedEntries)
                           throws PortalException
Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article folder
includeTrashedEntries - whether to include recycled web content articles
Throws:
PortalException - if a portal exception occurred

deleteJournalArticle

public static JournalArticle deleteJournalArticle(long id)
                                           throws PortalException
Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the journal article
Returns:
the journal article that was removed
Throws:
PortalException - if a journal article with the primary key could not be found

deleteJournalArticle

public static JournalArticle deleteJournalArticle(JournalArticle journalArticle)
Deletes the journal article from the database. Also notifies the appropriate model listeners.

Parameters:
journalArticle - the journal article
Returns:
the journal article that was removed

deleteLayoutArticleReferences

public static void deleteLayoutArticleReferences(long groupId,
                                                 String layoutUuid)
Deletes the layout's association with the web content articles for the group.

Parameters:
groupId - the primary key of the web content article's group
layoutUuid - the unique string identifying the web content article's display page

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
Performs a dynamic query on the database and returns a range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalArticleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalArticleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

expireArticle

public static void expireArticle(long userId,
                                 long groupId,
                                 String articleId,
                                 String articleURL,
                                 ServiceContext serviceContext)
                          throws 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.

Parameters:
userId - the primary key of the user updating the web content article
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 matching web content article could not be found or if a portal exception occurred

expireArticle

public static JournalArticle expireArticle(long userId,
                                           long groupId,
                                           String articleId,
                                           double version,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException
Expires the web content article matching the group, article ID, and version.

Parameters:
userId - the primary key of the user updating the web content article
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 matching web content article could not be found or if a portal exception occurred

fetchArticle

public static JournalArticle fetchArticle(long groupId,
                                          String articleId)

fetchArticle

public static JournalArticle fetchArticle(long groupId,
                                          String articleId,
                                          double version)
Returns the web content article matching the group, article ID, and version.

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 web content article matching the group, article ID, and version, or null if no web content article could be found

fetchArticleByUrlTitle

public static JournalArticle fetchArticleByUrlTitle(long groupId,
                                                    String urlTitle)

fetchDisplayArticle

public static JournalArticle fetchDisplayArticle(long groupId,
                                                 String articleId)

fetchJournalArticle

public static JournalArticle fetchJournalArticle(long id)

fetchJournalArticleByUuidAndGroupId

public static JournalArticle fetchJournalArticleByUuidAndGroupId(String uuid,
                                                                 long groupId)
Returns the journal article matching the UUID and group.

Parameters:
uuid - the journal article's UUID
groupId - the primary key of the group
Returns:
the matching journal article, or null if a matching journal article could not be found

fetchLatestArticle

public static JournalArticle fetchLatestArticle(long groupId,
                                                String articleId,
                                                int status)
Returns the latest web content article matching the group, article ID, and workflow status.

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, or null if no matching web content article could be found

fetchLatestArticle

public static JournalArticle fetchLatestArticle(long resourcePrimKey)

fetchLatestArticle

public static JournalArticle fetchLatestArticle(long resourcePrimKey,
                                                int status)

fetchLatestArticle

public static JournalArticle fetchLatestArticle(long resourcePrimKey,
                                                int status,
                                                boolean preferApproved)
Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.

Parameters:
resourcePrimKey - the primary key of the resource instance
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
preferApproved - whether to prefer returning the latest matching article that has workflow status WorkflowConstants#STATUS_APPROVED over returning one that has a different status
Returns:
the latest web content article matching the resource primary key and workflow status, optionally preferring articles with an approved workflow status, or null if no matching web content article could be found

fetchLatestArticle

public static JournalArticle fetchLatestArticle(long resourcePrimKey,
                                                int[] statuses)

fetchLatestArticleByUrlTitle

public static JournalArticle fetchLatestArticleByUrlTitle(long groupId,
                                                          String urlTitle,
                                                          int status)

fetchLatestIndexableArticle

public static JournalArticle fetchLatestIndexableArticle(long resourcePrimKey)
Returns the latest indexable web content article matching the resource primary key.

Parameters:
resourcePrimKey - the primary key of the resource instance
Returns:
the latest indexable web content article matching the resource primary key, or null if no matching web content article could be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getArticle

public static JournalArticle getArticle(long groupId,
                                        String articleId)
                                 throws 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.

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 matching web content article could not be found

getArticle

public static JournalArticle getArticle(long groupId,
                                        String articleId,
                                        double version)
                                 throws PortalException
Returns the web content article matching the group, article ID, and version.

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 matching web content article could not be found

getArticle

public static JournalArticle getArticle(long groupId,
                                        String className,
                                        long classPK)
                                 throws PortalException
Returns the web content article matching the group, class name, and class PK.

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#CLASSNAME_ID_DEFAULT otherwise
classPK - the primary key of the DDM structure, if the 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 matching web content article could not be found

getArticle

public static JournalArticle getArticle(long id)
                                 throws PortalException
Returns the web content article with the ID.

Parameters:
id - the primary key of the web content article
Returns:
the web content article with the ID
Throws:
PortalException - if a matching web content article could not be found

getArticleByUrlTitle

public static JournalArticle getArticleByUrlTitle(long groupId,
                                                  String urlTitle)
                                           throws 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.

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

getArticleContent

public static String getArticleContent(JournalArticle article,
                                       String ddmTemplateKey,
                                       String viewMode,
                                       String languageId,
                                       PortletRequestModel portletRequestModel,
                                       ThemeDisplay themeDisplay)
                                throws PortalException
Returns the web content from the web content article associated with the portlet request model and the DDM template.

Parameters:
article - the web content article
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content from the web content article associated with the portlet request model and the DDM template
Throws:
PortalException - if a matching DDM template could not be found, or if a portal exception occurred

getArticleContent

@Deprecated
public static String getArticleContent(JournalArticle article,
                                                  String ddmTemplateKey,
                                                  String viewMode,
                                                  String languageId,
                                                  ThemeDisplay themeDisplay)
                                throws PortalException
Deprecated. As of 7.0.0, replaced by getArticleContent(JournalArticle, String, String, String, PortletRequestModel,ThemeDisplay)

Returns the web content from the web content article associated with the DDM template.

Parameters:
article - the web content article
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content from the matching web content article
Throws:
PortalException - if a matching DDM template could not be found, or if a portal exception occurred

getArticleContent

public static String getArticleContent(long groupId,
                                       String articleId,
                                       double version,
                                       String viewMode,
                                       String ddmTemplateKey,
                                       String languageId,
                                       PortletRequestModel portletRequestModel,
                                       ThemeDisplay themeDisplay)
                                throws PortalException
Returns the web content from the web content article matching the group, article ID, and version, and associated with the portlet request model and the DDM template.

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
viewMode - the mode in which the web content is being viewed
ddmTemplateKey - the primary key of the web content article's DDM template
languageId - the primary key of the language translation to get
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleContent

@Deprecated
public static String getArticleContent(long groupId,
                                                  String articleId,
                                                  double version,
                                                  String viewMode,
                                                  String ddmTemplateKey,
                                                  String languageId,
                                                  ThemeDisplay themeDisplay)
                                throws PortalException
Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, double, String, String, String, PortletRequestModel, ThemeDisplay)

Returns the web content from the web content article matching the group, article ID, and version, and associated with the DDM template.

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
viewMode - the mode in which the web content is being viewed
ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleContent

@Deprecated
public static String getArticleContent(long groupId,
                                                  String articleId,
                                                  double version,
                                                  String viewMode,
                                                  String languageId,
                                                  ThemeDisplay themeDisplay)
                                throws PortalException
Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, double, String, String, String, PortletRequestModel, ThemeDisplay)

Returns the web content from the web content article matching the group, article ID, and version.

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
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleContent

public static String getArticleContent(long groupId,
                                       String articleId,
                                       String viewMode,
                                       String ddmTemplateKey,
                                       String languageId,
                                       PortletRequestModel portletRequestModel,
                                       ThemeDisplay themeDisplay)
                                throws PortalException
Returns the latest web content from the web content article matching the group and article ID, and associated with the portlet request model and the DDM template.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
viewMode - the mode in which the web content is being viewed
ddmTemplateKey - the primary key of the web content article's DDM template
languageId - the primary key of the language translation to get
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the latest web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleContent

@Deprecated
public static String getArticleContent(long groupId,
                                                  String articleId,
                                                  String viewMode,
                                                  String ddmTemplateKey,
                                                  String languageId,
                                                  ThemeDisplay themeDisplay)
                                throws PortalException
Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, String, String, String, PortletRequestModel, ThemeDisplay)

Returns the latest web content from the web content article matching the group and article ID, and associated with the DDM template.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
viewMode - the mode in which the web content is being viewed
ddmTemplateKey - the primary key of the web content article's DDM template
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the latest web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleContent

@Deprecated
public static String getArticleContent(long groupId,
                                                  String articleId,
                                                  String viewMode,
                                                  String languageId,
                                                  ThemeDisplay themeDisplay)
                                throws PortalException
Deprecated. As of 7.0.0, replaced by getArticleContent(long, String, String, String, String, PortletRequestModel, ThemeDisplay)

Returns the latest web content from the web content article matching the group and article ID.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the latest web content from the matching web content article
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(JournalArticle article,
                                                      String ddmTemplateKey,
                                                      String viewMode,
                                                      String languageId,
                                                      int page,
                                                      PortletRequestModel portletRequestModel,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the specified page of the latest version of the web content article, based on the DDM template. Web content transformation tokens are added using the portlet request model and theme display.

Parameters:
article - the primary key of the web content article
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
page - the web content article page to display
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      String ddmTemplateKey,
                                                      String viewMode,
                                                      String languageId,
                                                      int page,
                                                      PortletRequestModel portletRequestModel,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the specified page of the latest version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added using the portlet request model and theme display.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
page - the web content article page to display
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      String ddmTemplateKey,
                                                      String viewMode,
                                                      String languageId,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the first page of the latest version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added from the theme display (if not null).

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      double version,
                                                      String ddmTemplateKey,
                                                      String viewMode,
                                                      String languageId,
                                                      int page,
                                                      PortletRequestModel portletRequestModel,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the specified page of the specified version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added using the portlet request model and theme display.

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
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
page - the web content article page to display
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      double version,
                                                      String ddmTemplateKey,
                                                      String viewMode,
                                                      String languageId,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the first page of the specified version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added from the theme display (if not null).

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
ddmTemplateKey - the primary key of the web content article's DDM template
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      String viewMode,
                                                      String languageId,
                                                      int page,
                                                      PortletRequestModel portletRequestModel,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the specified page of the latest version of the web content article matching the group and article ID. Web content transformation tokens are added from the theme display (if not null).

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
page - the web content article page to display
portletRequestModel - the portlet request model
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a portal exception occurred

getArticleDisplay

public static JournalArticleDisplay getArticleDisplay(long groupId,
                                                      String articleId,
                                                      String viewMode,
                                                      String languageId,
                                                      ThemeDisplay themeDisplay)
                                               throws PortalException
Returns a web content article display for the first page of the latest version of the web content article matching the group and article ID. Web content transformation tokens are added from the theme display (if not null).

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
viewMode - the mode in which the web content is being viewed
languageId - the primary key of the language translation to get
themeDisplay - the theme display
Returns:
the web content article display, or null if the article has expired or if article's display date/time is after the current date/time
Throws:
PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred

getArticles

public static List<JournalArticle> getArticles()
Returns all the web content articles present in the system.

Returns:
the web content articles present in the system

getArticles

public static List<JournalArticle> getArticles(long groupId)
Returns all the web content articles belonging to the group.

Parameters:
groupId - the primary key of the web content article's group
Returns:
the web content articles belonging to the group

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               String articleId)
Returns all the web content articles matching the group and article ID.

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 articles

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               String articleId,
                                               int start,
                                               int end,
                                               OrderByComparator<JournalArticle> orderByComparator)

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               long folderId)
Returns all the web content articles matching the group and folder.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article folder
Returns:
the matching web content articles

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               long folderId,
                                               int start,
                                               int end)
Returns a range of all the web content articles matching the group and folder.

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.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article's folder
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

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator<JournalArticle> orderByComparator)
Returns an ordered range of all the web content articles matching the group and folder.

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.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article's folder
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

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               long folderId,
                                               int status,
                                               int start,
                                               int end)
Returns a range of all the web content articles matching the group, folder, and 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.

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.
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

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               int start,
                                               int end)
Returns a range of all the web content articles belonging to 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.

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

getArticles

public static List<JournalArticle> getArticles(long groupId,
                                               int start,
                                               int end,
                                               OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles belonging to 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.

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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

getArticlesByResourcePrimKey

public static List<JournalArticle> getArticlesByResourcePrimKey(long resourcePrimKey)
Returns all the web content articles matching the resource primary key.

Parameters:
resourcePrimKey - the primary key of the resource instance
Returns:
the web content articles matching the resource primary key

getArticlesBySmallImageId

public static List<JournalArticle> getArticlesBySmallImageId(long smallImageId)
Returns all the web content articles matching the small image ID.

Parameters:
smallImageId - the primary key of the web content article's small image
Returns:
the web content articles matching the small image ID

getArticlesCount

public static int getArticlesCount(long groupId)
Returns the number of web content articles belonging to the group.

Parameters:
groupId - the primary key of the web content article's group
Returns:
the number of web content articles belonging to the group

getArticlesCount

public static int getArticlesCount(long groupId,
                                   String articleId)

getArticlesCount

public static int getArticlesCount(long groupId,
                                   long folderId)
Returns the number of web content articles matching the group and folder.

Parameters:
groupId - the primary key of the web content article's group
folderId - the primary key of the web content article's folder
Returns:
the number of matching web content articles

getArticlesCount

public static int getArticlesCount(long groupId,
                                   long folderId,
                                   int status)
Returns the number of web content articles matching the group, folder, and status.

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

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getCompanyArticles

public static List<JournalArticle> getCompanyArticles(long companyId,
                                                      int status,
                                                      int start,
                                                      int end)
Returns an ordered range of all the web content articles matching the company 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.

Parameters:
companyId - the primary key of the web content article's company
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)
Returns:
the range of matching web content articles ordered by article ID

getCompanyArticles

public static List<JournalArticle> getCompanyArticles(long companyId,
                                                      double version,
                                                      int status,
                                                      int start,
                                                      int end)
Returns an ordered range of all the web content articles matching the company, version, 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.

Parameters:
companyId - the primary key of the web content article's company
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.
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 ordered by article ID

getCompanyArticlesCount

public static int getCompanyArticlesCount(long companyId,
                                          int status)
Returns the number of web content articles matching the company and workflow status.

Parameters:
companyId - the primary key of the web content article's company
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

getCompanyArticlesCount

public static int getCompanyArticlesCount(long companyId,
                                          double version,
                                          int status,
                                          int start,
                                          int end)
Returns the number of web content articles matching the company, version, 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.

Parameters:
companyId - the primary key of the web content article's company
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.
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 number of matching web content articles

getDisplayArticle

public static JournalArticle getDisplayArticle(long groupId,
                                               String articleId)
                                        throws PortalException
Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed.

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 currently displayed, or the next one to be displayed if no version of the article is currently displayed
Throws:
PortalException - if no approved matching web content articles could be found

getDisplayArticleByUrlTitle

public static JournalArticle getDisplayArticleByUrlTitle(long groupId,
                                                         String urlTitle)
                                                  throws 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.

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 no approved matching web content articles could be found

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableArticlesByDDMStructureKey

public static List<JournalArticle> getIndexableArticlesByDDMStructureKey(String[] ddmStructureKeys)

getIndexableArticlesByResourcePrimKey

public static List<JournalArticle> getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
Returns the indexable web content articles matching the resource primary key.

Parameters:
resourcePrimKey - the primary key of the resource instance
Returns:
the indexable web content articles matching the resource primary key

getJournalArticle

public static JournalArticle getJournalArticle(long id)
                                        throws PortalException
Returns the journal article with the primary key.

Parameters:
id - the primary key of the journal article
Returns:
the journal article
Throws:
PortalException - if a journal article with the primary key could not be found

getJournalArticleByUuidAndGroupId

public static JournalArticle getJournalArticleByUuidAndGroupId(String uuid,
                                                               long groupId)
                                                        throws PortalException
Returns the journal article matching the UUID and group.

Parameters:
uuid - the journal article's UUID
groupId - the primary key of the group
Returns:
the matching journal article
Throws:
PortalException - if a matching journal article could not be found

getJournalArticles

public static List<JournalArticle> getJournalArticles(int start,
                                                      int end)
Returns a range of all the journal articles.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from JournalArticleModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of journal articles
end - the upper bound of the range of journal articles (not inclusive)
Returns:
the range of journal articles

getJournalArticlesByUuidAndCompanyId

public static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid,
                                                                        long companyId)
Returns all the journal articles matching the UUID and company.

Parameters:
uuid - the UUID of the journal articles
companyId - the primary key of the company
Returns:
the matching journal articles, or an empty list if no matches were found

getJournalArticlesByUuidAndCompanyId

public static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid,
                                                                        long companyId,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator<JournalArticle> orderByComparator)
Returns a range of journal articles matching the UUID and company.

Parameters:
uuid - the UUID of the journal articles
companyId - the primary key of the company
start - the lower bound of the range of journal articles
end - the upper bound of the range of journal articles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching journal articles, or an empty list if no matches were found

getJournalArticlesCount

public static int getJournalArticlesCount()
Returns the number of journal articles.

Returns:
the number of journal articles

getLatestArticle

public static JournalArticle getLatestArticle(long groupId,
                                              String articleId)
                                       throws PortalException
Returns the latest web content article with the group and article ID.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
Returns:
the latest matching web content article
Throws:
PortalException - if a matching web content article could not be found

getLatestArticle

public static JournalArticle getLatestArticle(long groupId,
                                              String articleId,
                                              int status)
                                       throws PortalException
Returns the latest web content article matching the group, article ID, and workflow status.

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 matching web content article could not be found

getLatestArticle

public static JournalArticle getLatestArticle(long groupId,
                                              String className,
                                              long classPK)
                                       throws PortalException
Returns the latest web content article matching the group, class name ID, and class PK.

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#CLASSNAME_ID_DEFAULT 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 matching web content article could not be found

getLatestArticle

public static JournalArticle getLatestArticle(long resourcePrimKey)
                                       throws PortalException
Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.

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 matching web content article could not be found

getLatestArticle

public static JournalArticle getLatestArticle(long resourcePrimKey,
                                              int status)
                                       throws PortalException
Returns the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status.

Parameters:
resourcePrimKey - the primary key of the resource instance
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
Returns:
the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status
Throws:
PortalException - if a matching web content article could not be found

getLatestArticle

public static JournalArticle getLatestArticle(long resourcePrimKey,
                                              int status,
                                              boolean preferApproved)
                                       throws PortalException
Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.

Parameters:
resourcePrimKey - the primary key of the resource instance
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
preferApproved - whether to prefer returning the latest matching article that has workflow status WorkflowConstants#STATUS_APPROVED over returning one that has a different status
Returns:
the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status
Throws:
PortalException - if a matching web content article could not be found

getLatestArticleByUrlTitle

public static JournalArticle getLatestArticleByUrlTitle(long groupId,
                                                        String urlTitle,
                                                        int status)
                                                 throws PortalException
Returns the latest web content article matching the group, URL title, and workflow status.

Parameters:
groupId - the primary key of the web content article's group
urlTitle - the web content article's accessible URL title
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 matching web content article could not be found

getLatestVersion

public static double getLatestVersion(long groupId,
                                      String articleId)
                               throws PortalException
Returns the latest version number of the web content with the group and article ID.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
Returns:
the latest version number of the matching web content
Throws:
PortalException - if a matching web content article could not be found

getLatestVersion

public static double getLatestVersion(long groupId,
                                      String articleId,
                                      int status)
                               throws PortalException
Returns the latest version number of the web content with the group, article ID, and workflow status.

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 version number of the matching web content
Throws:
PortalException - if a matching web content article could not be found

getNoAssetArticles

public static List<JournalArticle> getNoAssetArticles()

getNoPermissionArticles

public static List<JournalArticle> getNoPermissionArticles()

getNotInTrashArticlesCount

public static int getNotInTrashArticlesCount(long groupId,
                                             long folderId)
Returns the number of web content articles that are not recycled.

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 web content articles that are not recycled

getOldestArticle

public static JournalArticle getOldestArticle(long groupId,
                                              String articleId)
                                       throws PortalException
Returns the oldest web content article with the group and article ID.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
Returns:
the oldest matching web content article
Throws:
PortalException - if a matching web content article could not be found

getOldestArticle

public static JournalArticle getOldestArticle(long groupId,
                                              String articleId,
                                              int status)
                                       throws PortalException
Returns the oldest web content article matching the group, article ID, and workflow status.

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 oldest matching web content article
Throws:
PortalException - if a matching web content article could not be found

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getPreviousApprovedArticle

public static JournalArticle getPreviousApprovedArticle(JournalArticle article)
Returns the previously approved version of the web content article. For more information on the approved workflow status, see WorkflowConstants#STATUS_APPROVED.

Parameters:
article - the web content article
Returns:
the previously approved version of the web content article, or the current web content article if there are no previously approved web content articles

getStructureArticles

public static List<JournalArticle> getStructureArticles(String[] ddmStructureKeys)
Returns the web content articles matching the DDM structure keys.

Parameters:
ddmStructureKeys - the primary keys of the web content article's DDM structures
Returns:
the web content articles matching the DDM structure keys

getStructureArticles

public static List<JournalArticle> getStructureArticles(long groupId,
                                                        String ddmStructureKey)
Returns the web content articles matching the group and DDM structure key.

Parameters:
groupId - the primary key of the web content article's group
ddmStructureKey - the primary key of the web content article's DDM structure
Returns:
the matching web content articles

getStructureArticles

public static List<JournalArticle> getStructureArticles(long groupId,
                                                        String ddmStructureKey,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group 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.

Parameters:
groupId - the primary key of the web content article's group
ddmStructureKey - 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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

getStructureArticlesCount

public static int getStructureArticlesCount(long groupId,
                                            String ddmStructureKey)
Returns the number of web content articles matching the group and DDM structure key.

Parameters:
groupId - the primary key of the web content article's group
ddmStructureKey - the primary key of the web content article's DDM structure
Returns:
the number of matching web content articles

getTemplateArticles

public static List<JournalArticle> getTemplateArticles(long groupId,
                                                       String ddmTemplateKey)
Returns the web content articles matching the group and DDM template key.

Parameters:
groupId - the primary key of the web content article's group
ddmTemplateKey - the primary key of the web content article's DDM template
Returns:
the matching web content articles

getTemplateArticles

public static List<JournalArticle> getTemplateArticles(long groupId,
                                                       String ddmTemplateKey,
                                                       int start,
                                                       int end,
                                                       OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group and DDM template 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.

Parameters:
groupId - the primary key of the web content article's group
ddmTemplateKey - the primary key of the web content article's DDM template
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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

getTemplateArticlesCount

public static int getTemplateArticlesCount(long groupId,
                                           String ddmTemplateKey)
Returns the number of web content articles matching the group and DDM template key.

Parameters:
groupId - the primary key of the web content article's group
ddmTemplateKey - the primary key of the web content article's DDM template
Returns:
the number of matching web content articles

getUniqueUrlTitle

public static String getUniqueUrlTitle(long groupId,
                                       String articleId,
                                       String urlTitle)
                                throws PortalException
Returns the web content article's unique URL title.

Parameters:
groupId - the primary key of the web content article's group
articleId - the primary key of the web content article
urlTitle - the web content article's accessible URL title
Returns:
the web content article's unique URL title
Throws:
PortalException - if a portal exception occurred

hasArticle

public static boolean hasArticle(long groupId,
                                 String articleId)
Returns true if the specified web content article exists.

Parameters:
groupId - the primary key of the group
articleId - the primary key of the web content article
Returns:
true if the specified web content article exists; false otherwise

isLatestVersion

public static boolean isLatestVersion(long groupId,
                                      String articleId,
                                      double version)
                               throws PortalException
Returns true if the web content article, specified by group and article ID, is the latest version.

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:
true if the specified web content article is the latest version; false otherwise
Throws:
PortalException - if a matching web content article could not be found

isLatestVersion

public static boolean isLatestVersion(long groupId,
                                      String articleId,
                                      double version,
                                      int status)
                               throws PortalException
Returns true if the web content article, specified by group, article ID, and workflow status, is the latest version.

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.
Returns:
true if the specified web content article is the latest version; false otherwise
Throws:
PortalException - if a matching web content article could not be found

isRenderable

public static boolean isRenderable(JournalArticle article,
                                   PortletRequestModel portletRequestModel,
                                   ThemeDisplay themeDisplay)

moveArticle

@Deprecated
public static JournalArticle moveArticle(long groupId,
                                                    String articleId,
                                                    long newFolderId)
                                  throws PortalException
Deprecated. As of 7.0.0, replaced by moveArticle(long, String, long, ServiceContext)

Moves the web content article matching the group and article ID to a new folder.

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
Returns:
the updated web content article, which was moved to a new folder
Throws:
PortalException - if a matching web content article could not be found

moveArticle

public static JournalArticle moveArticle(long groupId,
                                         String articleId,
                                         long newFolderId,
                                         ServiceContext serviceContext)
                                  throws PortalException
Moves the web content article matching the group and article ID to a new folder.

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.
Returns:
the updated web content article, which was moved to a new folder
Throws:
PortalException - if a matching web content article could not be found

moveArticleFromTrash

public static JournalArticle moveArticleFromTrash(long userId,
                                                  long groupId,
                                                  JournalArticle article,
                                                  long newFolderId,
                                                  ServiceContext serviceContext)
                                           throws PortalException
Moves the web content article from the Recycle Bin to a new folder.

Parameters:
userId - the primary key of the user updating the web content article
groupId - the primary key of the web content article's group
article - 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 a new folder
Throws:
PortalException - if a trashed web content article with the primary key could not be found or if a portal exception occurred

moveArticleToTrash

public static JournalArticle moveArticleToTrash(long userId,
                                                JournalArticle article)
                                         throws PortalException
Moves the latest version of the web content article matching the group and article ID to the recycle bin.

Parameters:
userId - the primary key of the user updating the web content article
article - the web content article
Returns:
the updated web content article, which was moved to the Recycle Bin
Throws:
PortalException - if the user did not have permission to move the article to the Recycle Bin or if a portal exception occurred

moveArticleToTrash

public static JournalArticle moveArticleToTrash(long userId,
                                                long groupId,
                                                String articleId)
                                         throws PortalException
Moves the latest version of the web content article matching the group and article ID to the recycle bin.

Parameters:
userId - the primary key of the user updating the web content article
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 the user did not have permission to move the article to the Recycle Bin or if a portal exception occurred

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException
Rebuilds the web content article's tree path using tree traversal.

For example, here is a conceptualization of a web content article tree path:

 
 /(Folder's folderId)/(Subfolder's folderId)/(article's articleId)
 
 

Parameters:
companyId - the primary key of the web content article's company
Throws:
PortalException - if a portal exception occurred

removeArticleLocale

public static JournalArticle removeArticleLocale(long groupId,
                                                 String articleId,
                                                 double version,
                                                 String languageId)
                                          throws PortalException
Removes the web content of the web content article matching the group, article ID, and version, and language.

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 matching web content article could not be found

restoreArticleFromTrash

public static JournalArticle restoreArticleFromTrash(long userId,
                                                     JournalArticle article)
                                              throws PortalException
Restores the web content article from the Recycle Bin.

Parameters:
userId - the primary key of the user restoring the web content article
article - the web content article
Returns:
the restored web content article from the Recycle Bin
Throws:
PortalException - if the web content article with the primary key could not be found in the Recycle Bin, if the user did not have permission to restore the article, or if a portal exception occurred

search

public static Hits search(long companyId,
                          long groupId,
                          List<Long> folderIds,
                          long classNameId,
                          String articleId,
                          String title,
                          String description,
                          String content,
                          int status,
                          String ddmStructureKey,
                          String ddmTemplateKey,
                          LinkedHashMap<String,Object> params,
                          boolean andSearch,
                          int start,
                          int end,
                          Sort sort)
Returns an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, an AND operator switch, and parameters for type, status, a finder hash map. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
params - the finder parameters (optionally null). The includeDiscussions parameter can be set to true to search for the keywords in the web content article discussions.
andSearch - whether every field must match its value or keywords, or just one field must match
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)
sort - the field, type, and direction by which to sort (optionally null)
Returns:
the matching web content articles ordered by sort

search

@Deprecated
public static Hits search(long companyId,
                                     long groupId,
                                     List<Long> folderIds,
                                     long classNameId,
                                     String articleId,
                                     String title,
                                     String description,
                                     String content,
                                     String type,
                                     String statusString,
                                     String ddmStructureKey,
                                     String ddmTemplateKey,
                                     LinkedHashMap<String,Object> params,
                                     boolean andSearch,
                                     int start,
                                     int end,
                                     Sort sort)
Deprecated. As of 7.0.0, replaced by search(long, long, List, long, String, String, String, String, int, String, String, LinkedHashMap, boolean, int, int, Sort)


search

public static List<JournalArticle> search(long companyId,
                                          long groupId,
                                          List<Long> folderIds,
                                          long classNameId,
                                          String articleId,
                                          Double version,
                                          String title,
                                          String description,
                                          String content,
                                          String ddmStructureKey,
                                          String ddmTemplateKey,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          boolean andOperator,
                                          int start,
                                          int end,
                                          OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters without using the indexer, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch. It is preferable to use the indexed version search(long, long, List, long, String, String, String, String, int, String, String, LinkedHashMap, boolean, int, int, Sort) instead of this method wherever possible for performance reasons.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
version - the web content article's version (optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
andOperator - whether every field must match its value or keywords, or just one field must match. Company, group, folder IDs, class name ID, and status must all match their values.
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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

search

public static List<JournalArticle> search(long companyId,
                                          long groupId,
                                          List<Long> folderIds,
                                          long classNameId,
                                          String articleId,
                                          Double version,
                                          String title,
                                          String description,
                                          String content,
                                          String[] ddmStructureKeys,
                                          String[] ddmTemplateKeys,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          boolean andOperator,
                                          int start,
                                          int end,
                                          OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters without using the indexer, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
version - the web content article's version (optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
ddmStructureKeys - the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise
ddmTemplateKeys - the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it.
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
andOperator - whether every field must match its value or keywords, or just one field must match. Company, group, folder IDs, class name ID, and status must all match their values.
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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

search

public static Hits search(long companyId,
                          long groupId,
                          List<Long> folderIds,
                          long classNameId,
                          String ddmStructureKey,
                          String ddmTemplateKey,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          Sort sort)
Returns an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, and a finder hash map parameter. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.
params - the finder parameters (optionally null)
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)
sort - the field, type, and direction by which to sort (optionally null)
Returns:
the matching web content articles ordered by sort

search

public static List<JournalArticle> search(long companyId,
                                          long groupId,
                                          List<Long> folderIds,
                                          long classNameId,
                                          String keywords,
                                          Double version,
                                          String ddmStructureKey,
                                          String ddmTemplateKey,
                                          Date displayDateGT,
                                          Date displayDateLT,
                                          int status,
                                          Date reviewDate,
                                          int start,
                                          int end,
                                          OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters without using the indexer, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter. It is preferable to use the indexed version search(long, long, List, long, String, String, String, LinkedHashMap, int, int, Sort) instead of this method wherever possible for performance reasons.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.
version - the web content article's version (optionally null)
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
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)
obc - the comparator to order the web content articles
Returns:
the range of matching web content articles ordered by the comparator

search

public static List<JournalArticle> search(long groupId,
                                          long folderId,
                                          int status,
                                          int start,
                                          int end)
Returns a range of all the web content articles in a single folder matching the parameters without using the indexer. It is preferable to use the indexed version search(long, long, long, int, int, int) instead of this method wherever possible for performance reasons.

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.

Parameters:
groupId - the primary key of the group (optionally 0)
folderId - the primary key of the web content article folder
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)
Returns:
the matching web content articles

search

public static List<JournalArticle> search(long groupId,
                                          List<Long> folderIds,
                                          int status,
                                          int start,
                                          int end)
Returns a range of all the web content articles matching the parameters without using the indexer. It is preferable to use the indexed version search(long, long, long, int, int, int) instead of this method wherever possible for performance reasons.

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.

Parameters:
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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)
Returns:
the matching web content articles

search

public static Hits search(long groupId,
                          long userId,
                          long creatorUserId,
                          int status,
                          int start,
                          int end)
                   throws PortalException
Returns a range of all the web content articles matching the group, creator, and status using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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.

Parameters:
groupId - the primary key of the group (optionally 0)
userId - the primary key of the user searching for web content articles
creatorUserId - the primary key of the web content article's creator
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)
Returns:
the matching web content articles
Throws:
PortalException - if a portal exception occurred

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              List<Long> folderIds,
                              long classNameId,
                              String articleId,
                              Double version,
                              String title,
                              String description,
                              String content,
                              String ddmStructureKey,
                              String ddmTemplateKey,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate,
                              boolean andOperator)
Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
version - the web content article's version (optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
andOperator - whether every field must match its value or keywords, or just one field must match. Group, folder IDs, class name ID, and status must all match their values.
Returns:
the number of matching web content articles

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              List<Long> folderIds,
                              long classNameId,
                              String articleId,
                              Double version,
                              String title,
                              String description,
                              String content,
                              String[] ddmStructureKeys,
                              String[] ddmTemplateKeys,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate,
                              boolean andOperator)
Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
version - the web content article's version (optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
ddmStructureKeys - the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise
ddmTemplateKeys - the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it.
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
andOperator - whether every field must match its value or keywords, or just one field must match. Group, folder IDs, class name ID, and status must all match their values.
Returns:
the number of matching web content articles

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              List<Long> folderIds,
                              long classNameId,
                              String keywords,
                              Double version,
                              String ddmStructureKey,
                              String ddmTemplateKey,
                              Date displayDateGT,
                              Date displayDateLT,
                              int status,
                              Date reviewDate)
Returns the number of web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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#CLASSNAME_ID_DEFAULT otherwise
keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.
version - the web content article's version (optionally null)
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise
ddmTemplateKey - the primary key of the web content article's DDM template
displayDateGT - the date after which a matching web content article's display date must be after (optionally null)
displayDateLT - the date before which a matching web content article's display date must be before (optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
reviewDate - the web content article's scheduled review date (optionally null)
Returns:
the number of matching web content articles

searchCount

public static int searchCount(long groupId,
                              long folderId,
                              int status)
Returns the number of web content articles matching the group, folder, and status.

Parameters:
groupId - the primary key of the group (optionally 0)
folderId - the primary key of the web content article 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

searchCount

public static int searchCount(long groupId,
                              List<Long> folderIds,
                              int status)
Returns the number of web content articles matching the group, folders, and status.

Parameters:
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
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

searchJournalArticles

public static BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId,
                                                                          long groupId,
                                                                          List<Long> folderIds,
                                                                          long classNameId,
                                                                          String articleId,
                                                                          String title,
                                                                          String description,
                                                                          String content,
                                                                          int status,
                                                                          String ddmStructureKey,
                                                                          String ddmTemplateKey,
                                                                          LinkedHashMap<String,Object> params,
                                                                          boolean andSearch,
                                                                          int start,
                                                                          int end,
                                                                          Sort sort)
                                                                   throws PortalException
Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including keyword parameters for article ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, an AND operator switch, and parameters for type, status, and a finder hash map. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

The start and end parameters only affect the amount of web content articles returned as results, not the total number of hits.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
classNameId - the primary key of the DDMStructure class, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise
articleId - the article ID keywords (space separated, optionally null)
title - the title keywords (space separated, optionally null)
description - the description keywords (space separated, optionally null)
content - the content keywords (space separated, optionally null)
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
ddmStructureKey - the primary key of the web content article's DDM structure
ddmTemplateKey - the primary key of the web content article's DDM template
params - the finder parameters (optionally null). The includeDiscussions parameter can be set to true to search for the keywords in the web content article discussions.
andSearch - whether every field must match its value or keywords, or just one field must match
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)
sort - the field, type, and direction by which to sort (optionally null)
Returns:
a BaseModelSearchResult containing the total number of hits and an ordered range of all the matching web content articles ordered by sort
Throws:
PortalException - if a portal exception occurred

searchJournalArticles

public static BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId,
                                                                          long groupId,
                                                                          List<Long> folderIds,
                                                                          long classNameId,
                                                                          String ddmStructureKey,
                                                                          String ddmTemplateKey,
                                                                          String keywords,
                                                                          LinkedHashMap<String,Object> params,
                                                                          int start,
                                                                          int end,
                                                                          Sort sort)
                                                                   throws PortalException
Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including a keywords parameter for matching an article's ID, title, description, or content, a DDM structure key parameter, a DDM template key parameter, and a finder hash map parameter. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

The start and end parameters only affect the amount of web content articles returned as results, not the total number of hits.

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.

Parameters:
companyId - the primary key of the web content article's company
groupId - the primary key of the group (optionally 0)
folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
classNameId - the primary key of the DDMStructure class, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise
ddmStructureKey - the primary key of the web content article's DDM structure
ddmTemplateKey - the primary key of the web content article's DDM template
keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.
params - the finder parameters (optionally null)
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)
sort - the field, type, and direction by which to sort (optionally null)
Returns:
a BaseModelSearchResult containing the total number of hits and an ordered range of all the matching web content articles ordered by sort
Throws:
PortalException - if a portal exception occurred

searchJournalArticles

public static BaseModelSearchResult<JournalArticle> searchJournalArticles(long groupId,
                                                                          long userId,
                                                                          long creatorUserId,
                                                                          int status,
                                                                          int start,
                                                                          int end)
                                                                   throws PortalException
Returns a BaseModelSearchResult containing the total number of hits and an ordered range of all the web content articles matching the parameters using the indexer, including the web content article's creator ID and status. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

The start and end parameters only affect the amount of web content articles returned as results, not the total number of hits.

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.

Parameters:
groupId - the primary key of the group (optionally 0)
userId - the primary key of the user searching for web content articles
creatorUserId - the primary key of the web content article's creator
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)
Returns:
a BaseModelSearchResult containing the total number of hits and an ordered range of all the matching web content articles ordered by sort
Throws:
PortalException - if a portal exception occurred

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

setTreePaths

public static void setTreePaths(long folderId,
                                String treePath,
                                boolean reindex)
                         throws PortalException
Throws:
PortalException

subscribeStructure

public static void subscribeStructure(long groupId,
                                      long userId,
                                      long ddmStructureId)
                               throws PortalException
Subscribes the user to changes in elements that belong to the web content article's DDM structure.

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 matching user or group could not be found

unsubscribeStructure

public static void unsubscribeStructure(long groupId,
                                        long userId,
                                        long ddmStructureId)
                                 throws PortalException
Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.

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 matching user or subscription could not be found

updateArticle

public static JournalArticle updateArticle(long userId,
                                           long groupId,
                                           long folderId,
                                           String articleId,
                                           double version,
                                           String content,
                                           ServiceContext serviceContext)
                                    throws PortalException
Updates the web content article matching the version, replacing its folder and content.

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
content - the HTML content wrapped in XML. For more information, see the content example in the addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, String, ServiceContext) description.
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, 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 user with the primary key or a matching web content article could not be found, or if a portal exception occurred

updateArticle

public static JournalArticle updateArticle(long userId,
                                           long groupId,
                                           long folderId,
                                           String articleId,
                                           double version,
                                           Map<Locale,String> titleMap,
                                           Map<Locale,String> descriptionMap,
                                           String content,
                                           String ddmStructureKey,
                                           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,
                                           String smallImageURL,
                                           File smallImageFile,
                                           Map<String,byte[]> images,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException
Updates the web content article with additional parameters.

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 addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, String, ServiceContext) description.
ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null 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 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.
smallImageURL - the web content article's small image URL (optionally null)
smallImageFile - 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, 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 user with the primary key or a matching web content article could not be found, or if a portal exception occurred

updateArticle

public static JournalArticle updateArticle(long userId,
                                           long groupId,
                                           long folderId,
                                           String articleId,
                                           double version,
                                           Map<Locale,String> titleMap,
                                           Map<Locale,String> descriptionMap,
                                           String content,
                                           String layoutUuid,
                                           ServiceContext serviceContext)
                                    throws PortalException
Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.

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 addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, 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, 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 user with the primary key or a matching web content article could not be found, or if a portal exception occurred

updateArticleTranslation

@Deprecated
public static JournalArticle updateArticleTranslation(long groupId,
                                                                 String articleId,
                                                                 double version,
                                                                 Locale locale,
                                                                 String title,
                                                                 String description,
                                                                 String content,
                                                                 Map<String,byte[]> images)
                                               throws PortalException
Deprecated. As of 6.2.0, replaced by updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)

Throws:
PortalException

updateArticleTranslation

public static JournalArticle updateArticleTranslation(long groupId,
                                                      String articleId,
                                                      double version,
                                                      Locale locale,
                                                      String title,
                                                      String description,
                                                      String content,
                                                      Map<String,byte[]> images,
                                                      ServiceContext serviceContext)
                                               throws PortalException
Updates the translation of the web content article.

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 addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, 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 user with the primary key or a matching web content article could not be found, or if a portal exception occurred

updateAsset

public static void updateAsset(long userId,
                               JournalArticle article,
                               long[] assetCategoryIds,
                               String[] assetTagNames,
                               long[] assetLinkEntryIds)
                        throws PortalException
Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary.

Parameters:
userId - the primary key of the user updating the web content article's asset
article - the web content article
assetCategoryIds - the primary keys of the new asset categories
assetTagNames - the new asset tag names
assetLinkEntryIds - the primary keys of the new asset link entries
Throws:
PortalException - if a portal exception occurred

updateContent

public static JournalArticle updateContent(long groupId,
                                           String articleId,
                                           double version,
                                           String content)
                                    throws PortalException
Updates the web content article matching the group, article ID, and version, replacing its content.

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
content - the HTML content wrapped in XML. For more information, see the content example in the addArticle(long, long, long, long, long, String, boolean, double, Map, Map, String, String, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, String, File, Map, String, ServiceContext) description.
Returns:
the updated web content article
Throws:
PortalException - if a matching web content article could not be found

updateDDMTemplateKey

public static void updateDDMTemplateKey(long groupId,
                                        long classNameId,
                                        String oldDDMTemplateKey,
                                        String newDDMTemplateKey)
Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one.

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#CLASSNAME_ID_DEFAULT otherwise
oldDDMTemplateKey - the primary key of the web content article's old DDM template
newDDMTemplateKey - the primary key of the web content article's new DDM template

updateJournalArticle

public static JournalArticle updateJournalArticle(JournalArticle journalArticle)
Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
journalArticle - the journal article
Returns:
the journal article that was updated

updateStatus

public static JournalArticle updateStatus(long userId,
                                          JournalArticle article,
                                          int status,
                                          String articleURL,
                                          ServiceContext serviceContext,
                                          Map<String,Serializable> workflowContext)
                                   throws PortalException
Updates the workflow status of the web content article.

Parameters:
userId - the primary key of the user updating the web content article's status
article - the web content article
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, status date, and portlet preferences. 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.
workflowContext - the web content article's configured workflow context
Returns:
the updated web content article
Throws:
PortalException - if a portal exception occurred

updateStatus

public static JournalArticle updateStatus(long userId,
                                          long classPK,
                                          int status,
                                          Map<String,Serializable> workflowContext,
                                          ServiceContext serviceContext)
                                   throws PortalException
Updates the workflow status of the web content article matching the class PK.

Parameters:
userId - the primary key of the user updating the web content article's status
classPK - the primary key of the DDM structure, if the web content article is related to a DDM structure, the primary key of the class associated with the article, or 0 otherwise
status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
workflowContext - the web content article's configured workflow
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 matching web content article could not be found or if a portal exception occurred

updateStatus

public static JournalArticle updateStatus(long userId,
                                          long groupId,
                                          String articleId,
                                          double version,
                                          int status,
                                          String articleURL,
                                          Map<String,Serializable> workflowContext,
                                          ServiceContext serviceContext)
                                   throws PortalException
Updates the workflow status of the web content article matching the group, article ID, and version.

Parameters:
userId - the primary key of the user updating the web content article's status
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
workflowContext - the web content article's configured workflow
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 matching web content article could not be found or if a portal exception occurred

updateTemplateId

@Deprecated
public static void updateTemplateId(long groupId,
                                               long classNameId,
                                               String oldDDMTemplateKey,
                                               String newDDMTemplateKey)
Deprecated. As of 7.0.0, replaced by updateDDMTemplateKey(long, long, java.lang.String, java.lang.String)

Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one.

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#CLASSNAME_ID_DEFAULT otherwise
oldDDMTemplateKey - the primary key of the web content article's old DDM template
newDDMTemplateKey - the primary key of the web content article's new DDM template

getService

public static JournalArticleLocalService getService()

setService

@Deprecated
public void setService(JournalArticleLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m6