JournalArticleLocalServiceWrapper (Liferay 6.2-ce-ga5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.journal.service
Class JournalArticleLocalServiceWrapper

java.lang.Object
  com.liferay.portlet.journal.service.JournalArticleLocalServiceWrapper

All Implemented Interfaces:: BaseLocalService, PersistedModelLocalService, ServiceWrapper<JournalArticleLocalService>, JournalArticleLocalService

@ProviderType public class JournalArticleLocalServiceWrapper
extends Object
implements JournalArticleLocalService, ServiceWrapper<JournalArticleLocalService>
extends Object
implements JournalArticleLocalService, ServiceWrapper<JournalArticleLocalService>

Provides a wrapper for JournalArticleLocalService.

See Also:: JournalArticleLocalService

Constructor Summary
`JournalArticleLocalServiceWrapper(JournalArticleLocalService journalArticleLocalService)`

Method Summary
`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 type, 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.
`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.
`void`	`addArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions)` Adds the resources to the web content article.
`void`	`addArticleResources(JournalArticle article, String[] groupPermissions, String[] guestPermissions)` Adds the model resources with the permissions to the web content article.
`void`	`addArticleResources(long groupId, String articleId, boolean addGroupPermissions, boolean addGuestPermissions)` Adds the resources to the most recently created web content article.
`void`	`addArticleResources(long groupId, String articleId, String[] groupPermissions, String[] guestPermissions)` Adds the resources with the permissions to the most recently created web content article.
`JournalArticle`	`addJournalArticle(JournalArticle journalArticle)` Adds the journal article to the database.
`JournalArticle`	`checkArticleResourcePrimKey(long groupId, String articleId, double version)` Returns the web content article with the group, article ID, and version.
`void`	`checkArticles()` Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.
`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.
`void`	`checkStructure(long groupId, String articleId, double version)` Checks the web content article matching the group, article ID, and version for an associated structure.
`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.
`JournalArticle`	`createJournalArticle(long id)` Creates a new journal article with the primary key.
`JournalArticle`	`deleteArticle(JournalArticle article)` Deletes the web content article and its resources.
`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.
`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.
`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.
`void`	`deleteArticles(long groupId)` Deletes all the group's web content articles and resources.
`void`	`deleteArticles(long groupId, long folderId)` Deletes all the group's web content articles and resources in the folder, including recycled articles.
`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.
`void`	`deleteArticles(long groupId, String className, long classPK)`
`JournalArticle`	`deleteJournalArticle(JournalArticle journalArticle)` Deletes the journal article from the database.
`JournalArticle`	`deleteJournalArticle(long id)` Deletes the journal article with the primary key from the database.
`void`	`deleteLayoutArticleReferences(long groupId, String layoutUuid)` Deletes the layout's association with the web content articles for the group.
`DynamicQuery`	`dynamicQuery()`
`List`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end)` Performs a dynamic query on the database and returns a range of the matching rows.
`List`	`dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)` Performs a dynamic query on the database and returns an ordered range of the matching rows.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery)` Returns the number of rows that match the dynamic query.
`long`	`dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)` Returns the number of rows that match the dynamic query.
`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.
`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.
`JournalArticle`	`fetchArticle(long groupId, String articleId)`
`JournalArticle`	`fetchArticle(long groupId, String articleId, double version)` Returns the web content article matching the group, article ID, and version.
`JournalArticle`	`fetchArticleByUrlTitle(long groupId, String urlTitle)`
`JournalArticle`	`fetchDisplayArticle(long groupId, String articleId)`
`JournalArticle`	`fetchJournalArticle(long id)`
`JournalArticle`	`fetchJournalArticleByUuidAndCompanyId(String uuid, long companyId)` Returns the journal article with the matching UUID and company.
`JournalArticle`	`fetchJournalArticleByUuidAndGroupId(String uuid, long groupId)` Returns the journal article matching the UUID and group.
`JournalArticle`	`fetchLatestArticle(long resourcePrimKey)`
`JournalArticle`	`fetchLatestArticle(long resourcePrimKey, int status)`
`JournalArticle`	`fetchLatestArticle(long resourcePrimKey, int[] statuses)`
`JournalArticle`	`fetchLatestArticle(long resourcePrimKey, int status, boolean preferApproved)`
`JournalArticle`	`fetchLatestArticle(long groupId, String articleId, int status)`
`JournalArticle`	`fetchLatestArticleByUrlTitle(long groupId, String urlTitle, int status)`
`JournalArticle`	`fetchLatestIndexableArticle(long resourcePrimKey)` Returns the latest indexable web content article matching the resource primary key.
`JournalArticle`	`getArticle(long id)` Returns the web content article with the ID.
`JournalArticle`	`getArticle(long groupId, String articleId)` Returns the latest approved web content article, or the latest unapproved article if none are approved.
`JournalArticle`	`getArticle(long groupId, String articleId, double version)` Returns the web content article matching the group, article ID, and version.
`JournalArticle`	`getArticle(long groupId, String className, long classPK)` Returns the web content article matching the group, class name, and class PK.
`JournalArticle`	`getArticleByUrlTitle(long groupId, String urlTitle)` Returns the latest web content article that is approved, or the latest unapproved article if none are approved.
`String`	`getArticleContent(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, ThemeDisplay themeDisplay)` Returns the web content associated with the web content article and DDM template.
`String`	`getArticleContent(long groupId, String articleId, double version, String viewMode, String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)` Returns the web content matching the group, article ID, and version, and associated with the DDM template.
`String`	`getArticleContent(long groupId, String articleId, double version, String viewMode, String languageId, ThemeDisplay themeDisplay)` Returns the web content matching the group, article ID, and version.
`String`	`getArticleContent(long groupId, String articleId, String viewMode, String ddmTemplateKey, String languageId, ThemeDisplay themeDisplay)` Returns the latest web content matching the group and article ID, and associated with DDM template key.
`String`	`getArticleContent(long groupId, String articleId, String viewMode, String languageId, ThemeDisplay themeDisplay)` Returns the latest web content matching the group and article ID.
`JournalArticleDisplay`	`getArticleDisplay(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, int page, String xmlRequest, ThemeDisplay themeDisplay)` Returns a web content article display for the specified page of the latest version of the web content article, optionally based on the DDM template if the article is template driven.
`JournalArticleDisplay`	`getArticleDisplay(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, int page, String xmlRequest, ThemeDisplay themeDisplay)` Returns a web content article display for the first page of the specified version of the web content article, optionally based on the DDM template if the article is template driven.
`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 and article ID, optionally based on the DDM template if the article is template driven.
`JournalArticleDisplay`	`getArticleDisplay(long groupId, String articleId, String viewMode, String languageId, int page, String xmlRequest, 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.
`JournalArticleDisplay`	`getArticleDisplay(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, int page, String xmlRequest, 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, optionally based on the DDM template if the article is template driven.
`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 and article ID, optionally based on the DDM template if the article is template driven.
`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.
`List<JournalArticle>`	`getArticles()` Returns all the web content articles present in the system.
`List<JournalArticle>`	`getArticles(long groupId)` Returns all the web content articles belonging to the group.
`List<JournalArticle>`	`getArticles(long groupId, int start, int end)` Returns a range of all the web content articles belonging to the group.
`List<JournalArticle>`	`getArticles(long groupId, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles belonging to the group.
`List<JournalArticle>`	`getArticles(long groupId, long folderId)` Returns all the web content articles matching the group and folder.
`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.
`List<JournalArticle>`	`getArticles(long groupId, long folderId, int status, int start, int end)`
`List<JournalArticle>`	`getArticles(long groupId, long folderId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the web content articles matching the group and folder.
`List<JournalArticle>`	`getArticles(long groupId, String articleId)` Returns all the web content articles matching the group and article ID.
`List<JournalArticle>`	`getArticlesByResourcePrimKey(long resourcePrimKey)`
`List<JournalArticle>`	`getArticlesBySmallImageId(long smallImageId)` Returns all the web content articles matching the small image ID.
`int`	`getArticlesCount(long groupId)` Returns the number of web content articles belonging to the group.
`int`	`getArticlesCount(long groupId, long folderId)` Returns the number of web content articles matching the group and folder.
`int`	`getArticlesCount(long groupId, long folderId, int status)`
`int`	`getArticlesCount(long groupId, String articleId)`
`String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`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.
`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.
`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.
`int`	`getCompanyArticlesCount(long companyId, int status)` Returns the number of web content articles matching the company and workflow status.
`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.
`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.
`List<JournalArticle>`	`getIndexableArticlesByDDMStructureKey(String[] ddmStructureKeys)`
`List<JournalArticle>`	`getIndexableArticlesByResourcePrimKey(long resourcePrimKey)`
`JournalArticle`	`getJournalArticle(long id)` Returns the journal article with the primary key.
`JournalArticle`	`getJournalArticleByUuidAndCompanyId(String uuid, long companyId)` Returns the journal article with the matching UUID and company.
`JournalArticle`	`getJournalArticleByUuidAndGroupId(String uuid, long groupId)` Returns the journal article matching the UUID and group.
`List<JournalArticle>`	`getJournalArticles(int start, int end)` Returns a range of all the journal articles.
`int`	`getJournalArticlesCount()` Returns the number of journal articles.
`JournalArticle`	`getLatestArticle(long resourcePrimKey)` Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
`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.
`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.
`JournalArticle`	`getLatestArticle(long groupId, String articleId)` Returns the latest web content article with the group and article ID.
`JournalArticle`	`getLatestArticle(long groupId, String articleId, int status)` Returns the latest web content article matching the group, article ID, and workflow status.
`JournalArticle`	`getLatestArticle(long groupId, String className, long classPK)` Returns the latest web content article matching the group, class name ID, and class PK.
`JournalArticle`	`getLatestArticleByUrlTitle(long groupId, String urlTitle, int status)` Returns the latest web content article matching the group, URL title, and workflow status.
`double`	`getLatestVersion(long groupId, String articleId)` Returns the latest version number of the web content with the group and article ID.
`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.
`int`	`getNotInTrashArticlesCount(long groupId, long folderId)` Returns the number of web content articles that are not recycled.
`JournalArticle`	`getOldestArticle(long groupId, String articleId)`
`JournalArticle`	`getOldestArticle(long groupId, String articleId, int status)`
`PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`List<JournalArticle>`	`getStructureArticles(long groupId, String ddmStructureKey)` Returns the web content articles matching the group and DDM structure key.
`List<JournalArticle>`	`getStructureArticles(long groupId, String ddmStructureKey, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group and DDM structure key.
`List<JournalArticle>`	`getStructureArticles(String[] ddmStructureKeys)`
`int`	`getStructureArticlesCount(long groupId, String ddmStructureKey)` Returns the number of web content articles matching the group and DDM structure key.
`List<JournalArticle>`	`getTemplateArticles(long groupId, String ddmTemplateKey)` Returns the web content articles matching the group and DDM template key.
`List<JournalArticle>`	`getTemplateArticles(long groupId, String ddmTemplateKey, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group and DDM template key.
`int`	`getTemplateArticlesCount(long groupId, String ddmTemplateKey)` Returns the number of web content articles matching the group and DDM template key.
`String`	`getUniqueUrlTitle(long groupId, String articleId, String urlTitle)`
`JournalArticleLocalService`	`getWrappedJournalArticleLocalService()` Deprecated. As of 6.1.0, replaced by `getWrappedService()`
`JournalArticleLocalService`	`getWrappedService()`
`boolean`	`hasArticle(long groupId, String articleId)` Returns `true` if the specified web content article exists.
`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.
`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.
`JournalArticle`	`moveArticle(long groupId, String articleId, long newFolderId)` Moves the web content article matching the group and article ID to a new folder.
`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.
`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.
`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.
`void`	`rebuildTree(long companyId)`
`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.
`JournalArticle`	`restoreArticleFromTrash(long userId, JournalArticle article)` Restores the web content article from the Recycle Bin.
`List<JournalArticle>`	`search(long groupId, List<Long> folderIds, int status, int start, int end)`
`List<JournalArticle>`	`search(long groupId, long folderId, int status, int start, int end)`
`List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, int start, int end, OrderByComparator 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.
`List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String[] ddmStructureKeys, String[] ddmTemplateKeys, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator 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.
`List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator 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.
`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.
`Hits`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, String title, String description, String content, String type, String 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.
`Hits`	`search(long groupId, long userId, long creatorUserId, int status, int start, int end)`
`int`	`searchCount(long groupId, List<Long> folderIds, int status)`
`int`	`searchCount(long groupId, long folderId, int status)`
`int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String type, 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.
`int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, 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.
`int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, 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.
`void`	`setBeanIdentifier(String beanIdentifier)` Sets the Spring bean ID for this bean.
`void`	`setTreePaths(long folderId, String treePath, boolean reindex)`
`void`	`setWrappedJournalArticleLocalService(JournalArticleLocalService journalArticleLocalService)` Deprecated. As of 6.1.0, replaced by `setWrappedService(com.liferay.portlet.journal.service.JournalArticleLocalService)`
`void`	`setWrappedService(JournalArticleLocalService journalArticleLocalService)`
`void`	`subscribe(long userId, long groupId)` Subscribes the user to notifications for the web content article matching the group, notifying him the instant versions of the article are created, deleted, or modified.
`void`	`unsubscribe(long userId, long groupId)` Unsubscribes the user from notifications for the web content article matching the group.
`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.
`JournalArticle`	updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String type, 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.
`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.
`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)`
`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.
`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.
`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.
`JournalArticle`	`updateJournalArticle(JournalArticle journalArticle)` Updates the journal article in the database or adds it if it does not yet exist.
`JournalArticle`	`updateStatus(long userId, JournalArticle article, int status, String articleURL, Map<String,Serializable> workflowContext, ServiceContext serviceContext)` Updates the workflow status of the web content article.
`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.
`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.
`void`	`updateTemplateId(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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

JournalArticleLocalServiceWrapper

public JournalArticleLocalServiceWrapper(JournalArticleLocalService journalArticleLocalService)

Method Detail

addJournalArticle

public JournalArticle addJournalArticle(JournalArticle journalArticle)
                                 throws SystemException

Adds the journal article to the database. Also notifies the appropriate model listeners.

Specified by:: addJournalArticle in interface JournalArticleLocalService

Parameters:: journalArticle - the journal article
Returns:: the journal article that was added
Throws:: SystemException - if a system exception occurred

createJournalArticle

public JournalArticle createJournalArticle(long id)

Creates a new journal article with the primary key. Does not add the journal article to the database.

Specified by:: createJournalArticle in interface JournalArticleLocalService

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

deleteJournalArticle

public JournalArticle deleteJournalArticle(long id)
                                    throws PortalException,
                                           SystemException

Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:: deleteJournalArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

deleteJournalArticle

public JournalArticle deleteJournalArticle(JournalArticle journalArticle)
                                    throws SystemException

Deletes the journal article from the database. Also notifies the appropriate model listeners.

Specified by:: deleteJournalArticle in interface JournalArticleLocalService

Parameters:: journalArticle - the journal article
Returns:: the journal article that was removed
Throws:: SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:: dynamicQuery in interface JournalArticleLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Specified by:: dynamicQuery in interface JournalArticleLocalService

Parameters:: dynamicQuery - the dynamic query
Returns:: the matching rows
Throws:: SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
                  throws SystemException

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.

Specified by:: dynamicQuery in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Specified by:: dynamicQuery in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:: dynamicQueryCount in interface JournalArticleLocalService

Parameters:: dynamicQuery - the dynamic query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:: dynamicQueryCount in interface JournalArticleLocalService

Parameters:: dynamicQuery - the dynamic query; projection - the projection to apply to the query
Returns:: the number of rows that match the dynamic query
Throws:: SystemException - if a system exception occurred

fetchJournalArticle

public JournalArticle fetchJournalArticle(long id)
                                   throws SystemException

Specified by:: fetchJournalArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchJournalArticleByUuidAndCompanyId

public JournalArticle fetchJournalArticleByUuidAndCompanyId(String uuid,
                                                            long companyId)
                                                     throws SystemException

Returns the journal article with the matching UUID and company.

Specified by:: fetchJournalArticleByUuidAndCompanyId in interface JournalArticleLocalService

Parameters:: uuid - the journal article's UUID; companyId - the primary key of the company
Returns:: the matching journal article, or null if a matching journal article could not be found
Throws:: SystemException - if a system exception occurred

fetchJournalArticleByUuidAndGroupId

public JournalArticle fetchJournalArticleByUuidAndGroupId(String uuid,
                                                          long groupId)
                                                   throws SystemException

Returns the journal article matching the UUID and group.

Specified by:: fetchJournalArticleByUuidAndGroupId in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getJournalArticle

public JournalArticle getJournalArticle(long id)
                                 throws PortalException,
                                        SystemException

Returns the journal article with the primary key.

Specified by:: getJournalArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:: getPersistedModel in interface PersistedModelLocalService
Specified by:: getPersistedModel in interface JournalArticleLocalService

Throws:: PortalException; SystemException

getJournalArticleByUuidAndCompanyId

public JournalArticle getJournalArticleByUuidAndCompanyId(String uuid,
                                                          long companyId)
                                                   throws PortalException,
                                                          SystemException

Returns the journal article with the matching UUID and company.

Specified by:: getJournalArticleByUuidAndCompanyId in interface JournalArticleLocalService

Parameters:: uuid - the journal article's UUID; companyId - the primary key of the company
Returns:: the matching journal article
Throws:: PortalException - if a matching journal article could not be found; SystemException - if a system exception occurred

getJournalArticleByUuidAndGroupId

public JournalArticle getJournalArticleByUuidAndGroupId(String uuid,
                                                        long groupId)
                                                 throws PortalException,
                                                        SystemException

Returns the journal article matching the UUID and group.

Specified by:: getJournalArticleByUuidAndGroupId in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getJournalArticles

public List<JournalArticle> getJournalArticles(int start,
                                               int end)
                                        throws SystemException

Returns a range of all the journal articles.

Specified by:: getJournalArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getJournalArticlesCount

public int getJournalArticlesCount()
                            throws SystemException

Returns the number of journal articles.

Specified by:: getJournalArticlesCount in interface JournalArticleLocalService

Returns:: the number of journal articles
Throws:: SystemException - if a system exception occurred

updateJournalArticle

public JournalArticle updateJournalArticle(JournalArticle journalArticle)
                                    throws SystemException

Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Specified by:: updateJournalArticle in interface JournalArticleLocalService

Parameters:: journalArticle - the journal article
Returns:: the journal article that was updated
Throws:: SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:: getBeanIdentifier in interface JournalArticleLocalService

Returns:: the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:: setBeanIdentifier in interface JournalArticleLocalService

Parameters:: beanIdentifier - the Spring bean ID for this bean

addArticle

public 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 type,
                                 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,
                                 SystemException

Adds a web content article with additional parameters.

Specified by:: addArticle in interface JournalArticleLocalService

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. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; type - the structure's type, if the web content article is related to a DDM structure. For more information, see DDMStructureConstants.; 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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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, the "urlTitle" attribute, 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; SystemException - if a system exception occurred

addArticle

public 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,
                                 SystemException

Adds a web content article.

Specified by:: addArticle in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.; 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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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, the "urlTitle" attribute, 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; SystemException - if a system exception occurred

addArticleResources

public void addArticleResources(JournalArticle article,
                                boolean addGroupPermissions,
                                boolean addGuestPermissions)
                         throws PortalException,
                                SystemException

Adds the resources to the web content article.

Specified by:: addArticleResources in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

addArticleResources

public void addArticleResources(JournalArticle article,
                                String[] groupPermissions,
                                String[] guestPermissions)
                         throws PortalException,
                                SystemException

Adds the model resources with the permissions to the web content article.

Specified by:: addArticleResources in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

addArticleResources

public void addArticleResources(long groupId,
                                String articleId,
                                boolean addGroupPermissions,
                                boolean addGuestPermissions)
                         throws PortalException,
                                SystemException

Adds the resources to the most recently created web content article.

Specified by:: addArticleResources in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

addArticleResources

public void addArticleResources(long groupId,
                                String articleId,
                                String[] groupPermissions,
                                String[] guestPermissions)
                         throws PortalException,
                                SystemException

Adds the resources with the permissions to the most recently created web content article.

Specified by:: addArticleResources in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

checkArticleResourcePrimKey

public JournalArticle checkArticleResourcePrimKey(long groupId,
                                                  String articleId,
                                                  double version)
                                           throws PortalException,
                                                  SystemException

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.

Specified by:: checkArticleResourcePrimKey in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

checkArticles

public void checkArticles()
                   throws PortalException,
                          SystemException

Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.

Specified by:: checkArticles in interface JournalArticleLocalService

Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

checkNewLine

public void checkNewLine(long groupId,
                         String articleId,
                         double version)
                  throws PortalException,
                         SystemException

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.

Specified by:: checkNewLine in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

checkStructure

public void checkStructure(long groupId,
                           String articleId,
                           double version)
                    throws PortalException,
                           SystemException

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.

Specified by:: checkStructure in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

copyArticle

public JournalArticle copyArticle(long userId,
                                  long groupId,
                                  String oldArticleId,
                                  String newArticleId,
                                  boolean autoArticleId,
                                  double version)
                           throws PortalException,
                                  SystemException

Copies the web content article matching the group, article ID, and version. This method creates a new article, extracting all the values from the old one and updating its article ID.

Specified by:: copyArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

deleteArticle

public JournalArticle deleteArticle(JournalArticle article)
                             throws PortalException,
                                    SystemException

Deletes the web content article and its resources.

Specified by:: deleteArticle in interface JournalArticleLocalService

Parameters:: article - the web content article
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

deleteArticle

public JournalArticle deleteArticle(JournalArticle article,
                                    String articleURL,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Deletes the web content article and its resources, optionally sending email notifying denial of the article if it had not yet been approved.

Specified by:: deleteArticle in interface JournalArticleLocalService

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.
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

deleteArticle

public JournalArticle deleteArticle(long groupId,
                                    String articleId,
                                    double version,
                                    String articleURL,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.

Specified by:: deleteArticle in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the portlet preferences that include email information to notify recipients of the unapproved web content article's denial.
Throws:: PortalException - if a matching web content article could not be found or if a portal exception occurred; SystemException - if a system exception occurred

deleteArticle

public void deleteArticle(long groupId,
                          String articleId,
                          ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved.

Specified by:: deleteArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

deleteArticles

public void deleteArticles(long groupId)
                    throws PortalException,
                           SystemException

Deletes all the group's web content articles and resources.

Specified by:: deleteArticles in interface JournalArticleLocalService

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

deleteArticles

public void deleteArticles(long groupId,
                           long folderId)
                    throws PortalException,
                           SystemException

Deletes all the group's web content articles and resources in the folder, including recycled articles.

Specified by:: deleteArticles in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

deleteArticles

public void deleteArticles(long groupId,
                           long folderId,
                           boolean includeTrashedEntries)
                    throws PortalException,
                           SystemException

Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.

Specified by:: deleteArticles in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

deleteArticles

public void deleteArticles(long groupId,
                           String className,
                           long classPK)
                    throws PortalException,
                           SystemException

Specified by:: deleteArticles in interface JournalArticleLocalService

Throws:: PortalException; SystemException

deleteLayoutArticleReferences

public void deleteLayoutArticleReferences(long groupId,
                                          String layoutUuid)
                                   throws SystemException

Deletes the layout's association with the web content articles for the group.

Specified by:: deleteLayoutArticleReferences in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group; layoutUuid - the unique string identifying the web content article's display page
Throws:: SystemException - if a system exception occurred

expireArticle

public JournalArticle expireArticle(long userId,
                                    long groupId,
                                    String articleId,
                                    double version,
                                    String articleURL,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Expires the web content article matching the group, article ID, and version.

Specified by:: expireArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

expireArticle

public void expireArticle(long userId,
                          long groupId,
                          String articleId,
                          String articleURL,
                          ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Expires the web content article matching the group and article ID, expiring all of its versions if the journal.article.expire.all.versions portal property is true, otherwise expiring only its latest approved version.

Specified by:: expireArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

fetchArticle

public JournalArticle fetchArticle(long groupId,
                                   String articleId)
                            throws SystemException

Specified by:: fetchArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchArticle

public JournalArticle fetchArticle(long groupId,
                                   String articleId,
                                   double version)
                            throws SystemException

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

Specified by:: fetchArticle in interface JournalArticleLocalService

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
Throws:: SystemException

fetchArticleByUrlTitle

public JournalArticle fetchArticleByUrlTitle(long groupId,
                                             String urlTitle)
                                      throws SystemException

Specified by:: fetchArticleByUrlTitle in interface JournalArticleLocalService

Throws:: SystemException

fetchDisplayArticle

public JournalArticle fetchDisplayArticle(long groupId,
                                          String articleId)
                                   throws SystemException

Specified by:: fetchDisplayArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticle

public JournalArticle fetchLatestArticle(long resourcePrimKey)
                                  throws SystemException

Specified by:: fetchLatestArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticle

public JournalArticle fetchLatestArticle(long resourcePrimKey,
                                         int status)
                                  throws SystemException

Specified by:: fetchLatestArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticle

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

Specified by:: fetchLatestArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticle

public JournalArticle fetchLatestArticle(long resourcePrimKey,
                                         int status,
                                         boolean preferApproved)
                                  throws SystemException

Specified by:: fetchLatestArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticle

public JournalArticle fetchLatestArticle(long groupId,
                                         String articleId,
                                         int status)
                                  throws SystemException

Specified by:: fetchLatestArticle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestArticleByUrlTitle

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

Specified by:: fetchLatestArticleByUrlTitle in interface JournalArticleLocalService

Throws:: SystemException

fetchLatestIndexableArticle

public JournalArticle fetchLatestIndexableArticle(long resourcePrimKey)
                                           throws SystemException

Returns the latest indexable web content article matching the resource primary key.

Specified by:: fetchLatestIndexableArticle in interface JournalArticleLocalService

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
Throws:: SystemException

getArticle

public JournalArticle getArticle(long id)
                          throws PortalException,
                                 SystemException

Returns the web content article with the ID.

Specified by:: getArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticle

public JournalArticle getArticle(long groupId,
                                 String articleId)
                          throws PortalException,
                                 SystemException

Returns the latest approved web content article, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and article ID.

Specified by:: getArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticle

public JournalArticle getArticle(long groupId,
                                 String articleId,
                                 double version)
                          throws PortalException,
                                 SystemException

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

Specified by:: getArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticle

public JournalArticle getArticle(long groupId,
                                 String className,
                                 long classPK)
                          throws PortalException,
                                 SystemException

Returns the web content article matching the group, class name, and class PK.

Specified by:: getArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticleByUrlTitle

public JournalArticle getArticleByUrlTitle(long groupId,
                                           String urlTitle)
                                    throws PortalException,
                                           SystemException

Returns the latest web content article that is approved, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and URL title.

Specified by:: getArticleByUrlTitle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticleContent

public String getArticleContent(JournalArticle article,
                                String ddmTemplateKey,
                                String viewMode,
                                String languageId,
                                ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException

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

Specified by:: getArticleContent in interface JournalArticleLocalService

Parameters:: article - the web content article; 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.; 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 associated with the DDM template
Throws:: PortalException - if a matching DDM template could not be found or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

public String getArticleContent(long groupId,
                                String articleId,
                                double version,
                                String viewMode,
                                String ddmTemplateKey,
                                String languageId,
                                ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException

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

Specified by:: getArticleContent in interface JournalArticleLocalService

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 matching web content
Throws:: PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

public String getArticleContent(long groupId,
                                String articleId,
                                double version,
                                String viewMode,
                                String languageId,
                                ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException

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

Specified by:: getArticleContent in interface JournalArticleLocalService

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 matching web content
Throws:: PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

public String getArticleContent(long groupId,
                                String articleId,
                                String viewMode,
                                String ddmTemplateKey,
                                String languageId,
                                ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException

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

Specified by:: getArticleContent in interface JournalArticleLocalService

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 (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 matching web content
Throws:: PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

public String getArticleContent(long groupId,
                                String articleId,
                                String viewMode,
                                String languageId,
                                ThemeDisplay themeDisplay)
                         throws PortalException,
                                SystemException

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

Specified by:: getArticleContent in interface JournalArticleLocalService

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 matching web content
Throws:: PortalException - if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(JournalArticle article,
                                               String ddmTemplateKey,
                                               String viewMode,
                                               String languageId,
                                               int page,
                                               String xmlRequest,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Returns a web content article display for the specified page of the latest version of the web content article, optionally based on the DDM template if the article is template driven. If the article is template driven, web content transformation tokens are added from the theme display (if not null) or the XML request otherwise.

Specified by:: getArticleDisplay in interface JournalArticleLocalService

Parameters:: article - the web content article; 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.; 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's page number. Page numbers start at 1.; xmlRequest - the request that serializes the web content into a hierarchical hash map (optionally null); themeDisplay - the theme display
Returns:: the web content article display
Throws:: PortalException - if a matching DDM template could not be found or if a portal exception occurred; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               double version,
                                               String ddmTemplateKey,
                                               String viewMode,
                                               String languageId,
                                               int page,
                                               String xmlRequest,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Returns a web content article display for the first page of the specified version of the web content article, optionally based on the DDM template if the article is template driven. If the article is template driven, web content transformation tokens are added from the theme display (if not null) or the XML request otherwise.

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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's page number; xmlRequest - the request that serializes the web content into a hierarchical hash map; 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; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               double version,
                                               String ddmTemplateKey,
                                               String viewMode,
                                               String languageId,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Returns a web content article display for the first page of the specified version of the web content article matching the group and article ID, optionally based on the DDM template if the article is template driven. If the article is template driven, web content transformation tokens are added from the theme display (if not null).

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               String viewMode,
                                               String languageId,
                                               int page,
                                               String xmlRequest,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

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. If the article is template driven, web content transformation tokens are added from the theme display (if not null) or the XML request otherwise.

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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's page number; xmlRequest - the request that serializes the web content into a hierarchical hash map; 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; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               String ddmTemplateKey,
                                               String viewMode,
                                               String languageId,
                                               int page,
                                               String xmlRequest,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

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, optionally based on the DDM template if the article is template driven. If the article is template driven, web content transformation tokens are added from the theme display (if not null) or the XML request otherwise.

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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's page number; xmlRequest - the request that serializes the web content into a hierarchical hash map; 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; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               String ddmTemplateKey,
                                               String viewMode,
                                               String languageId,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

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, optionally based on the DDM template if the article is template driven. If the article is template driven, web content transformation tokens are added from the theme display (if not null).

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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; SystemException - if a system exception occurred

getArticleDisplay

public JournalArticleDisplay getArticleDisplay(long groupId,
                                               String articleId,
                                               String viewMode,
                                               String languageId,
                                               ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Specified by:: getArticleDisplay in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles()
                                 throws SystemException

Returns all the web content articles present in the system.

Specified by:: getArticles in interface JournalArticleLocalService

Returns:: the web content articles present in the system
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId)
                                 throws SystemException

Returns all the web content articles belonging to the group.

Specified by:: getArticles in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group
Returns:: the web content articles belonging to the group
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        int start,
                                        int end)
                                 throws SystemException

Returns a range of all the web content articles belonging to the group.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        int start,
                                        int end,
                                        OrderByComparator obc)
                                 throws SystemException

Returns an ordered range of all the web content articles belonging to the group.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        long folderId)
                                 throws SystemException

Returns all the web content articles matching the group and folder.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        long folderId,
                                        int start,
                                        int end)
                                 throws SystemException

Returns a range of all the web content articles matching the group and folder.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end)
                                 throws SystemException

Specified by:: getArticles in interface JournalArticleLocalService

Throws:: SystemException

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        long folderId,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                 throws SystemException

Returns an ordered range of all the web content articles matching the group and folder.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticles

public List<JournalArticle> getArticles(long groupId,
                                        String articleId)
                                 throws SystemException

Returns all the web content articles matching the group and article ID.

Specified by:: getArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticlesByResourcePrimKey

public List<JournalArticle> getArticlesByResourcePrimKey(long resourcePrimKey)
                                                  throws SystemException

Specified by:: getArticlesByResourcePrimKey in interface JournalArticleLocalService

Throws:: SystemException

getArticlesBySmallImageId

public List<JournalArticle> getArticlesBySmallImageId(long smallImageId)
                                               throws SystemException

Returns all the web content articles matching the small image ID.

Specified by:: getArticlesBySmallImageId in interface JournalArticleLocalService

Parameters:: smallImageId - the primary key of the web content article's small image
Returns:: the web content articles matching the small image ID
Throws:: SystemException - if a system exception occurred

getArticlesCount

public int getArticlesCount(long groupId)
                     throws SystemException

Returns the number of web content articles belonging to the group.

Specified by:: getArticlesCount in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group
Returns:: the number of web content articles belonging to the group
Throws:: SystemException - if a system exception occurred

getArticlesCount

public int getArticlesCount(long groupId,
                            long folderId)
                     throws SystemException

Returns the number of web content articles matching the group and folder.

Specified by:: getArticlesCount in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getArticlesCount

public int getArticlesCount(long groupId,
                            long folderId,
                            int status)
                     throws SystemException

Specified by:: getArticlesCount in interface JournalArticleLocalService

Throws:: SystemException

getArticlesCount

public int getArticlesCount(long groupId,
                            String articleId)
                     throws SystemException

Specified by:: getArticlesCount in interface JournalArticleLocalService

Throws:: SystemException

getCompanyArticles

public List<JournalArticle> getCompanyArticles(long companyId,
                                               double version,
                                               int status,
                                               int start,
                                               int end)
                                        throws SystemException

Returns an ordered range of all the web content articles matching the company, version, and workflow status.

Specified by:: getCompanyArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getCompanyArticles

public List<JournalArticle> getCompanyArticles(long companyId,
                                               int status,
                                               int start,
                                               int end)
                                        throws SystemException

Returns an ordered range of all the web content articles matching the company and workflow status.

Specified by:: getCompanyArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getCompanyArticlesCount

public int getCompanyArticlesCount(long companyId,
                                   double version,
                                   int status,
                                   int start,
                                   int end)
                            throws SystemException

Returns the number of web content articles matching the company, version, and workflow status.

Specified by:: getCompanyArticlesCount in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getCompanyArticlesCount

public int getCompanyArticlesCount(long companyId,
                                   int status)
                            throws SystemException

Returns the number of web content articles matching the company and workflow status.

Specified by:: getCompanyArticlesCount in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getDisplayArticle

public JournalArticle getDisplayArticle(long groupId,
                                        String articleId)
                                 throws PortalException,
                                        SystemException

Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed.

Specified by:: getDisplayArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getDisplayArticleByUrlTitle

public JournalArticle getDisplayArticleByUrlTitle(long groupId,
                                                  String urlTitle)
                                           throws PortalException,
                                                  SystemException

Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.

Specified by:: getDisplayArticleByUrlTitle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getIndexableArticlesByDDMStructureKey

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

Specified by:: getIndexableArticlesByDDMStructureKey in interface JournalArticleLocalService

Throws:: SystemException

getIndexableArticlesByResourcePrimKey

public List<JournalArticle> getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
                                                           throws SystemException

Specified by:: getIndexableArticlesByResourcePrimKey in interface JournalArticleLocalService

Throws:: SystemException

getLatestArticle

public JournalArticle getLatestArticle(long resourcePrimKey)
                                throws PortalException,
                                       SystemException

Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticle

public JournalArticle getLatestArticle(long resourcePrimKey,
                                       int status)
                                throws PortalException,
                                       SystemException

Returns the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticle

public JournalArticle getLatestArticle(long resourcePrimKey,
                                       int status,
                                       boolean preferApproved)
                                throws PortalException,
                                       SystemException

Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticle

public JournalArticle getLatestArticle(long groupId,
                                       String articleId)
                                throws PortalException,
                                       SystemException

Returns the latest web content article with the group and article ID.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticle

public JournalArticle getLatestArticle(long groupId,
                                       String articleId,
                                       int status)
                                throws PortalException,
                                       SystemException

Returns the latest web content article matching the group, article ID, and workflow status.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticle

public JournalArticle getLatestArticle(long groupId,
                                       String className,
                                       long classPK)
                                throws PortalException,
                                       SystemException

Returns the latest web content article matching the group, class name ID, and class PK.

Specified by:: getLatestArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestArticleByUrlTitle

public JournalArticle getLatestArticleByUrlTitle(long groupId,
                                                 String urlTitle,
                                                 int status)
                                          throws PortalException,
                                                 SystemException

Returns the latest web content article matching the group, URL title, and workflow status.

Specified by:: getLatestArticleByUrlTitle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestVersion

public double getLatestVersion(long groupId,
                               String articleId)
                        throws PortalException,
                               SystemException

Returns the latest version number of the web content with the group and article ID.

Specified by:: getLatestVersion in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getLatestVersion

public double getLatestVersion(long groupId,
                               String articleId,
                               int status)
                        throws PortalException,
                               SystemException

Returns the latest version number of the web content with the group, article ID, and workflow status.

Specified by:: getLatestVersion in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

getNotInTrashArticlesCount

public int getNotInTrashArticlesCount(long groupId,
                                      long folderId)
                               throws SystemException

Returns the number of web content articles that are not recycled.

Specified by:: getNotInTrashArticlesCount in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getOldestArticle

public JournalArticle getOldestArticle(long groupId,
                                       String articleId)
                                throws PortalException,
                                       SystemException

Specified by:: getOldestArticle in interface JournalArticleLocalService

Throws:: PortalException; SystemException

getOldestArticle

public JournalArticle getOldestArticle(long groupId,
                                       String articleId,
                                       int status)
                                throws PortalException,
                                       SystemException

Specified by:: getOldestArticle in interface JournalArticleLocalService

Throws:: PortalException; SystemException

getStructureArticles

public List<JournalArticle> getStructureArticles(long groupId,
                                                 String ddmStructureKey)
                                          throws SystemException

Returns the web content articles matching the group and DDM structure key.

Specified by:: getStructureArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getStructureArticles

public List<JournalArticle> getStructureArticles(long groupId,
                                                 String ddmStructureKey,
                                                 int start,
                                                 int end,
                                                 OrderByComparator obc)
                                          throws SystemException

Returns an ordered range of all the web content articles matching the group and DDM structure key.

Specified by:: getStructureArticles in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getStructureArticles

public List<JournalArticle> getStructureArticles(String[] ddmStructureKeys)
                                          throws SystemException

Specified by:: getStructureArticles in interface JournalArticleLocalService

Throws:: SystemException

getStructureArticlesCount

public int getStructureArticlesCount(long groupId,
                                     String ddmStructureKey)
                              throws SystemException

Returns the number of web content articles matching the group and DDM structure key.

Specified by:: getStructureArticlesCount in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getTemplateArticles

public List<JournalArticle> getTemplateArticles(long groupId,
                                                String ddmTemplateKey)
                                         throws SystemException

Returns the web content articles matching the group and DDM template key.

Specified by:: getTemplateArticles in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group; 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.
Returns:: the matching web content articles
Throws:: SystemException - if a system exception occurred

getTemplateArticles

public List<JournalArticle> getTemplateArticles(long groupId,
                                                String ddmTemplateKey,
                                                int start,
                                                int end,
                                                OrderByComparator obc)
                                         throws SystemException

Returns an ordered range of all the web content articles matching the group and DDM template key.

Specified by:: getTemplateArticles in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group; 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.; 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
Throws:: SystemException - if a system exception occurred

getTemplateArticlesCount

public int getTemplateArticlesCount(long groupId,
                                    String ddmTemplateKey)
                             throws SystemException

Returns the number of web content articles matching the group and DDM template key.

Specified by:: getTemplateArticlesCount in interface JournalArticleLocalService

Parameters:: groupId - the primary key of the web content article's group; 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.
Returns:: the number of matching web content articles
Throws:: SystemException - if a system exception occurred

getUniqueUrlTitle

public String getUniqueUrlTitle(long groupId,
                                String articleId,
                                String urlTitle)
                         throws PortalException,
                                SystemException

Specified by:: getUniqueUrlTitle in interface JournalArticleLocalService

Throws:: PortalException; SystemException

hasArticle

public boolean hasArticle(long groupId,
                          String articleId)
                   throws SystemException

Returns true if the specified web content article exists.

Specified by:: hasArticle in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

isLatestVersion

public boolean isLatestVersion(long groupId,
                               String articleId,
                               double version)
                        throws PortalException,
                               SystemException

Returns true if the web content article, specified by group and article ID, is the latest version.

Specified by:: isLatestVersion in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

isLatestVersion

public boolean isLatestVersion(long groupId,
                               String articleId,
                               double version,
                               int status)
                        throws PortalException,
                               SystemException

Returns true if the web content article, specified by group, article ID, and workflow status, is the latest version.

Specified by:: isLatestVersion in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

moveArticle

public JournalArticle moveArticle(long groupId,
                                  String articleId,
                                  long newFolderId)
                           throws PortalException,
                                  SystemException

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

Specified by:: moveArticle in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

moveArticleFromTrash

public JournalArticle moveArticleFromTrash(long userId,
                                           long groupId,
                                           JournalArticle article,
                                           long newFolderId,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Moves the web content article from the Recycle Bin to a new folder.

Specified by:: moveArticleFromTrash in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

moveArticleToTrash

public JournalArticle moveArticleToTrash(long userId,
                                         JournalArticle article)
                                  throws PortalException,
                                         SystemException

Moves the latest version of the web content article matching the group and article ID to the recycle bin.

Specified by:: moveArticleToTrash in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

moveArticleToTrash

public JournalArticle moveArticleToTrash(long userId,
                                         long groupId,
                                         String articleId)
                                  throws PortalException,
                                         SystemException

Moves the latest version of the web content article matching the group and article ID to the recycle bin.

Specified by:: moveArticleToTrash in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

rebuildTree

public void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException

Specified by:: rebuildTree in interface JournalArticleLocalService

Throws:: PortalException; SystemException

removeArticleLocale

public JournalArticle removeArticleLocale(long groupId,
                                          String articleId,
                                          double version,
                                          String languageId)
                                   throws PortalException,
                                          SystemException

Removes the web content of the web content article matching the group, article ID, and version, and language.

Specified by:: removeArticleLocale in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

restoreArticleFromTrash

public JournalArticle restoreArticleFromTrash(long userId,
                                              JournalArticle article)
                                       throws PortalException,
                                              SystemException

Restores the web content article from the Recycle Bin.

Specified by:: restoreArticleFromTrash in interface JournalArticleLocalService

Parameters:: userId - the primary key of the user restoring the web content article; article - the web content article
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; SystemException - if a system exception occurred

search

public List<JournalArticle> search(long groupId,
                                   List<Long> folderIds,
                                   int status,
                                   int start,
                                   int end)
                            throws SystemException

Specified by:: search in interface JournalArticleLocalService

Throws:: SystemException

search

public List<JournalArticle> search(long groupId,
                                   long folderId,
                                   int status,
                                   int start,
                                   int end)
                            throws SystemException

Specified by:: search in interface JournalArticleLocalService

Throws:: SystemException

search

public List<JournalArticle> search(long companyId,
                                   long groupId,
                                   List<Long> folderIds,
                                   long classNameId,
                                   String keywords,
                                   Double version,
                                   String type,
                                   String ddmStructureKey,
                                   String ddmTemplateKey,
                                   Date displayDateGT,
                                   Date displayDateLT,
                                   int status,
                                   Date reviewDate,
                                   int start,
                                   int end,
                                   OrderByComparator obc)
                            throws SystemException

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.

Specified by:: search in interface JournalArticleLocalService

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); type - the web content article's type (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 (optionally null). If the article is 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); 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
Throws:: SystemException - if a system exception occurred

search

public List<JournalArticle> search(long companyId,
                                   long groupId,
                                   List<Long> folderIds,
                                   long classNameId,
                                   String articleId,
                                   Double version,
                                   String title,
                                   String description,
                                   String content,
                                   String type,
                                   String ddmStructureKey,
                                   String ddmTemplateKey,
                                   Date displayDateGT,
                                   Date displayDateLT,
                                   int status,
                                   Date reviewDate,
                                   boolean andOperator,
                                   int start,
                                   int end,
                                   OrderByComparator obc)
                            throws SystemException

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, String, String, String, String,
 LinkedHashMap, boolean, int, int, Sort)

instead of this method wherever possible for performance reasons.

Specified by:: search in interface JournalArticleLocalService

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); type - the web content article's type (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 (optionally null). If the article is 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
Throws:: SystemException - if a system exception occurred

search

public List<JournalArticle> search(long companyId,
                                   long groupId,
                                   List<Long> folderIds,
                                   long classNameId,
                                   String articleId,
                                   Double version,
                                   String title,
                                   String description,
                                   String content,
                                   String type,
                                   String[] ddmStructureKeys,
                                   String[] ddmTemplateKeys,
                                   Date displayDateGT,
                                   Date displayDateLT,
                                   int status,
                                   Date reviewDate,
                                   boolean andOperator,
                                   int start,
                                   int end,
                                   OrderByComparator obc)
                            throws SystemException

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.

Specified by:: search in interface JournalArticleLocalService

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); type - the web content article's type (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
Throws:: SystemException - if a system exception occurred

search

public 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)
            throws SystemException

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.

Specified by:: search in interface JournalArticleLocalService

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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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
Throws:: SystemException - if a system exception occurred

search

public Hits search(long companyId,
                   long groupId,
                   List<Long> folderIds,
                   long classNameId,
                   String articleId,
                   String title,
                   String description,
                   String content,
                   String type,
                   String status,
                   String ddmStructureKey,
                   String ddmTemplateKey,
                   LinkedHashMap<String,Object> params,
                   boolean andSearch,
                   int start,
                   int end,
                   Sort sort)
            throws SystemException

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.

Specified by:: search in interface JournalArticleLocalService

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); type - the web content article's type (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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; params - the finder parameters (optionally null). Can set parameter "includeDiscussions" 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
Throws:: SystemException - if a system exception occurred

search

public Hits search(long groupId,
                   long userId,
                   long creatorUserId,
                   int status,
                   int start,
                   int end)
            throws PortalException,
                   SystemException

Specified by:: search in interface JournalArticleLocalService

Throws:: PortalException; SystemException

searchCount

public int searchCount(long groupId,
                       List<Long> folderIds,
                       int status)
                throws SystemException

Specified by:: searchCount in interface JournalArticleLocalService

Throws:: SystemException

searchCount

public int searchCount(long groupId,
                       long folderId,
                       int status)
                throws SystemException

Specified by:: searchCount in interface JournalArticleLocalService

Throws:: SystemException

searchCount

public int searchCount(long companyId,
                       long groupId,
                       List<Long> folderIds,
                       long classNameId,
                       String keywords,
                       Double version,
                       String type,
                       String ddmStructureKey,
                       String ddmTemplateKey,
                       Date displayDateGT,
                       Date displayDateLT,
                       int status,
                       Date reviewDate)
                throws SystemException

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.

Specified by:: searchCount in interface JournalArticleLocalService

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); type - the web content article's type (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 (optionally null). If the article is 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)
Returns:: the number of matching web content articles
Throws:: SystemException - if a system exception occurred

searchCount

public int searchCount(long companyId,
                       long groupId,
                       List<Long> folderIds,
                       long classNameId,
                       String articleId,
                       Double version,
                       String title,
                       String description,
                       String content,
                       String type,
                       String ddmStructureKey,
                       String ddmTemplateKey,
                       Date displayDateGT,
                       Date displayDateLT,
                       int status,
                       Date reviewDate,
                       boolean andOperator)
                throws SystemException

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.

Specified by:: searchCount in interface JournalArticleLocalService

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); type - the web content article's type (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 (optionally null). If the article is 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
Throws:: SystemException - if a system exception occurred

searchCount

public int searchCount(long companyId,
                       long groupId,
                       List<Long> folderIds,
                       long classNameId,
                       String articleId,
                       Double version,
                       String title,
                       String description,
                       String content,
                       String type,
                       String[] ddmStructureKeys,
                       String[] ddmTemplateKeys,
                       Date displayDateGT,
                       Date displayDateLT,
                       int status,
                       Date reviewDate,
                       boolean andOperator)
                throws SystemException

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.

Specified by:: searchCount in interface JournalArticleLocalService

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); type - the web content article's type (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
Throws:: SystemException - if a system exception occurred

setTreePaths

public void setTreePaths(long folderId,
                         String treePath,
                         boolean reindex)
                  throws PortalException,
                         SystemException

Specified by:: setTreePaths in interface JournalArticleLocalService

Throws:: PortalException; SystemException

public void subscribe(long userId,
                      long groupId)
               throws PortalException,
                      SystemException

Subscribes the user to notifications for the web content article matching the group, notifying him the instant versions of the article are created, deleted, or modified.

Specified by:: subscribe in interface JournalArticleLocalService

Parameters:: userId - the primary key of the user to subscribe; groupId - the primary key of the group
Throws:: PortalException - if a matching user or group could not be found; SystemException - if a system exception occurred

unsubscribe

public void unsubscribe(long userId,
                        long groupId)
                 throws PortalException,
                        SystemException

Unsubscribes the user from notifications for the web content article matching the group.

Specified by:: unsubscribe in interface JournalArticleLocalService

Parameters:: userId - the primary key of the user to unsubscribe; groupId - the primary key of the group
Throws:: PortalException - if a matching user or subscription could not be found; SystemException - if a system exception occurred

updateArticle

public JournalArticle updateArticle(long userId,
                                    long groupId,
                                    long folderId,
                                    String articleId,
                                    double version,
                                    Map<Locale,String> titleMap,
                                    Map<Locale,String> descriptionMap,
                                    String content,
                                    String layoutUuid,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.

Specified by:: updateArticle in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.; 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, the "defaultLanguageId" and "urlTitle" attributes, 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; SystemException - if a system exception occurred

updateArticle

public JournalArticle updateArticle(long userId,
                                    long groupId,
                                    long folderId,
                                    String articleId,
                                    double version,
                                    Map<Locale,String> titleMap,
                                    Map<Locale,String> descriptionMap,
                                    String content,
                                    String type,
                                    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,
                                    SystemException

Updates the web content article with additional parameters.

Specified by:: updateArticle in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.; type - the structure's type, if the web content article is related to a DDM structure. For more information, see DDMStructureConstants.; 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 (optionally null). If the article is related to a DDM structure, the template's structure must match it.; 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, the "defaultLanguageId" and "urlTitle" attributes, 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; SystemException - if a system exception occurred

updateArticle

public JournalArticle updateArticle(long userId,
                                    long groupId,
                                    long folderId,
                                    String articleId,
                                    double version,
                                    String content,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Updates the web content article matching the version, replacing its folder and content.

Specified by:: updateArticle in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.; 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, the "defaultLanguageId" and "urlTitle" attributes, 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; SystemException - if a system exception occurred

updateArticleTranslation

public JournalArticle updateArticleTranslation(long groupId,
                                               String articleId,
                                               double version,
                                               Locale locale,
                                               String title,
                                               String description,
                                               String content,
                                               Map<String,byte[]> images)
                                        throws PortalException,
                                               SystemException

Deprecated. As of 6.2.0, replaced by updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)

Specified by:: updateArticleTranslation in interface JournalArticleLocalService

Throws:: PortalException; SystemException

updateArticleTranslation

public JournalArticle updateArticleTranslation(long groupId,
                                               String articleId,
                                               double version,
                                               Locale locale,
                                               String title,
                                               String description,
                                               String content,
                                               Map<String,byte[]> images,
                                               ServiceContext serviceContext)
                                        throws PortalException,
                                               SystemException

Updates the translation of the web content article.

Specified by:: updateArticleTranslation in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.; images - the web content's images; serviceContext - the service context to be applied. Can set the modification date and "urlTitle" attribute 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; SystemException - if a system exception occurred

updateAsset

public void updateAsset(long userId,
                        JournalArticle article,
                        long[] assetCategoryIds,
                        String[] assetTagNames,
                        long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException

Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary.

Specified by:: updateAsset in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

updateContent

public JournalArticle updateContent(long groupId,
                                    String articleId,
                                    double version,
                                    String content)
                             throws PortalException,
                                    SystemException

Updates the web content article matching the group, article ID, and version, replacing its content.

Specified by:: updateContent in interface JournalArticleLocalService

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 class description for JournalArticleLocalServiceImpl.
Returns:: the updated web content article
Throws:: PortalException - if a matching web content article could not be found; SystemException - if a system exception occurred

updateStatus

public JournalArticle updateStatus(long userId,
                                   JournalArticle article,
                                   int status,
                                   String articleURL,
                                   Map<String,Serializable> workflowContext,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Updates the workflow status of the web content article.

Specified by:: updateStatus in interface JournalArticleLocalService

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; workflowContext - the web content article's configured workflow context; 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.
Returns:: the updated web content article
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

updateStatus

public JournalArticle updateStatus(long userId,
                                   long classPK,
                                   int status,
                                   Map<String,Serializable> workflowContext,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Updates the workflow status of the web content article matching the class PK.

Specified by:: updateStatus in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

updateStatus

public JournalArticle updateStatus(long userId,
                                   long groupId,
                                   String articleId,
                                   double version,
                                   int status,
                                   String articleURL,
                                   Map<String,Serializable> workflowContext,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Updates the workflow status of the web content article matching the group, article ID, and version.

Specified by:: updateStatus in interface JournalArticleLocalService

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; SystemException - if a system exception occurred

updateTemplateId

public void updateTemplateId(long groupId,
                             long classNameId,
                             String oldDDMTemplateKey,
                             String newDDMTemplateKey)
                      throws SystemException

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

Specified by:: updateTemplateId in interface JournalArticleLocalService

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
Throws:: SystemException - if a system exception occurred

getWrappedJournalArticleLocalService

public JournalArticleLocalService getWrappedJournalArticleLocalService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedJournalArticleLocalService

public void setWrappedJournalArticleLocalService(JournalArticleLocalService journalArticleLocalService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.journal.service.JournalArticleLocalService)

getWrappedService

public JournalArticleLocalService getWrappedService()

Specified by:: getWrappedService in interface ServiceWrapper<JournalArticleLocalService>

setWrappedService

public void setWrappedService(JournalArticleLocalService journalArticleLocalService)

Specified by:: setWrappedService in interface ServiceWrapper<JournalArticleLocalService>

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.journal.service Class JournalArticleLocalServiceWrapper

JournalArticleLocalServiceWrapper

addJournalArticle

createJournalArticle

deleteJournalArticle

deleteJournalArticle

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

fetchJournalArticle

fetchJournalArticleByUuidAndCompanyId

fetchJournalArticleByUuidAndGroupId

getJournalArticle

getPersistedModel

getJournalArticleByUuidAndCompanyId

getJournalArticleByUuidAndGroupId

getJournalArticles

getJournalArticlesCount

updateJournalArticle

getBeanIdentifier

setBeanIdentifier

addArticle

addArticle

addArticleResources

addArticleResources

addArticleResources

addArticleResources

checkArticleResourcePrimKey

checkArticles

checkNewLine

checkStructure

copyArticle

deleteArticle

deleteArticle

deleteArticle

deleteArticle

deleteArticles

deleteArticles

deleteArticles

deleteArticles

deleteLayoutArticleReferences

expireArticle

expireArticle

fetchArticle

fetchArticle

fetchArticleByUrlTitle

fetchDisplayArticle

fetchLatestArticle

fetchLatestArticle

fetchLatestArticle

fetchLatestArticle

fetchLatestArticle

fetchLatestArticleByUrlTitle

fetchLatestIndexableArticle

getArticle

getArticle

getArticle

getArticle

getArticleByUrlTitle

getArticleContent

getArticleContent

getArticleContent

getArticleContent

getArticleContent

getArticleDisplay

getArticleDisplay

getArticleDisplay

getArticleDisplay

getArticleDisplay

getArticleDisplay

getArticleDisplay

getArticles

getArticles

getArticles

getArticles

getArticles

getArticles

com.liferay.portlet.journal.service
Class JournalArticleLocalServiceWrapper