com.liferay.journal.service.impl

Class JournalArticleServiceImpl

java.lang.Object

com.liferay.portal.kernel.service.BaseServiceImpl

com.liferay.journal.service.base.JournalArticleServiceBaseImpl

com.liferay.journal.service.impl.JournalArticleServiceImpl

All Implemented Interfaces:

JournalArticleService, com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseService

public class JournalArticleServiceImpl
extends com.liferay.journal.service.base.JournalArticleServiceBaseImpl

Provides the remote service for accessing, adding, deleting, and updating web content articles. Its methods include permission checks.

See Also:

JournalArticleLocalServiceImpl

Field Summary

Fields inherited from class com.liferay.journal.service.base.JournalArticleServiceBaseImpl

assetCategoryLocalService, assetCategoryPersistence, assetCategoryService, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetLinkLocalService, assetLinkPersistence, assetTagLocalService, assetTagPersistence, assetTagService, classNameLocalService, classNamePersistence, classNameService, companyLocalService, companyPersistence, companyService, counterLocalService, dlAppLocalService, dlAppService, expandoRowLocalService, expandoRowPersistence, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, journalArticleFinder, journalArticleImageLocalService, journalArticleImagePersistence, journalArticleLocalService, journalArticlePersistence, journalArticleResourceLocalService, journalArticleResourcePersistence, journalArticleService, journalContentSearchLocalService, journalContentSearchPersistence, journalFolderFinder, journalFolderLocalService, journalFolderPersistence, journalFolderService, mailService, portletPreferencesLocalService, portletPreferencesPersistence, portletPreferencesService, ratingsStatsLocalService, ratingsStatsPersistence, resourceLocalService, subscriptionLocalService, subscriptionPersistence, systemEventLocalService, systemEventPersistence, trashEntryLocalService, trashEntryPersistence, trashEntryService, trashVersionLocalService, trashVersionPersistence, userLocalService, userPersistence, userService, workflowDefinitionLinkLocalService, workflowDefinitionLinkPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence

Fields inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS

Constructor Summary

Constructors

Constructor and Description
JournalArticleServiceImpl()

Method Summary

Modifier and Type	Method and Description
JournalArticle	addArticle(long groupId, long folderId, long classNameId, long classPK, java.lang.String articleId, boolean autoArticleId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.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, java.lang.String smallImageURL, java.io.File smallFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article with additional parameters.
JournalArticle	addArticle(long groupId, long folderId, long classNameId, long classPK, java.lang.String articleId, boolean autoArticleId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.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, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article without any images.
JournalArticle	copyArticle(long groupId, java.lang.String oldArticleId, java.lang.String newArticleId, boolean autoArticleId, double version) Copies the web content article matching the group, article ID, and version.
void	deleteArticle(long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.
void	deleteArticle(long groupId, java.lang.String articleId, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved.
JournalArticle	expireArticle(long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Expires the web content article matching the group, article ID, and version.
void	expireArticle(long groupId, java.lang.String articleId, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Expires the web content article matching the group and article ID, expiring all of its versions if the journal.article.expire.all.versions portal property is true, otherwise expiring only its latest approved version.
JournalArticle	fetchArticle(long groupId, java.lang.String articleId)
JournalArticle	getArticle(long id) Returns the web content article with the ID.
JournalArticle	getArticle(long groupId, java.lang.String articleId) Returns the latest approved web content article, or the latest unapproved article if none are approved.
JournalArticle	getArticle(long groupId, java.lang.String articleId, double version) Returns the web content article matching the group, article ID, and version.
JournalArticle	getArticle(long groupId, java.lang.String className, long classPK) Returns the web content article matching the group, class name, and class PK.
JournalArticle	getArticleByUrlTitle(long groupId, java.lang.String urlTitle) Returns the latest web content article that is approved, or the latest unapproved article if none are approved.
java.lang.String	getArticleContent(long groupId, java.lang.String articleId, double version, java.lang.String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns the web content from the web content article matching the group, article ID, and version.
java.lang.String	getArticleContent(long groupId, java.lang.String articleId, double version, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getArticleContent(long, String, double, String, PortletRequestModel, ThemeDisplay)
java.lang.String	getArticleContent(long groupId, java.lang.String articleId, java.lang.String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns the latest web content from the web content article matching the group and article ID.
java.lang.String	getArticleContent(long groupId, java.lang.String articleId, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getArticleContent(long, String, String, PortletRequestModel, ThemeDisplay)
java.util.List<JournalArticle>	getArticles(long groupId, long folderId) Returns all the web content articles matching the group and folder.
java.util.List<JournalArticle>	getArticles(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the web content articles matching the group and folder.
java.util.List<JournalArticle>	getArticlesByArticleId(long groupId, java.lang.String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the web content articles matching the group and article ID.
java.util.List<JournalArticle>	getArticlesByLayoutUuid(long groupId, java.lang.String layoutUuid) Returns all the web content articles matching the group and layout UUID.
java.util.List<JournalArticle>	getArticlesByStructureId(long groupId, long classNameId, java.lang.String ddmStructureKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.
java.util.List<JournalArticle>	getArticlesByStructureId(long groupId, java.lang.String ddmStructureKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
java.util.List<JournalArticle>	getArticlesByStructureId(long groupId, java.lang.String ddmStructureKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
int	getArticlesCount(long groupId, long folderId) Returns the number of web content articles matching the group and folder.
int	getArticlesCount(long groupId, long folderId, int status) Returns the number of web content articles matching the group, folder, and status.
int	getArticlesCountByArticleId(long groupId, java.lang.String articleId) Returns the number of web content articles matching the group and article ID.
int	getArticlesCountByStructureId(long groupId, long classNameId, java.lang.String ddmStructureKey, int status) Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status.
int	getArticlesCountByStructureId(long groupId, java.lang.String ddmStructureKey) Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
int	getArticlesCountByStructureId(long groupId, java.lang.String ddmStructureKey, int status) Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
JournalArticle	getDisplayArticleByUrlTitle(long groupId, java.lang.String urlTitle) Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.
int	getFoldersAndArticlesCount(long groupId, java.util.List<java.lang.Long> folderIds) Returns the number of folders containing web content articles belonging to the group.
java.util.List<JournalArticle>	getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
java.util.List<JournalArticle>	getGroupArticles(long groupId, long userId, long rootFolderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
java.util.List<JournalArticle>	getGroupArticles(long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
int	getGroupArticlesCount(long groupId, long userId, long rootFolderId) Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
int	getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status) Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
int	getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status, boolean includeOwner) Returns the number of web content articles matching the group, user, the root folder or any of its subfolders.
JournalArticle	getLatestArticle(long resourcePrimKey) Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
JournalArticle	getLatestArticle(long groupId, java.lang.String articleId, int status) Returns the latest web content article matching the group, article ID, and workflow status.
JournalArticle	getLatestArticle(long groupId, java.lang.String className, long classPK) Returns the latest web content article matching the group, class name ID, and class PK.
java.util.List<JournalArticle>	getLayoutArticles(long groupId)
void	moveArticle(long groupId, java.lang.String articleId, long newFolderId) Deprecated. As of Wilberforce (7.0.x), replaced by moveArticle(long, String, long, ServiceContext)
void	moveArticle(long groupId, java.lang.String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves all versions of the web content article matching the group and article ID to the folder.
JournalArticle	moveArticleFromTrash(long groupId, long resourcePrimKey, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the web content article from the Recycle Bin to the folder.
JournalArticle	moveArticleFromTrash(long groupId, java.lang.String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the web content article from the Recycle Bin to the folder.
JournalArticle	moveArticleToTrash(long groupId, java.lang.String articleId) Moves the latest version of the web content article matching the group and article ID to the recycle bin.
void	removeArticleLocale(long companyId, java.lang.String languageId) Removes the web content of all the company's web content articles matching the language.
JournalArticle	removeArticleLocale(long groupId, java.lang.String articleId, double version, java.lang.String languageId) Removes the web content of the web content article matching the group, article ID, and version, and language.
void	restoreArticleFromTrash(long resourcePrimKey) Restores the web content article associated with the resource primary key from the Recycle Bin.
void	restoreArticleFromTrash(long groupId, java.lang.String articleId) Restores the web content article from the Recycle Bin.
com.liferay.portal.kernel.search.Hits	search(long groupId, long creatorUserId, int status, int start, int end) Returns a range of all the web content articles matching the group, creator, creator, and workflow status using the indexer.
java.util.List<JournalArticle>	search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the 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.
java.util.List<JournalArticle>	search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the 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.
java.util.List<JournalArticle>	search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) Returns an ordered range of all the 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.
int	searchCount(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.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, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.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, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.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	subscribeStructure(long groupId, long userId, long ddmStructureId) Subscribes the user to changes in elements that belong to the web content article's DDM structure.
void	unsubscribeStructure(long groupId, long userId, long ddmStructureId) Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.
JournalArticle	updateArticle(long userId, long groupId, long folderId, java.lang.String articleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.
JournalArticle	updateArticle(long groupId, long folderId, java.lang.String articleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.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, java.lang.String smallImageURL, java.io.File smallFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article with additional parameters.
JournalArticle	updateArticle(long groupId, long folderId, java.lang.String articleId, double version, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder and content.
JournalArticle	updateArticleTranslation(long groupId, java.lang.String articleId, double version, java.util.Locale locale, java.lang.String title, java.lang.String description, java.lang.String content, java.util.Map<java.lang.String,byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the translation of the web content article.
JournalArticle	updateContent(long groupId, java.lang.String articleId, double version, java.lang.String content) Updates the web content article matching the group, article ID, and version, replacing its content.
JournalArticle	updateStatus(long groupId, java.lang.String articleId, double version, int status, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the workflow status of the web content article matching the group, article ID, and version.

Methods inherited from class com.liferay.journal.service.base.JournalArticleServiceBaseImpl

afterPropertiesSet, destroy, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetCategoryService, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetLinkLocalService, getAssetLinkPersistence, getAssetTagLocalService, getAssetTagPersistence, getAssetTagService, getClassNameLocalService, getClassNamePersistence, getClassNameService, getCompanyLocalService, getCompanyPersistence, getCompanyService, getCounterLocalService, getDLAppLocalService, getDLAppService, getExpandoRowLocalService, getExpandoRowPersistence, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getJournalArticleFinder, getJournalArticleImageLocalService, getJournalArticleImagePersistence, getJournalArticleLocalService, getJournalArticlePersistence, getJournalArticleResourceLocalService, getJournalArticleResourcePersistence, getJournalArticleService, getJournalContentSearchLocalService, getJournalContentSearchPersistence, getJournalFolderFinder, getJournalFolderLocalService, getJournalFolderPersistence, getJournalFolderService, getMailService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getPortletPreferencesLocalService, getPortletPreferencesPersistence, getPortletPreferencesService, getRatingsStatsLocalService, getRatingsStatsPersistence, getResourceLocalService, getSubscriptionLocalService, getSubscriptionPersistence, getSystemEventLocalService, getSystemEventPersistence, getTrashEntryLocalService, getTrashEntryPersistence, getTrashEntryService, getTrashVersionLocalService, getTrashVersionPersistence, getUserLocalService, getUserPersistence, getUserService, getWorkflowDefinitionLinkLocalService, getWorkflowDefinitionLinkPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetCategoryService, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetLinkLocalService, setAssetLinkPersistence, setAssetTagLocalService, setAssetTagPersistence, setAssetTagService, setClassNameLocalService, setClassNamePersistence, setClassNameService, setCompanyLocalService, setCompanyPersistence, setCompanyService, setCounterLocalService, setDLAppLocalService, setDLAppService, setExpandoRowLocalService, setExpandoRowPersistence, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setJournalArticleFinder, setJournalArticleImageLocalService, setJournalArticleImagePersistence, setJournalArticleLocalService, setJournalArticlePersistence, setJournalArticleResourceLocalService, setJournalArticleResourcePersistence, setJournalArticleService, setJournalContentSearchLocalService, setJournalContentSearchPersistence, setJournalFolderFinder, setJournalFolderLocalService, setJournalFolderPersistence, setJournalFolderService, setMailService, setPortletPreferencesLocalService, setPortletPreferencesPersistence, setPortletPreferencesService, setRatingsStatsLocalService, setRatingsStatsPersistence, setResourceLocalService, setSubscriptionLocalService, setSubscriptionPersistence, setSystemEventLocalService, setSystemEventPersistence, setTrashEntryLocalService, setTrashEntryPersistence, setTrashEntryService, setTrashVersionLocalService, setTrashVersionPersistence, setUserLocalService, setUserPersistence, setUserService, setWorkflowDefinitionLinkLocalService, setWorkflowDefinitionLinkPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence

Methods inherited from class com.liferay.portal.kernel.service.BaseServiceImpl

getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JournalArticleServiceImpl

public JournalArticleServiceImpl()

Method Detail

addArticle

public JournalArticle addArticle(long groupId,
                                 long folderId,
                                 long classNameId,
                                 long classPK,
                                 java.lang.String articleId,
                                 boolean autoArticleId,
                                 java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                 java.lang.String content,
                                 java.lang.String ddmStructureKey,
                                 java.lang.String ddmTemplateKey,
                                 java.lang.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,
                                 java.lang.String smallImageURL,
                                 java.io.File smallFile,
                                 java.util.Map<java.lang.String,byte[]> images,
                                 java.lang.String articleURL,
                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                          throws com.liferay.portal.kernel.exception.PortalException

Adds a web content article with additional parameters.

Parameters:

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 in the journal-api module otherwise

classPK - the primary key of the DDM structure, if the primary key of the DDMStructure class is given as the classNameId parameter, the primary key of the class associated with the web content article, or 0 otherwise

articleId - the primary key of the web content article

autoArticleId - whether to auto generate the web content article ID

titleMap - the web content article's locales and localized titles

descriptionMap - the web content article's locales and localized descriptions

content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

layoutUuid - the unique string identifying the web content article's display page

displayDateMonth - the month the web content article is set to display

displayDateDay - the calendar day the web content article is set to display

displayDateYear - the year the web content article is set to display

displayDateHour - the hour the web content article is set to display

displayDateMinute - the minute the web content article is set to display

expirationDateMonth - the month the web content article is set to expire

expirationDateDay - the calendar day the web content article is set to expire

expirationDateYear - the year the web content article is set to expire

expirationDateHour - the hour the web content article is set to expire

expirationDateMinute - the minute the web content article is set to expire

neverExpire - whether the web content article is not set to auto expire

reviewDateMonth - the month the web content article is set for review

reviewDateDay - the calendar day the web content article is set for review

reviewDateYear - the year the web content article is set for review

reviewDateHour - the hour the web content article is set for review

reviewDateMinute - the minute the web content article is set for review

neverReview - whether the web content article is not set for review

indexable - whether the web content article is searchable

smallImage - whether the web content article has a small image

smallImageURL - the web content article's small image URL

smallFile - the web content article's small image file

images - the web content's images

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, asset priority, URL title, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.

Returns:

the web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

addArticle

public JournalArticle addArticle(long groupId,
                                 long folderId,
                                 long classNameId,
                                 long classPK,
                                 java.lang.String articleId,
                                 boolean autoArticleId,
                                 java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                 java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                 java.lang.String content,
                                 java.lang.String ddmStructureKey,
                                 java.lang.String ddmTemplateKey,
                                 java.lang.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,
                                 java.lang.String articleURL,
                                 com.liferay.portal.kernel.service.ServiceContext serviceContext)
                          throws com.liferay.portal.kernel.exception.PortalException

Adds a web content article without any images.

Parameters:

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 in the journal-api module otherwise

classPK - the primary key of the DDM structure, if the primary key of the DDMStructure class is given as the classNameId parameter, the primary key of the class associated with the web content article, or 0 otherwise

articleId - the primary key of the web content article

autoArticleId - whether to auto generate the web content article ID

titleMap - the web content article's locales and localized titles

descriptionMap - the web content article's locales and localized descriptions

content - the HTML content wrapped in XML

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

layoutUuid - the unique string identifying the web content article's display page

displayDateMonth - the month the web content article is set to display

displayDateDay - the calendar day the web content article is set to display

displayDateYear - the year the web content article is set to display

displayDateHour - the hour the web content article is set to display

displayDateMinute - the minute the web content article is set to display

expirationDateMonth - the month the web content article is set to expire

expirationDateDay - the calendar day the web content article is set to expire

expirationDateYear - the year the web content article is set to expire

expirationDateHour - the hour the web content article is set to expire

expirationDateMinute - the minute the web content article is set to expire

neverExpire - whether the web content article is not set to auto expire

reviewDateMonth - the month the web content article is set for review

reviewDateDay - the calendar day the web content article is set for review

reviewDateYear - the year the web content article is set for review

reviewDateHour - the hour the web content article is set for review

reviewDateMinute - the minute the web content article is set for review

neverReview - whether the web content article is not set for review

indexable - whether the web content article is searchable

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, asset priority, URL title, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.

Returns:

the web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

copyArticle

public JournalArticle copyArticle(long groupId,
                                  java.lang.String oldArticleId,
                                  java.lang.String newArticleId,
                                  boolean autoArticleId,
                                  double version)
                           throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

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:

com.liferay.portal.kernel.exception.PortalException

deleteArticle

public void deleteArticle(long groupId,
                          java.lang.String articleId,
                          double version,
                          java.lang.String articleURL,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

deleteArticle

public void deleteArticle(long groupId,
                          java.lang.String articleId,
                          java.lang.String articleURL,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the portlet preferences that include email information to notify recipients of the unapproved web content article's denial.

Throws:

com.liferay.portal.kernel.exception.PortalException

expireArticle

public JournalArticle expireArticle(long groupId,
                                    java.lang.String articleId,
                                    double version,
                                    java.lang.String articleURL,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

expireArticle

public void expireArticle(long groupId,
                          java.lang.String articleId,
                          java.lang.String articleURL,
                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                   throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchArticle

public JournalArticle fetchArticle(long groupId,
                                   java.lang.String articleId)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticle

public JournalArticle getArticle(long id)
                          throws com.liferay.portal.kernel.exception.PortalException

Returns the web content article with the ID.

Parameters:

id - the primary key of the web content article

Returns:

the web content article with the ID

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticle

public JournalArticle getArticle(long groupId,
                                 java.lang.String articleId)
                          throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

getArticle

public JournalArticle getArticle(long groupId,
                                 java.lang.String articleId,
                                 double version)
                          throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

Returns:

the matching web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticle

public JournalArticle getArticle(long groupId,
                                 java.lang.String className,
                                 long classPK)
                          throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

className - the DDMStructure class name if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

classPK - the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise

Returns:

the matching web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticleByUrlTitle

public JournalArticle getArticleByUrlTitle(long groupId,
                                           java.lang.String urlTitle)
                                    throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

getArticleContent

public java.lang.String getArticleContent(long groupId,
                                          java.lang.String articleId,
                                          double version,
                                          java.lang.String languageId,
                                          com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
                                          com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                                   throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

languageId - the primary key of the language translation to get

portletRequestModel - the portlet request model

themeDisplay - the theme display

Returns:

the matching web content

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticleContent

@Deprecated
public java.lang.String getArticleContent(long groupId,
                                                      java.lang.String articleId,
                                                      double version,
                                                      java.lang.String languageId,
                                                      com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getArticleContent(long, String, double, String, PortletRequestModel, ThemeDisplay)

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

languageId - the primary key of the language translation to get

themeDisplay - the theme display

Returns:

the matching web content

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticleContent

public java.lang.String getArticleContent(long groupId,
                                          java.lang.String articleId,
                                          java.lang.String languageId,
                                          com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
                                          com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                                   throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

languageId - the primary key of the language translation to get

portletRequestModel - the portlet request model

themeDisplay - the theme display

Returns:

the matching web content

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticleContent

@Deprecated
public java.lang.String getArticleContent(long groupId,
                                                      java.lang.String articleId,
                                                      java.lang.String languageId,
                                                      com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
                                               throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getArticleContent(long, String, String, PortletRequestModel, ThemeDisplay)

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

languageId - the primary key of the language translation to get

themeDisplay - the theme display

Returns:

the matching web content

Throws:

com.liferay.portal.kernel.exception.PortalException

getArticles

public java.util.List<JournalArticle> getArticles(long groupId,
                                                  long folderId)

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

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article folder

Returns:

the matching web content articles

getArticles

public java.util.List<JournalArticle> getArticles(long groupId,
                                                  long folderId,
                                                  int start,
                                                  int end,
                                                  com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

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

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

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article 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)

obc - the comparator to order the web content articles

Returns:

the matching web content articles

getArticlesByArticleId

public java.util.List<JournalArticle> getArticlesByArticleId(long groupId,
                                                             java.lang.String articleId,
                                                             int start,
                                                             int end,
                                                             com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

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

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

obc - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

getArticlesByLayoutUuid

public java.util.List<JournalArticle> getArticlesByLayoutUuid(long groupId,
                                                              java.lang.String layoutUuid)

Returns all the web content articles matching the group and layout UUID.

Parameters:

groupId - the primary key of the web content article's group

layoutUuid - the unique string identifying the web content article's display page

Returns:

the matching web content articles

getArticlesByStructureId

public java.util.List<JournalArticle> getArticlesByStructureId(long groupId,
                                                               long classNameId,
                                                               java.lang.String ddmStructureKey,
                                                               int status,
                                                               int start,
                                                               int end,
                                                               com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.

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

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 in the journal-api module otherwise

ddmStructureKey - the primary key of the web content article's DDM structure

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

obc - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

getArticlesByStructureId

public java.util.List<JournalArticle> getArticlesByStructureId(long groupId,
                                                               java.lang.String ddmStructureKey,
                                                               int status,
                                                               int start,
                                                               int end,
                                                               com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.

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

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

getArticlesByStructureId

public java.util.List<JournalArticle> getArticlesByStructureId(long groupId,
                                                               java.lang.String ddmStructureKey,
                                                               int start,
                                                               int end,
                                                               com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.

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

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

getArticlesCount

public int getArticlesCount(long groupId,
                            long folderId)

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

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article folder

Returns:

the number of matching web content articles

getArticlesCount

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

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

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article's folder

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

Returns:

the number of matching web content articles

getArticlesCountByArticleId

public int getArticlesCountByArticleId(long groupId,
                                       java.lang.String articleId)

Returns the number of web content articles matching the group and article ID.

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

Returns:

the number of matching web content articles

getArticlesCountByStructureId

public int getArticlesCountByStructureId(long groupId,
                                         long classNameId,
                                         java.lang.String ddmStructureKey,
                                         int status)

Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status.

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 in the journal-api module otherwise

ddmStructureKey - the primary key of the web content article's DDM structure

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

Returns:

the number of matching web content articles

getArticlesCountByStructureId

public int getArticlesCountByStructureId(long groupId,
                                         java.lang.String ddmStructureKey)

Returns the number of web content articles matching the group, default class name ID, and DDM structure key.

Parameters:

groupId - the primary key of the web content article's group

ddmStructureKey - the primary key of the web content article's DDM structure

Returns:

the number of matching web content articles

getArticlesCountByStructureId

public int getArticlesCountByStructureId(long groupId,
                                         java.lang.String ddmStructureKey,
                                         int status)

Returns the number of web content articles matching the group, default class name ID, and DDM structure key.

Parameters:

groupId - the primary key of the web content article's group

ddmStructureKey - the primary key of the web content article's DDM structure

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

getDisplayArticleByUrlTitle

public JournalArticle getDisplayArticleByUrlTitle(long groupId,
                                                  java.lang.String urlTitle)
                                           throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

getFoldersAndArticlesCount

public int getFoldersAndArticlesCount(long groupId,
                                      java.util.List<java.lang.Long> folderIds)

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

Parameters:

groupId - the primary key of the web content article's group

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

Returns:

the number of matching folders containing web content articles

getGroupArticles

public java.util.List<JournalArticle> getGroupArticles(long groupId,
                                                       long userId,
                                                       long rootFolderId,
                                                       int status,
                                                       boolean includeOwner,
                                                       int start,
                                                       int end,
                                                       com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
                                                throws com.liferay.portal.kernel.exception.PortalException

Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

orderByComparator - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupArticles

public java.util.List<JournalArticle> getGroupArticles(long groupId,
                                                       long userId,
                                                       long rootFolderId,
                                                       int status,
                                                       int start,
                                                       int end,
                                                       com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
                                                throws com.liferay.portal.kernel.exception.PortalException

Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.

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

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

orderByComparator - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupArticles

public java.util.List<JournalArticle> getGroupArticles(long groupId,
                                                       long userId,
                                                       long rootFolderId,
                                                       int start,
                                                       int end,
                                                       com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
                                                throws com.liferay.portal.kernel.exception.PortalException

Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.

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

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

orderByComparator - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupArticlesCount

public int getGroupArticlesCount(long groupId,
                                 long userId,
                                 long rootFolderId)
                          throws com.liferay.portal.kernel.exception.PortalException

Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

Returns:

the number of matching web content articles

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupArticlesCount

public int getGroupArticlesCount(long groupId,
                                 long userId,
                                 long rootFolderId,
                                 int status)
                          throws com.liferay.portal.kernel.exception.PortalException

Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

Returns:

the number of matching web content articles

Throws:

com.liferay.portal.kernel.exception.PortalException

getGroupArticlesCount

public int getGroupArticlesCount(long groupId,
                                 long userId,
                                 long rootFolderId,
                                 int status,
                                 boolean includeOwner)
                          throws com.liferay.portal.kernel.exception.PortalException

Returns the number of web content articles matching the group, user, the root folder or any of its subfolders.

Parameters:

groupId - the primary key of the web content article's group

userId - the primary key of the user (optionally 0)

rootFolderId - the primary key of the root folder to begin the search

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

Returns:

the range of matching web content articles ordered by the comparator

Throws:

com.liferay.portal.kernel.exception.PortalException

getLatestArticle

public JournalArticle getLatestArticle(long resourcePrimKey)
                                throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

getLatestArticle

public JournalArticle getLatestArticle(long groupId,
                                       java.lang.String articleId,
                                       int status)
                                throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

getLatestArticle

public JournalArticle getLatestArticle(long groupId,
                                       java.lang.String className,
                                       long classPK)
                                throws com.liferay.portal.kernel.exception.PortalException

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

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 in the journal-api module otherwise

classPK - the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise

Returns:

the latest matching web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

getLayoutArticles

public java.util.List<JournalArticle> getLayoutArticles(long groupId)

moveArticle

@Deprecated
public void moveArticle(long groupId,
                                    java.lang.String articleId,
                                    long newFolderId)
                             throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by moveArticle(long, String, long, ServiceContext)

Moves all versions of the web content article matching the group and article ID to the folder.

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

newFolderId - the primary key of the web content article's new folder

Throws:

com.liferay.portal.kernel.exception.PortalException

moveArticle

public void moveArticle(long groupId,
                        java.lang.String articleId,
                        long newFolderId,
                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                 throws com.liferay.portal.kernel.exception.PortalException

Moves all versions of the web content article matching the group and article ID to the folder.

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

newFolderId - the primary key of the web content article's new folder

serviceContext - the service context to be applied. Can set the user ID, language ID, portlet preferences, portlet request, portlet response, theme display, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Throws:

com.liferay.portal.kernel.exception.PortalException

moveArticleFromTrash

public JournalArticle moveArticleFromTrash(long groupId,
                                           long resourcePrimKey,
                                           long newFolderId,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

resourcePrimKey - the primary key of the resource instance

newFolderId - the primary key of the web content article's new folder

serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the updated web content article, which was moved from the Recycle Bin to the folder

Throws:

com.liferay.portal.kernel.exception.PortalException

moveArticleFromTrash

public JournalArticle moveArticleFromTrash(long groupId,
                                           java.lang.String articleId,
                                           long newFolderId,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

newFolderId - the primary key of the web content article's new folder

serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the updated web content article, which was moved from the Recycle Bin to the folder

Throws:

com.liferay.portal.kernel.exception.PortalException

moveArticleToTrash

public JournalArticle moveArticleToTrash(long groupId,
                                         java.lang.String articleId)
                                  throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

Returns:

the moved web content article or null if no matching article was found

Throws:

com.liferay.portal.kernel.exception.PortalException

removeArticleLocale

public void removeArticleLocale(long companyId,
                                java.lang.String languageId)
                         throws com.liferay.portal.kernel.exception.PortalException

Removes the web content of all the company's web content articles matching the language.

Parameters:

companyId - the primary key of the web content article's company

languageId - the primary key of the language locale to remove

Throws:

com.liferay.portal.kernel.exception.PortalException

removeArticleLocale

public JournalArticle removeArticleLocale(long groupId,
                                          java.lang.String articleId,
                                          double version,
                                          java.lang.String languageId)
                                   throws com.liferay.portal.kernel.exception.PortalException

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

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:

com.liferay.portal.kernel.exception.PortalException

restoreArticleFromTrash

public void restoreArticleFromTrash(long resourcePrimKey)
                             throws com.liferay.portal.kernel.exception.PortalException

Restores the web content article associated with the resource primary key from the Recycle Bin.

Parameters:

resourcePrimKey - the primary key of the resource instance

Throws:

com.liferay.portal.kernel.exception.PortalException

restoreArticleFromTrash

public void restoreArticleFromTrash(long groupId,
                                    java.lang.String articleId)
                             throws com.liferay.portal.kernel.exception.PortalException

Restores the web content article from the Recycle Bin.

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public com.liferay.portal.kernel.search.Hits search(long groupId,
                                                    long creatorUserId,
                                                    int status,
                                                    int start,
                                                    int end)
                                             throws com.liferay.portal.kernel.exception.PortalException

Returns a range of all the web content articles matching the group, creator, creator, and workflow status using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.

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

Parameters:

groupId - the primary key of the web content article's group

creatorUserId - the primary key of the web content article's creator

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

Returns:

the matching web content articles

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public java.util.List<JournalArticle> search(long companyId,
                                             long groupId,
                                             java.util.List<java.lang.Long> folderIds,
                                             long classNameId,
                                             java.lang.String keywords,
                                             java.lang.Double version,
                                             java.lang.String ddmStructureKey,
                                             java.lang.String ddmTemplateKey,
                                             java.util.Date displayDateGT,
                                             java.util.Date displayDateLT,
                                             int status,
                                             java.util.Date reviewDate,
                                             int start,
                                             int end,
                                             com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the 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.

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

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.

version - the web content article's version (optionally null)

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

obc - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

search

public java.util.List<JournalArticle> search(long companyId,
                                             long groupId,
                                             java.util.List<java.lang.Long> folderIds,
                                             long classNameId,
                                             java.lang.String articleId,
                                             java.lang.Double version,
                                             java.lang.String title,
                                             java.lang.String description,
                                             java.lang.String content,
                                             java.lang.String ddmStructureKey,
                                             java.lang.String ddmTemplateKey,
                                             java.util.Date displayDateGT,
                                             java.util.Date displayDateLT,
                                             int status,
                                             java.util.Date reviewDate,
                                             boolean andOperator,
                                             int start,
                                             int end,
                                             com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the 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.

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

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

articleId - the article ID keywords (space separated, optionally null)

version - the web content article's version (optionally null)

title - the title keywords (space separated, optionally null)

description - the description keywords (space separated, optionally null)

content - the content keywords (space separated, optionally null)

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

andOperator - whether every field must match its value or keywords, or just one field must match. Company, group, folder IDs, class name ID, and status must all match their values.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

obc - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

search

public java.util.List<JournalArticle> search(long companyId,
                                             long groupId,
                                             java.util.List<java.lang.Long> folderIds,
                                             long classNameId,
                                             java.lang.String articleId,
                                             java.lang.Double version,
                                             java.lang.String title,
                                             java.lang.String description,
                                             java.lang.String content,
                                             java.lang.String[] ddmStructureKeys,
                                             java.lang.String[] ddmTemplateKeys,
                                             java.util.Date displayDateGT,
                                             java.util.Date displayDateLT,
                                             int status,
                                             java.util.Date reviewDate,
                                             boolean andOperator,
                                             int start,
                                             int end,
                                             com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)

Returns an ordered range of all the 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.

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

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

articleId - the article ID keywords (space separated, optionally null)

version - the web content article's version (optionally null)

title - the title keywords (space separated, optionally null)

description - the description keywords (space separated, optionally null)

content - the content keywords (space separated, optionally null)

ddmStructureKeys - the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise

ddmTemplateKeys - the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it.

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

andOperator - whether every field must match its value or keywords, or just one field must match. Company, group, folder IDs, class name ID, and status must all match their values.

start - the lower bound of the range of web content articles to return

end - the upper bound of the range of web content articles to return (not inclusive)

obc - the comparator to order the web content articles

Returns:

the range of matching web content articles ordered by the comparator

searchCount

public int searchCount(long companyId,
                       long groupId,
                       java.util.List<java.lang.Long> folderIds,
                       long classNameId,
                       java.lang.String keywords,
                       java.lang.Double version,
                       java.lang.String ddmStructureKey,
                       java.lang.String ddmTemplateKey,
                       java.util.Date displayDateGT,
                       java.util.Date displayDateLT,
                       int status,
                       java.util.Date reviewDate)

Returns the number of web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.

version - the web content article's version (optionally null)

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

Returns:

the number of matching web content articles

searchCount

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

Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

articleId - the article ID keywords (space separated, optionally null)

version - the web content article's version (optionally null)

title - the title keywords (space separated, optionally null)

description - the description keywords (space separated, optionally null)

content - the content keywords (space separated, optionally null)

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

andOperator - whether every field must match its value or keywords, or just one field must match. Group, folder IDs, class name ID, and status must all match their values.

Returns:

the number of matching web content articles

searchCount

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

Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.

Parameters:

companyId - the primary key of the web content article's company

groupId - the primary key of the group (optionally 0)

folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)

classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api module otherwise

articleId - the article ID keywords (space separated, optionally null)

version - the web content article's version (optionally null)

title - the title keywords (space separated, optionally null)

description - the description keywords (space separated, optionally null)

content - the content keywords (space separated, optionally null)

ddmStructureKeys - the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise

ddmTemplateKeys - the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it.

displayDateGT - the date after which a matching web content article's display date must be after (optionally null)

displayDateLT - the date before which a matching web content article's display date must be before (optionally null)

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

reviewDate - the web content article's scheduled review date (optionally null)

andOperator - whether every field must match its value or keywords, or just one field must match. Group, folder IDs, class name ID, and status must all match their values.

Returns:

the number of matching web content articles

subscribeStructure

public void subscribeStructure(long groupId,
                               long userId,
                               long ddmStructureId)
                        throws com.liferay.portal.kernel.exception.PortalException

Subscribes the user to changes in elements that belong to the web content article's DDM structure.

Parameters:

groupId - the primary key of the folder's group

userId - the primary key of the user to be subscribed

ddmStructureId - the primary key of the structure to subscribe to

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeStructure

public void unsubscribeStructure(long groupId,
                                 long userId,
                                 long ddmStructureId)
                          throws com.liferay.portal.kernel.exception.PortalException

Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.

Parameters:

groupId - the primary key of the folder's group

userId - the primary key of the user to be subscribed

ddmStructureId - the primary key of the structure to subscribe to

Throws:

com.liferay.portal.kernel.exception.PortalException

updateArticle

public JournalArticle updateArticle(long userId,
                                    long groupId,
                                    long folderId,
                                    java.lang.String articleId,
                                    double version,
                                    java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                    java.lang.String content,
                                    java.lang.String layoutUuid,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

userId - the primary key of the user updating the web content article

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article folder

articleId - the primary key of the web content article

version - the web content article's version

titleMap - the web content article's locales and localized titles

descriptionMap - the web content article's locales and localized descriptions

content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.

layoutUuid - the unique string identifying the web content article's display page

serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

updateArticle

public JournalArticle updateArticle(long groupId,
                                    long folderId,
                                    java.lang.String articleId,
                                    double version,
                                    java.util.Map<java.util.Locale,java.lang.String> titleMap,
                                    java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                    java.lang.String content,
                                    java.lang.String ddmStructureKey,
                                    java.lang.String ddmTemplateKey,
                                    java.lang.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,
                                    java.lang.String smallImageURL,
                                    java.io.File smallFile,
                                    java.util.Map<java.lang.String,byte[]> images,
                                    java.lang.String articleURL,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

Updates the web content article with additional parameters.

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article folder

articleId - the primary key of the web content article

version - the web content article's version

titleMap - the web content article's locales and localized titles

descriptionMap - the web content article's locales and localized descriptions

content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.

ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise

ddmTemplateKey - the primary key of the web content article's DDM template

layoutUuid - the unique string identifying the web content article's display page

displayDateMonth - the month the web content article is set to display

displayDateDay - the calendar day the web content article is set to display

displayDateYear - the year the web content article is set to display

displayDateHour - the hour the web content article is set to display

displayDateMinute - the minute the web content article is set to display

expirationDateMonth - the month the web content article is set to expire

expirationDateDay - the calendar day the web content article is set to expire

expirationDateYear - the year the web content article is set to expire

expirationDateHour - the hour the web content article is set to expire

expirationDateMinute - the minute the web content article is set to expire

neverExpire - whether the web content article is not set to auto expire

reviewDateMonth - the month the web content article is set for review

reviewDateDay - the calendar day the web content article is set for review

reviewDateYear - the year the web content article is set for review

reviewDateHour - the hour the web content article is set for review

reviewDateMinute - the minute the web content article is set for review

neverReview - whether the web content article is not set for review

indexable - whether the web content is searchable

smallImage - whether to update web content article's a small image. A file must be passed in as smallImageFile value, otherwise the current small image is deleted.

smallImageURL - the web content article's small image URL (optionally null)

smallFile - the web content article's new small image file (optionally null). Must pass in smallImage value of true to replace the article's small image file.

images - the web content's images (optionally null)

articleURL - the web content article's accessible URL (optionally null)

serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

updateArticle

public JournalArticle updateArticle(long groupId,
                                    long folderId,
                                    java.lang.String articleId,
                                    double version,
                                    java.lang.String content,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

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

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

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

Parameters:

groupId - the primary key of the web content article's group

folderId - the primary key of the web content article folder

articleId - the primary key of the web content article

version - the web content article's version

content - the HTML content wrapped in XML.

serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, asset priority, workflow actions, URL title, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

updateArticleTranslation

public JournalArticle updateArticleTranslation(long groupId,
                                               java.lang.String articleId,
                                               double version,
                                               java.util.Locale locale,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String content,
                                               java.util.Map<java.lang.String,byte[]> images,
                                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                        throws com.liferay.portal.kernel.exception.PortalException

Updates the translation of the web content article.

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

locale - the locale of the web content article's display template

title - the translated web content article title

description - the translated web content article description

content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.

images - the web content's images

serviceContext - the service context to be applied. Can set the modification date and URL title for the web content article.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

updateContent

public JournalArticle updateContent(long groupId,
                                    java.lang.String articleId,
                                    double version,
                                    java.lang.String content)
                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

content - the HTML content wrapped in XML. For more information, see the content example in the updateArticle(long, long, String, double, String, ServiceContext) description.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException

updateStatus

public JournalArticle updateStatus(long groupId,
                                   java.lang.String articleId,
                                   double version,
                                   int status,
                                   java.lang.String articleURL,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

groupId - the primary key of the web content article's group

articleId - the primary key of the web content article

version - the web content article's version

status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.

articleURL - the web content article's accessible URL

serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article.

Returns:

the updated web content article

Throws:

com.liferay.portal.kernel.exception.PortalException