Class JournalArticleLocalServiceUtil
com.liferay.journal.service.impl.JournalArticleLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic JournalArticle
addArticle
(String externalReferenceCode, long userId, long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, double version, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, Map<Locale, String> friendlyURLMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, Map<String, byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article with additional parameters.static JournalArticle
addArticle
(String externalReferenceCode, long userId, long groupId, long folderId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article.static JournalArticle
addArticleDefaultValues
(long userId, long groupId, long classNameId, long classPK, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) static void
addArticleResources
(long groupId, String articleId, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the most recently created web content article.static void
addArticleResources
(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the web content article.static void
addArticleResources
(JournalArticle article, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the web content article.static JournalArticle
addJournalArticle
(JournalArticle journalArticle) Adds the journal article to the database.static JournalArticle
checkArticleResourcePrimKey
(long groupId, String articleId, double version) Returns the web content article with the group, article ID, and version.static void
checkArticles
(long companyId) Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.static JournalArticle
copyArticle
(long userId, long groupId, String sourceArticleId, String targetArticleId, boolean autoArticleId, double version) Copies the web content article matching the group, article ID, and version.static JournalArticle
createJournalArticle
(long id) Creates a new journal article with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static JournalArticle
deleteArticle
(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.static void
deleteArticle
(long groupId, String articleId, 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.static JournalArticle
deleteArticle
(JournalArticle article) Deletes the web content article and its resources.static JournalArticle
deleteArticle
(JournalArticle article, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deletes the web content article and its resources, optionally sending email notifying denial of the article if it had not yet been approved.static void
deleteArticleDefaultValues
(long groupId, String articleId, long ddmStructureId) static void
deleteArticles
(long groupId) Deletes all the group's web content articles and resources.static void
deleteArticles
(long groupId, long folderId) Deletes all the group's web content articles and resources in the folder, including recycled articles.static void
deleteArticles
(long groupId, long folderId, boolean includeTrashedEntries) Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.static void
deleteArticles
(long groupId, String className, long classPK) Deletes all the group's web content articles and resources matching the class name and class primary key.static JournalArticle
deleteJournalArticle
(long id) Deletes the journal article with the primary key from the database.static JournalArticle
deleteJournalArticle
(JournalArticle journalArticle) Deletes the journal article from the database.static void
deleteLayoutArticleReferences
(long groupId, String layoutUuid) Deletes the layout's association with the web content articles for the group.static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static JournalArticle
expireArticle
(long userId, long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Expires the web content article matching the group, article ID, and version.static void
expireArticle
(long userId, long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Expires the web content article matching the group and article ID, expiring all of its versions if thejournal.article.expire.all.versions
portal property istrue
, otherwise expiring only its latest approved version.static JournalArticle
fetchArticle
(long id) Returns the web content article with the ID.static JournalArticle
fetchArticle
(long groupId, String articleId) static JournalArticle
fetchArticle
(long groupId, String articleId, double version) Returns the web content article matching the group, article ID, and version.static JournalArticle
fetchArticleByUrlTitle
(long groupId, String urlTitle) static JournalArticle
fetchArticleByUrlTitle
(long groupId, String urlTitle, double version) static JournalArticle
fetchDisplayArticle
(long groupId, String articleId) static JournalArticle
fetchJournalArticle
(long id) static JournalArticle
fetchJournalArticleByUuidAndGroupId
(String uuid, long groupId) Returns the journal article matching the UUID and group.static JournalArticle
fetchLatestArticle
(long resourcePrimKey) static JournalArticle
fetchLatestArticle
(long resourcePrimKey, int status) static JournalArticle
fetchLatestArticle
(long resourcePrimKey, int[] statuses) static JournalArticle
fetchLatestArticle
(long resourcePrimKey, int status, boolean preferApproved) Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.static JournalArticle
fetchLatestArticle
(long groupId, String articleId, int status) Returns the latest web content article matching the group, article ID, and workflow status.static JournalArticle
fetchLatestArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.static JournalArticle
fetchLatestArticleByExternalReferenceCode
(long groupId, String externalReferenceCode, int[] statuses) static JournalArticle
fetchLatestArticleByExternalReferenceCode
(long groupId, String externalReferenceCode, int status, boolean preferApproved) static JournalArticle
fetchLatestArticleByUrlTitle
(long groupId, String urlTitle, int status) static JournalArticle
fetchLatestIndexableArticle
(long resourcePrimKey) Returns the latest indexable web content article matching the resource primary key.static com.liferay.portal.kernel.model.PersistedModel
fetchPersistedModel
(Serializable primaryKeyObj) static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static JournalArticle
getArticle
(long id) Returns the web content article with the ID.static JournalArticle
getArticle
(long groupId, String articleId) Returns the latest approved web content article, or the latest unapproved article if none are approved.static JournalArticle
getArticle
(long groupId, String articleId, double version) Returns the web content article matching the group, article ID, and version.static JournalArticle
getArticle
(long groupId, String className, long classPK) Returns the web content article matching the group, class name, and class PK.static JournalArticle
getArticleByUrlTitle
(long groupId, String urlTitle) Returns the latest web content article that is approved, or the latest unapproved article if none are approved.static String
getArticleContent
(long groupId, String articleId, double version, String viewMode, String ddmTemplateKey, 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, and associated with the portlet request model and the DDM template.static String
getArticleContent
(long groupId, String articleId, String viewMode, String ddmTemplateKey, 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, and associated with the portlet request model and the DDM template.static String
getArticleContent
(JournalArticle article, String ddmTemplateKey, String viewMode, 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 associated with the portlet request model and the DDM template.static String
getArticleDescription
(long articlePK, String languageId) static String
getArticleDescription
(long articlePK, Locale locale) getArticleDescriptionMap
(long articlePK) static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the specified page of the specified version of the web content article matching the group, article ID, and DDM template.static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the first page of the specified version of the web content article matching the group, article ID, and DDM template.static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the specified page of the latest version of the web content article matching the group and article ID.static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the first page of the latest version of the web content article matching the group and article ID.static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the specified page of the latest version of the web content article matching the group, article ID, and DDM template.static JournalArticleDisplay
getArticleDisplay
(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the first page of the latest version of the web content article matching the group, article ID, and DDM template.static JournalArticleDisplay
getArticleDisplay
(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) Returns a web content article display for the specified page of the latest version of the web content article, based on the DDM template.getArticleLocalizationLanguageIds
(long articlePK) static List<JournalArticle>
Returns all the web content articles present in the system.static List<JournalArticle>
getArticles
(long groupId) Returns all the web content articles belonging to the group.static List<JournalArticle>
getArticles
(long groupId, int start, int end) Returns a range of all the web content articles belonging to the group.static List<JournalArticle>
getArticles
(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles belonging to the group.static List<JournalArticle>
getArticles
(long groupId, long folderId) Returns all the web content articles matching the group and folder.static List<JournalArticle>
getArticles
(long groupId, long folderId, int start, int end) Returns a range of all the web content articles matching the group and folder.static List<JournalArticle>
getArticles
(long groupId, long folderId, int status, int start, int end) Returns a range of all the web content articles matching the group, folder, and status.static List<JournalArticle>
getArticles
(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and folder.static List<JournalArticle>
getArticles
(long groupId, String articleId) Returns all the web content articles matching the group and article ID.static List<JournalArticle>
getArticles
(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) static List<JournalArticle>
getArticlesByResourcePrimKey
(long resourcePrimKey) Returns all the web content articles matching the resource primary key.static List<JournalArticle>
getArticlesByReviewDate
(long companyId, Date previousCheckDate, Date reviewDate) static List<JournalArticle>
getArticlesBySmallImageId
(long smallImageId) Returns all the web content articles matching the small image ID.static List<JournalArticle>
getArticlesByStructureId
(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) static List<JournalArticle>
getArticlesByStructureId
(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) static List<JournalArticle>
getArticlesByStructureId
(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) static List<JournalArticle>
getArticlesByStructureId
(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) static List<JournalArticle>
getArticlesByStructureId
(long groupId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) getArticlesClassPKsWithDefaultDisplayPage
(long groupId, long classTypeId) static int
getArticlesCount
(long groupId) Returns the number of web content articles belonging to the group.static int
getArticlesCount
(long groupId, long folderId) Returns the number of web content articles matching the group and folder.static int
getArticlesCount
(long groupId, long folderId, int status) Returns the number of web content articles matching the group, folder, and status.static int
getArticlesCount
(long groupId, String articleId) static int
getArticlesCountByResourcePrimKey
(long resourcePrimKey) static String
getArticleTitle
(long articlePK, String languageId) static String
getArticleTitle
(long articlePK, Locale locale) getArticleTitleMap
(long articlePK) static List<JournalArticle>
getCompanyArticles
(long companyId, double version, int status, int start, int end) Returns an ordered range of all the web content articles matching the company, version, and workflow status.static List<JournalArticle>
getCompanyArticles
(long companyId, int status, int start, int end) Returns an ordered range of all the web content articles matching the company and workflow status.static int
getCompanyArticlesCount
(long companyId, double version, int status, int start, int end) Returns the number of web content articles matching the company, version, and workflow status.static int
getCompanyArticlesCount
(long companyId, int status) Returns the number of web content articles matching the company and workflow status.static JournalArticle
getDisplayArticle
(long groupId, String articleId) Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed.static JournalArticle
getDisplayArticleByUrlTitle
(long groupId, String urlTitle) Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getGroupIdsByUrlTitle
(long companyId, String urlTitle) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static JournalArticle
getJournalArticle
(long id) Returns the journal article with the primary key.static JournalArticle
getJournalArticleByUuidAndGroupId
(String uuid, long groupId) Returns the journal article matching the UUID and group.static List<JournalArticle>
getJournalArticles
(int start, int end) Returns a range of all the journal articles.static List<JournalArticle>
getJournalArticlesByUuidAndCompanyId
(String uuid, long companyId) Returns all the journal articles matching the UUID and company.static List<JournalArticle>
getJournalArticlesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns a range of journal articles matching the UUID and company.static int
Returns the number of journal articles.static JournalArticle
getLatestArticle
(long resourcePrimKey) Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.static JournalArticle
getLatestArticle
(long resourcePrimKey, int status) Returns the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status.static JournalArticle
getLatestArticle
(long resourcePrimKey, int status, boolean preferApproved) Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.static JournalArticle
getLatestArticle
(long groupId, String articleId) Returns the latest web content article with the group and article ID.static JournalArticle
getLatestArticle
(long groupId, String articleId, int status) Returns the latest web content article matching the group, article ID, and workflow status.static JournalArticle
getLatestArticle
(long groupId, String className, long classPK) Returns the latest web content article matching the group, class name ID, and class PK.static JournalArticle
getLatestArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.static JournalArticle
getLatestArticleByExternalReferenceCode
(long groupId, String externalReferenceCode, int status, boolean preferApproved) static JournalArticle
getLatestArticleByUrlTitle
(long groupId, String urlTitle, int status) Returns the latest web content article matching the group, URL title, and workflow status.static double
getLatestVersion
(long groupId, String articleId) Returns the latest version number of the web content with the group and article ID.static double
getLatestVersion
(long groupId, String articleId, int status) Returns the latest version number of the web content with the group, article ID, and workflow status.static List<JournalArticle>
static List<JournalArticle>
static int
getNotInTrashArticlesCount
(long groupId, long folderId) Returns the number of web content articles that are not recycled.static JournalArticle
getOldestArticle
(long groupId, String articleId) Returns the oldest web content article with the group and article ID.static JournalArticle
getOldestArticle
(long groupId, String articleId, int status) Returns the oldest web content article matching the group, article ID, and workflow status.static String
Returns the OSGi service identifier.static List<? extends com.liferay.portal.kernel.model.PersistedModel>
getPersistedModel
(long resourcePrimKey) static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static JournalArticle
getPreviousApprovedArticle
(JournalArticle article) Returns the previously approved version of the web content article.static JournalArticleLocalService
static List<JournalArticle>
getStructureArticles
(long ddmStructureId) Returns the web content articles matching the DDM structure keys.static List<JournalArticle>
getStructureArticles
(long groupId, long ddmStructureId) Returns the web content articles matching the group and DDM structure key.static List<JournalArticle>
getStructureArticles
(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and DDM structure key.static int
getStructureArticlesCount
(long groupId, long ddmStructureId) Returns the number of web content articles matching the group and DDM structure key.static List<JournalArticle>
getTemplateArticles
(long groupId, String ddmTemplateKey) Returns the web content articles matching the group and DDM template key.static List<JournalArticle>
getTemplateArticles
(long groupId, String ddmTemplateKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and DDM template key.static int
getTemplateArticlesCount
(long groupId, String ddmTemplateKey) Returns the number of web content articles matching the group and DDM template key.static String
getUniqueUrlTitle
(long groupId, String articleId, String urlTitle) Returns the web content article's unique URL title.static boolean
hasArticle
(long groupId, String articleId) Returnstrue
if the specified web content article exists.static boolean
isLatestVersion
(long groupId, String articleId, double version) Returnstrue
if the web content article, specified by group and article ID, is the latest version.static boolean
isLatestVersion
(long groupId, String articleId, double version, int status) Returnstrue
if the web content article, specified by group, article ID, and workflow status, is the latest version.static boolean
isListable
(JournalArticle article) static boolean
isRenderable
(JournalArticle article, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) static JournalArticle
moveArticle
(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the web content article matching the group and article ID to a new folder.static JournalArticle
moveArticleFromTrash
(long userId, long groupId, JournalArticle article, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the web content article from the Recycle Bin to a new folder.static JournalArticle
moveArticleToTrash
(long userId, long groupId, String articleId) Moves the latest version of the web content article matching the group and article ID to the recycle bin.static JournalArticle
moveArticleToTrash
(long userId, JournalArticle article) Moves the latest version of the web content article matching the group and article ID to the recycle bin.static void
rebuildTree
(long companyId) Rebuilds the web content article's tree path using tree traversal.static JournalArticle
removeArticleLocale
(long groupId, String articleId, double version, String languageId) Removes the web content of the web content article matching the group, article ID, and version, and language.static JournalArticle
restoreArticleFromTrash
(long userId, JournalArticle article) Restores the web content article from the Recycle Bin.static void
setTreePaths
(long folderId, String treePath, boolean reindex) static void
subscribe
(long userId, long groupId, long articleId) Subscribes the user to changes in elements that belong to the web content article.static void
subscribeStructure
(long groupId, long userId, long ddmStructureId) Subscribes the user to changes in elements that belong to the web content article's DDM structure.static void
unsubscribe
(long userId, long groupId, long articleId) Unsubscribes the user from changes in elements that belong to the web content article.static void
unsubscribeStructure
(long groupId, long userId, long ddmStructureId) Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.static JournalArticle
updateArticle
(long userId, long groupId, long folderId, String articleId, double version, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder and content.static JournalArticle
updateArticle
(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String content, String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.static JournalArticle
updateArticle
(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, Map<Locale, String> friendlyURLMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, Map<String, byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article with additional parameters.static JournalArticle
updateArticle
(long id, String urlTitle) Updates the URL title of the web content article.static JournalArticle
updateArticleDefaultValues
(long userId, long groupId, String articleId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) static JournalArticle
updateArticleTranslation
(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String, byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the translation of the web content article.static void
updateAsset
(long userId, JournalArticle article, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds, Double priority) Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary.static void
updateDDMTemplateKey
(long groupId, long classNameId, String oldDDMTemplateKey, String newDDMTemplateKey) Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one.static JournalArticle
updateJournalArticle
(JournalArticle journalArticle) Updates the journal article in the database or adds it if it does not yet exist.static JournalArticle
updateStatus
(long userId, long classPK, int status, Map<String, Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the workflow status of the web content article matching the class PK.static JournalArticle
updateStatus
(long userId, long groupId, String articleId, double version, int status, String articleURL, Map<String, Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the workflow status of the web content article matching the group, article ID, and version.static JournalArticle
updateStatus
(long userId, JournalArticle article, int status, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String, Serializable> workflowContext) Updates the workflow status of the web content article.
-
Constructor Details
-
JournalArticleLocalServiceUtil
public JournalArticleLocalServiceUtil()
-
-
Method Details
-
addArticle
public static JournalArticle addArticle(String externalReferenceCode, long userId, long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, double version, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, Map<Locale, String> friendlyURLMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, Map<String, byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article with additional parameters. All scheduling parameters (display date, expiration date, and review date) use the current user's timezone.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:
externalReferenceCode
- the external reference code of the web content articleuserId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderclassNameId
- the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwiseclassPK
- the primary key of the DDM structure, if the primary key of the DDMStructure class is given as theclassNameId
parameter, the primary key of the class associated with the web content article, or0
otherwisearticleId
- the primary key of the web content articleautoArticleId
- whether to auto generate the web content article IDversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized descriptionsfriendlyURLMap
- the web content article's locales and localized friendly URLscontent
- the HTML content wrapped in XMLddmStructureId
- the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or0
otherwiseddmTemplateKey
- the primary key of the web content article's DDM templatelayoutUuid
- the unique string identifying the web content article's display pagedisplayDateMonth
- the month the web content article is set to displaydisplayDateDay
- the calendar day the web content article is set to displaydisplayDateYear
- the year the web content article is set to displaydisplayDateHour
- the hour the web content article is set to displaydisplayDateMinute
- the minute the web content article is set to displayexpirationDateMonth
- the month the web content article is set to expireexpirationDateDay
- the calendar day the web content article is set to expireexpirationDateYear
- the year the web content article is set to expireexpirationDateHour
- the hour the web content article is set to expireexpirationDateMinute
- the minute the web content article is set to expireneverExpire
- whether the web content article is not set to auto expirereviewDateMonth
- the month the web content article is set for reviewreviewDateDay
- the calendar day the web content article is set for reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content article is searchablesmallImage
- whether the web content article has a small imagesmallImageSource
- the web content article's small image sourcesmallImageURL
- the web content article's small image URLsmallImageFile
- the web content article's small image fileimages
- the web content's imagesarticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, URL title, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.- Returns:
- the web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addArticle
public static JournalArticle addArticle(String externalReferenceCode, long userId, long groupId, long folderId, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a web content article.- Parameters:
externalReferenceCode
- the external reference code of the web content article.userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article foldertitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized descriptionscontent
- the HTML content wrapped in XML. For more information, see the content example in theaddArticle(String, long, long, long, long, long, String, boolean, double, Map, Map, Map, String, long, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, long, int, String, File, Map, String, ServiceContext)
description.ddmStructureId
- the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or0
otherwiseddmTemplateKey
- the primary key of the web content article's DDM templateserviceContext
- 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
- if a portal exception occurred
-
addArticleDefaultValues
public static JournalArticle addArticleDefaultValues(long userId, long groupId, long classNameId, long classPK, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String content, long ddmStructureId, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addArticleResources
public static void addArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the web content article.- Parameters:
article
- the web content articleaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addArticleResources
public static void addArticleResources(JournalArticle article, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the model resources with the permissions to the web content article.- Parameters:
article
- the web content article to add resources tomodelPermissions
- the model permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addArticleResources
public static void addArticleResources(long groupId, String articleId, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the most recently created web content article.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addJournalArticle
Adds the journal article to the database. Also notifies the appropriate model listeners.Important: Inspect JournalArticleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
journalArticle
- the journal article- Returns:
- the journal article that was added
-
checkArticleResourcePrimKey
public static JournalArticle checkArticleResourcePrimKey(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article with the group, article ID, and version. This method checks for the article's resource primary key and, if not found, creates a new one.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's version- Returns:
- the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
checkArticles
public static void checkArticles(long companyId) throws com.liferay.portal.kernel.exception.PortalException Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyArticle
public static JournalArticle copyArticle(long userId, long groupId, String sourceArticleId, String targetArticleId, boolean autoArticleId, double version) throws com.liferay.portal.kernel.exception.PortalException Copies the web content article matching the group, article ID, and version. This method creates a new article, extracting all the values from the old one and updating its article ID.- Parameters:
userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupsourceArticleId
- the primary key of the old web content articletargetArticleId
- the primary key of the new web content articleautoArticleId
- whether to auto-generate the web content article IDversion
- the web content article's version- Returns:
- the new web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
createJournalArticle
Creates a new journal article with the primary key. Does not add the journal article to the database.- Parameters:
id
- the primary key for the new journal article- Returns:
- the new journal article
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteArticle
public static JournalArticle deleteArticle(JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException Deletes the web content article and its resources.- Parameters:
article
- the web content article- Returns:
- the deleted web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticle
public static JournalArticle deleteArticle(JournalArticle article, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Deletes the web content article and its resources, optionally sending email notifying denial of the article if it had not yet been approved.- Parameters:
article
- the web content articlearticleURL
- the web content article's accessible URL to include in email notifications (optionallynull
)serviceContext
- the service context to be applied (optionallynull
). Can set the portlet preferences that include email information to notify recipients of the unapproved web content's denial.- Returns:
- the deleted web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticle
public static JournalArticle deleteArticle(long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionarticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the portlet preferences that include email information to notify recipients of the unapproved web content article's denial.- Returns:
- the deleted web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticle
public static void deleteArticle(long groupId, String articleId, 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 grouparticleId
- the primary key of the web content articleserviceContext
- 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
- if a portal exception occurred
-
deleteArticleDefaultValues
public static void deleteArticleDefaultValues(long groupId, String articleId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteArticles
public static void deleteArticles(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the group's web content articles and resources.- Parameters:
groupId
- the primary key of the web content article's group- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticles
public static void deleteArticles(long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the group's web content articles and resources in the folder, including recycled articles.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folder- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticles
public static void deleteArticles(long groupId, long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderincludeTrashedEntries
- whether to include recycled web content articles- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteArticles
public static void deleteArticles(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes all the group's web content articles and resources matching the class name and class primary key.- Parameters:
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwiseclassPK
- the primary key of the DDM structure, if the DDMStructure class name is given as theclassName
parameter, the primary key of the class associated with the web content article, or0
otherwise- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteJournalArticle
Deletes the journal article from the database. Also notifies the appropriate model listeners.Important: Inspect JournalArticleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
journalArticle
- the journal article- Returns:
- the journal article that was removed
-
deleteJournalArticle
public static JournalArticle deleteJournalArticle(long id) throws com.liferay.portal.kernel.exception.PortalException Deletes the journal article with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect JournalArticleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
id
- the primary key of the journal article- Returns:
- the journal article that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a journal article with the primary key could not be found
-
deleteLayoutArticleReferences
Deletes the layout's association with the web content articles for the group.- Parameters:
groupId
- the primary key of the web content article's grouplayoutUuid
- the unique string identifying the web content article's display page
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
expireArticle
public static JournalArticle expireArticle(long userId, long groupId, String articleId, double version, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Expires the web content article matching the group, article ID, and version.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionarticleURL
- the web content article's accessible URLserviceContext
- 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 toConstants#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
- if a portal exception occurred
-
expireArticle
public static void expireArticle(long userId, long groupId, String articleId, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Expires the web content article matching the group and article ID, expiring all of its versions if thejournal.article.expire.all.versions
portal property istrue
, otherwise expiring only its latest approved version.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlearticleURL
- the web content article's accessible URLserviceContext
- 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 toConstants#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
- if a portal exception occurred
-
fetchArticle
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
-
fetchArticle
-
fetchArticle
Returns the web content article matching the group, article ID, and version.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's version- Returns:
- the web content article matching the group, article ID, and
version, or
null
if no web content article could be found
-
fetchArticleByUrlTitle
-
fetchArticleByUrlTitle
-
fetchDisplayArticle
-
fetchJournalArticle
-
fetchJournalArticleByUuidAndGroupId
Returns the journal article matching the UUID and group.- Parameters:
uuid
- the journal article's UUIDgroupId
- the primary key of the group- Returns:
- the matching journal article, or
null
if a matching journal article could not be found
-
fetchLatestArticle
-
fetchLatestArticle
-
fetchLatestArticle
public static JournalArticle fetchLatestArticle(long resourcePrimKey, int status, boolean preferApproved) Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.- Parameters:
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.preferApproved
- whether to prefer returning the latest matching article that has workflow statusWorkflowConstants#STATUS_APPROVED
over returning one that has a different status- Returns:
- the latest web content article matching the resource primary key
and workflow status, optionally preferring articles with an
approved workflow status, or
null
if no matching web content article could be found
-
fetchLatestArticle
-
fetchLatestArticle
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 grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article, or
null
if no matching web content article could be found
-
fetchLatestArticleByExternalReferenceCode
public static JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.- Parameters:
groupId
- the primary key of the web content article's groupexternalReferenceCode
- the web content article's external reference code- Returns:
- the latest matching web content article, or
null
if no matching web content article could be found
-
fetchLatestArticleByExternalReferenceCode
public static JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) -
fetchLatestArticleByExternalReferenceCode
public static JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int[] statuses) -
fetchLatestArticleByUrlTitle
public static JournalArticle fetchLatestArticleByUrlTitle(long groupId, String urlTitle, int status) -
fetchLatestIndexableArticle
Returns the latest indexable web content article matching the resource primary key.- Parameters:
resourcePrimKey
- the primary key of the resource instance- Returns:
- the latest indexable web content article matching the resource
primary key, or
null
if no matching web content article could be found
-
fetchPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel fetchPersistedModel(Serializable primaryKeyObj) -
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getArticle
public static 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
- if a portal exception occurred
-
getArticle
public static JournalArticle getArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the latest approved web content article, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and article ID.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticle
public static JournalArticle getArticle(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the group, article ID, and version.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's version- Returns:
- the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticle
public static JournalArticle getArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the group, class name, and class PK.- Parameters:
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwiseclassPK
- the primary key of the DDM structure, if the DDMStructure class name is given as theclassName
parameter, the primary key of the class associated with the web content article, or0
otherwise- Returns:
- the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleByUrlTitle
public static JournalArticle getArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article that is approved, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and URL title.- Parameters:
groupId
- the primary key of the web content article's groupurlTitle
- the web content article's accessible URL title- Returns:
- the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleContent
public static String getArticleContent(JournalArticle article, String ddmTemplateKey, String viewMode, 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 associated with the portlet request model and the DDM template.- Parameters:
article
- the web content articleddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content from the web content article associated with the portlet request model and the DDM template
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleContent
public static String getArticleContent(long groupId, String articleId, double version, String viewMode, String ddmTemplateKey, 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, and associated with the portlet request model and the DDM template.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's DDM templatelanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content from the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleContent
public static String getArticleContent(long groupId, String articleId, String viewMode, String ddmTemplateKey, 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, and associated with the portlet request model and the DDM template.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's DDM templatelanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the latest web content from the matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDescription
-
getArticleDescription
-
getArticleDescriptionMap
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(JournalArticle article, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the specified page of the latest version of the web content article, based on the DDM template. Web content transformation tokens are added using the portlet request model and theme display.- Parameters:
article
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the specified page of the specified version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added using the portlet request model and theme display.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, double version, String ddmTemplateKey, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the first page of the specified version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added from the theme display (if notnull
).- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the specified page of the latest version of the web content article matching the group and article ID. Web content transformation tokens are added from the theme display (if notnull
).- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the specified page of the latest version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added using the portlet request model and theme display.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String ddmTemplateKey, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the first page of the latest version of the web content article matching the group, article ID, and DDM template. Web content transformation tokens are added from the theme display (if notnull
).- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleDisplay
public static JournalArticleDisplay getArticleDisplay(long groupId, String articleId, String viewMode, String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException Returns a web content article display for the first page of the latest version of the web content article matching the group and article ID. Web content transformation tokens are added from the theme display (if notnull
).- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme display- Returns:
- the web content article display, or
null
if the article has expired or if article's display date/time is after the current date/time - Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getArticleLocalizationLanguageIds
-
getArticles
Returns all the web content articles present in the system.- Returns:
- the web content articles present in the system
-
getArticles
Returns all the web content articles belonging to the group.- Parameters:
groupId
- the primary key of the web content article's group- Returns:
- the web content articles belonging to the group
-
getArticles
Returns a range of all the web content articles belonging to the group.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupstart
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the range of matching web content articles
-
getArticles
public static List<JournalArticle> getArticles(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles belonging to the group.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupstart
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)orderByComparator
- the comparator to order the web content articles- Returns:
- the range of matching web content articles ordered by the comparator
-
getArticles
Returns all the web content articles matching the group and folder.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folder- Returns:
- the matching web content articles
-
getArticles
Returns a range of all the web content articles matching the group and folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstart
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the range of matching web content articles
-
getArticles
public static List<JournalArticle> getArticles(long groupId, long folderId, int status, int start, int end) Returns a range of all the web content articles matching the group, folder, and status.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the range of matching web content articles
-
getArticles
public static List<JournalArticle> getArticles(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstart
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)orderByComparator
- the comparator to order the web content articles- Returns:
- the range of matching web content articles ordered by the comparator
-
getArticles
Returns all the web content articles matching the group and article ID.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the matching web content articles
-
getArticles
public static List<JournalArticle> getArticles(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesByResourcePrimKey
Returns all the web content articles matching the resource primary key.- Parameters:
resourcePrimKey
- the primary key of the resource instance- Returns:
- the web content articles matching the resource primary key
-
getArticlesByReviewDate
public static List<JournalArticle> getArticlesByReviewDate(long companyId, Date previousCheckDate, Date reviewDate) -
getArticlesBySmallImageId
Returns all the web content articles matching the small image ID.- Parameters:
smallImageId
- the primary key of the web content article's small image- Returns:
- the web content articles matching the small image ID
-
getArticlesByStructureId
public static List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesByStructureId
public static List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesByStructureId
public static List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesByStructureId
public static List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesByStructureId
public static List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) -
getArticlesClassPKsWithDefaultDisplayPage
-
getArticlesCount
public static int getArticlesCount(long groupId) Returns the number of web content articles belonging to the group.- Parameters:
groupId
- the primary key of the web content article's group- Returns:
- the number of web content articles belonging to the group
-
getArticlesCount
public static int getArticlesCount(long groupId, 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 groupfolderId
- the primary key of the web content article's folder- Returns:
- the number of matching web content articles
-
getArticlesCount
public static int getArticlesCount(long groupId, long folderId, int status) Returns the number of web content articles matching the group, folder, and status.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching web content articles
-
getArticlesCount
-
getArticlesCountByResourcePrimKey
public static int getArticlesCountByResourcePrimKey(long resourcePrimKey) -
getArticleTitle
-
getArticleTitle
-
getArticleTitleMap
-
getCompanyArticles
public static List<JournalArticle> getCompanyArticles(long companyId, double version, int status, int start, int end) Returns an ordered range of all the web content articles matching the company, version, and workflow status.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the web content article's companyversion
- the web content article's versionstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the range of matching web content articles ordered by article ID
-
getCompanyArticles
public static List<JournalArticle> getCompanyArticles(long companyId, int status, int start, int end) Returns an ordered range of all the web content articles matching the company and workflow status.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the web content article's companystatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the range of matching web content articles ordered by article ID
-
getCompanyArticlesCount
public static int getCompanyArticlesCount(long companyId, double version, int status, int start, int end) Returns the number of web content articles matching the company, version, and workflow status.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the web content article's companyversion
- the web content article's versionstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to returnend
- the upper bound of the range of web content articles to return (not inclusive)- Returns:
- the number of matching web content articles
-
getCompanyArticlesCount
public static int getCompanyArticlesCount(long companyId, int status) Returns the number of web content articles matching the company and workflow status.- Parameters:
companyId
- the primary key of the web content article's companystatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the number of matching web content articles
-
getDisplayArticle
public static JournalArticle getDisplayArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the matching web content article currently displayed, or the next one to be displayed if no version of the article is currently displayed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getDisplayArticleByUrlTitle
public static JournalArticle getDisplayArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.- Parameters:
groupId
- the primary key of the web content article's groupurlTitle
- 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
- if a portal exception occurred
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getGroupIdsByUrlTitle
-
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getJournalArticle
public static JournalArticle getJournalArticle(long id) throws com.liferay.portal.kernel.exception.PortalException Returns the journal article with the primary key.- Parameters:
id
- the primary key of the journal article- Returns:
- the journal article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a journal article with the primary key could not be found
-
getJournalArticleByUuidAndGroupId
public static JournalArticle getJournalArticleByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the journal article matching the UUID and group.- Parameters:
uuid
- the journal article's UUIDgroupId
- the primary key of the group- Returns:
- the matching journal article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching journal article could not be found
-
getJournalArticles
Returns a range of all the journal articles.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl
.- Parameters:
start
- the lower bound of the range of journal articlesend
- the upper bound of the range of journal articles (not inclusive)- Returns:
- the range of journal articles
-
getJournalArticlesByUuidAndCompanyId
public static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid, long companyId) Returns all the journal articles matching the UUID and company.- Parameters:
uuid
- the UUID of the journal articlescompanyId
- the primary key of the company- Returns:
- the matching journal articles, or an empty list if no matches were found
-
getJournalArticlesByUuidAndCompanyId
public static List<JournalArticle> getJournalArticlesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns a range of journal articles matching the UUID and company.- Parameters:
uuid
- the UUID of the journal articlescompanyId
- the primary key of the companystart
- the lower bound of the range of journal articlesend
- the upper bound of the range of journal articles (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching journal articles, or an empty list if no matches were found
-
getJournalArticlesCount
public static int getJournalArticlesCount()Returns the number of journal articles.- Returns:
- the number of journal articles
-
getLatestArticle
public static JournalArticle getLatestArticle(long 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
- if a portal exception occurred
-
getLatestArticle
public static JournalArticle getLatestArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status.- Parameters:
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticle
public static JournalArticle getLatestArticle(long resourcePrimKey, int status, boolean preferApproved) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.- Parameters:
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.preferApproved
- whether to prefer returning the latest matching article that has workflow statusWorkflowConstants#STATUS_APPROVED
over returning one that has a different status- Returns:
- the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticle
public static JournalArticle getLatestArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article with the group and article ID.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the latest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticle
public static JournalArticle getLatestArticle(long groupId, String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group, article ID, and workflow status.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticle
public static JournalArticle getLatestArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group, class name ID, and class PK.- Parameters:
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article is related to a DDM structure, the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwiseclassPK
- the primary key of the DDM structure, if the DDMStructure class name is given as theclassName
parameter, the primary key of the class associated with the web content article, or0
otherwise- Returns:
- the latest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticleByExternalReferenceCode
public static JournalArticle getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group and the external reference code.- Parameters:
groupId
- the primary key of the web content article's groupexternalReferenceCode
- the web content article's external reference code- Returns:
- the latest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestArticleByExternalReferenceCode
public static JournalArticle getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestArticleByUrlTitle
public static JournalArticle getLatestArticleByUrlTitle(long groupId, String urlTitle, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group, URL title, and workflow status.- Parameters:
groupId
- the primary key of the web content article's groupurlTitle
- the web content article's accessible URL titlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestVersion
public static double getLatestVersion(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the latest version number of the web content with the group and article ID.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the latest version number of the matching web content
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getLatestVersion
public static double getLatestVersion(long groupId, String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the latest version number of the web content with the group, article ID, and workflow status.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the latest version number of the matching web content
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getNoAssetArticles
-
getNoPermissionArticles
-
getNotInTrashArticlesCount
public static int getNotInTrashArticlesCount(long groupId, long folderId) Returns the number of web content articles that are not recycled.- Parameters:
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folder- Returns:
- the number of web content articles that are not recycled
-
getOldestArticle
public static JournalArticle getOldestArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the oldest web content article with the group and article ID.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content article- Returns:
- the oldest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getOldestArticle
public static JournalArticle getOldestArticle(long groupId, String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the oldest web content article matching the group, article ID, and workflow status.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
- the oldest matching web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPreviousApprovedArticle
Returns the previously approved version of the web content article. For more information on the approved workflow status, seeWorkflowConstants#STATUS_APPROVED
.- Parameters:
article
- the web content article- Returns:
- the previously approved version of the web content article, or the current web content article if there are no previously approved web content articles
-
getStructureArticles
Returns the web content articles matching the DDM structure keys.- Parameters:
ddmStructureId
- the primary key of the web content article's DDM structure- Returns:
- the web content articles matching the DDM structure keys
-
getStructureArticles
Returns the web content articles matching the group and DDM structure key.- Parameters:
groupId
- the primary key of the web content article's groupddmStructureId
- the primary key of the web content article's DDM structure- Returns:
- the matching web content articles
-
getStructureArticles
public static List<JournalArticle> getStructureArticles(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and DDM structure key.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupddmStructureId
- the primary key of the web content article's DDM structurestart
- the lower bound of the range of web content articles to returnend
- 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
-
getStructureArticlesCount
public static int getStructureArticlesCount(long groupId, long ddmStructureId) Returns the number of web content articles matching the group and DDM structure key.- Parameters:
groupId
- the primary key of the web content article's groupddmStructureId
- the primary key of the web content article's DDM structure- Returns:
- the number of matching web content articles
-
getTemplateArticles
Returns the web content articles matching the group and DDM template key.- Parameters:
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM template- Returns:
- the matching web content articles
-
getTemplateArticles
public static List<JournalArticle> getTemplateArticles(long groupId, String ddmTemplateKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) Returns an ordered range of all the web content articles matching the group and DDM template key.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM templatestart
- the lower bound of the range of web content articles to returnend
- 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
-
getTemplateArticlesCount
Returns the number of web content articles matching the group and DDM template key.- Parameters:
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM template- Returns:
- the number of matching web content articles
-
getUniqueUrlTitle
public static String getUniqueUrlTitle(long groupId, String articleId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article's unique URL title.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleurlTitle
- the web content article's accessible URL title- Returns:
- the web content article's unique URL title
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
hasArticle
Returnstrue
if the specified web content article exists.- Parameters:
groupId
- the primary key of the grouparticleId
- the primary key of the web content article- Returns:
true
if the specified web content article exists;false
otherwise
-
isLatestVersion
public static boolean isLatestVersion(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException Returnstrue
if the web content article, specified by group and article ID, is the latest version.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's version- Returns:
true
if the specified web content article is the latest version;false
otherwise- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
isLatestVersion
public static boolean isLatestVersion(long groupId, String articleId, double version, int status) throws com.liferay.portal.kernel.exception.PortalException Returnstrue
if the web content article, specified by group, article ID, and workflow status, is the latest version.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.- Returns:
true
if the specified web content article is the latest version;false
otherwise- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
isListable
-
isRenderable
public static boolean isRenderable(JournalArticle article, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) -
moveArticle
public static JournalArticle moveArticle(long groupId, String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Moves the web content article matching the group and article ID to a new folder.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlenewFolderId
- the primary key of the web content article's new folderserviceContext
- 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 toConstants#UPDATE
, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.- Returns:
- the updated web content article, which was moved to a new folder
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
moveArticleFromTrash
public static JournalArticle moveArticleFromTrash(long userId, long groupId, JournalArticle article, 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 a new folder.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's grouparticle
- the web content articlenewFolderId
- the primary key of the web content article's new folderserviceContext
- 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 toConstants#UPDATE
, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.- Returns:
- the updated web content article, which was moved from the Recycle Bin to a new folder
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
moveArticleToTrash
public static JournalArticle moveArticleToTrash(long userId, JournalArticle article) 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:
userId
- the primary key of the user updating the web content articlearticle
- the web content article- Returns:
- the updated web content article, which was moved to the Recycle Bin
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
moveArticleToTrash
public static JournalArticle moveArticleToTrash(long userId, long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Moves the latest version of the web content article matching the group and article ID to the recycle bin.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's grouparticleId
- 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
- if a portal exception occurred
-
rebuildTree
public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException Rebuilds the web content article's tree path using tree traversal.For example, here is a conceptualization of a web content article tree path:
/(Folder's folderId)/(Subfolder's folderId)/(article's articleId)
- Parameters:
companyId
- the primary key of the web content article's company- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
removeArticleLocale
public static JournalArticle removeArticleLocale(long groupId, String articleId, double version, String languageId) throws com.liferay.portal.kernel.exception.PortalException Removes the web content of the web content article matching the group, article ID, and version, and language.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionlanguageId
- 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
- if a portal exception occurred
-
restoreArticleFromTrash
public static JournalArticle restoreArticleFromTrash(long userId, JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException Restores the web content article from the Recycle Bin.- Parameters:
userId
- the primary key of the user restoring the web content articlearticle
- the web content article- Returns:
- the restored web content article from the Recycle Bin
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
setTreePaths
public static void setTreePaths(long folderId, String treePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribe
public static void subscribe(long userId, long groupId, long articleId) throws com.liferay.portal.kernel.exception.PortalException Subscribes the user to changes in elements that belong to the web content article.- Parameters:
userId
- the primary key of the user to be subscribedgroupId
- the primary key of the folder's grouparticleId
- the primary key of the article to subscribe to- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
subscribeStructure
public static 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 groupuserId
- the primary key of the user to be subscribedddmStructureId
- the primary key of the structure to subscribe to- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
unsubscribe
public static void unsubscribe(long userId, long groupId, long articleId) throws com.liferay.portal.kernel.exception.PortalException Unsubscribes the user from changes in elements that belong to the web content article.- Parameters:
userId
- the primary key of the user to be subscribedgroupId
- the primary key of the folder's grouparticleId
- the primary key of the article to unsubscribe from- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
unsubscribeStructure
public static 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 groupuserId
- the primary key of the user to be subscribedddmStructureId
- the primary key of the structure to subscribe to- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateArticle
public static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, Map<Locale, String> friendlyURLMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, Map<String, byte[]> images, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article with additional parameters. All scheduling parameters (display date, expiration date, and review date) use the current user's timezone.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized descriptionsfriendlyURLMap
- the web content article's locales and localized friendly URLscontent
- the HTML content wrapped in XML. For more information, see the content example in theaddArticle(String, long, long, long, long, long, String, boolean, double, Map, Map, Map, String, long, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, long, int, String, File, Map, String, ServiceContext)
description.ddmTemplateKey
- the primary key of the web content article's DDM templatelayoutUuid
- the unique string identifying the web content article's display pagedisplayDateMonth
- the month the web content article is set to displaydisplayDateDay
- the calendar day the web content article is set to displaydisplayDateYear
- the year the web content article is set to displaydisplayDateHour
- the hour the web content article is set to displaydisplayDateMinute
- the minute the web content article is set to displayexpirationDateMonth
- the month the web content article is set to expireexpirationDateDay
- the calendar day the web content article is set to expireexpirationDateYear
- the year the web content article is set to expireexpirationDateHour
- the hour the web content article is set to expireexpirationDateMinute
- the minute the web content article is set to expireneverExpire
- whether the web content article is not set to auto expirereviewDateMonth
- the month the web content article is set for reviewreviewDateDay
- the calendar day the web content article is set for reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content is searchablesmallImage
- whether to update web content article's a small image. A file must be passed in assmallImageFile
value, otherwise the current small image is deleted.smallImageSource
- the web content article's small image source (optionallynull
)smallImageURL
- the web content article's small image URL (optionallynull
)smallImageFile
- the web content article's new small image file (optionallynull
). Must pass insmallImage
value oftrue
to replace the article's small image file.images
- the web content's images (optionallynull
)articleURL
- the web content article's accessible URL (optionallynull
)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 toConstants#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
- if a portal exception occurred
-
updateArticle
public static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String content, String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized descriptionscontent
- the HTML content wrapped in XML. For more information, see the content example in theaddArticle(String, long, long, long, long, long, String, boolean, double, Map, Map, Map, String, long, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, long, int, String, File, Map, String, ServiceContext)
description.layoutUuid
- the unique string identifying the web content article's display pageserviceContext
- 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 toConstants#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
- if a portal exception occurred
-
updateArticle
public static JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Updates the web content article matching the version, replacing its folder and content.- Parameters:
userId
- the primary key of the user updating the web content articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versioncontent
- the HTML content wrapped in XML. For more information, see the content example in theaddArticle(String, long, long, long, long, long, String, boolean, double, Map, Map, Map, String, long, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, long, int, String, File, Map, String, ServiceContext)
description.serviceContext
- the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, 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 toConstants#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
- if a portal exception occurred
-
updateArticle
public static JournalArticle updateArticle(long id, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Updates the URL title of the web content article.- Parameters:
id
- the primary key of the web content articleurlTitle
- the web content article's URL title- Returns:
- the updated web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateArticleDefaultValues
public static JournalArticle updateArticleDefaultValues(long userId, long groupId, String articleId, Map<Locale, String> titleMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, String content, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, long smallImageId, int smallImageSource, String smallImageURL, File smallImageFile, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateArticleTranslation
public static JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String, byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates the translation of the web content article.- Parameters:
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionlocale
- the locale of the web content article's display templatetitle
- the translated web content article titledescription
- the translated web content article descriptioncontent
- the HTML content wrapped in XML. For more information, see the content example in theaddArticle(String, long, long, long, long, long, String, boolean, double, Map, Map, Map, String, long, String, String, int, int, int, int, int, int, int, int, int, int, boolean, int, int, int, int, int, boolean, boolean, boolean, long, int, String, File, Map, String, ServiceContext)
description.images
- the web content's imagesserviceContext
- 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
- if a portal exception occurred
-
updateAsset
public static void updateAsset(long userId, JournalArticle article, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds, Double priority) throws com.liferay.portal.kernel.exception.PortalException Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary.- Parameters:
userId
- the primary key of the user updating the web content article's assetarticle
- the web content articleassetCategoryIds
- the primary keys of the new asset categoriesassetTagNames
- the new asset tag namesassetLinkEntryIds
- the primary keys of the new asset link entriespriority
- the priority of the asset- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateDDMTemplateKey
public static void updateDDMTemplateKey(long groupId, long classNameId, String oldDDMTemplateKey, String newDDMTemplateKey) Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one.- Parameters:
groupId
- the primary key of the web content article's groupclassNameId
- the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants.CLASS_NAME_ID_DEFAULT in the journal-api module otherwiseoldDDMTemplateKey
- the primary key of the web content article's old DDM templatenewDDMTemplateKey
- the primary key of the web content article's new DDM template
-
updateJournalArticle
Updates the journal article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect JournalArticleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
journalArticle
- the journal article- Returns:
- the journal article that was updated
-
updateStatus
public static JournalArticle updateStatus(long userId, JournalArticle article, int status, String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates the workflow status of the web content article.- Parameters:
userId
- the primary key of the user updating the web content article's statusarticle
- the web content articlestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.articleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the modification date, status date, and portlet preferences. With respect to social activities, by setting the service context's command toConstants#UPDATE
, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.workflowContext
- the web content article's configured workflow context- Returns:
- the updated web content article
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateStatus
public static JournalArticle updateStatus(long userId, long classPK, int status, Map<String, Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates the workflow status of the web content article matching the class PK.- Parameters:
userId
- the primary key of the user updating the web content article's statusclassPK
- the primary key of the DDM structure, if the web content article is related to a DDM structure, the primary key of the class associated with the article, or0
otherwisestatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.workflowContext
- the web content article's configured workflowserviceContext
- 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
- if a portal exception occurred
-
updateStatus
public static JournalArticle updateStatus(long userId, long groupId, String articleId, double version, int status, String articleURL, Map<String, Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates the workflow status of the web content article matching the group, article ID, and version.- Parameters:
userId
- the primary key of the user updating the web content article's statusgroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionstatus
- the web content article's workflow status. For more information seeWorkflowConstants
for constants starting with the "STATUS_" prefix.articleURL
- the web content article's accessible URLworkflowContext
- the web content article's configured workflowserviceContext
- 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
- if a portal exception occurred
-
getService
-