Class JournalArticleLocalServiceWrapper
- All Implemented Interfaces:
JournalArticleLocalService,com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<JournalArticle>,com.liferay.portal.kernel.service.PersistedModelLocalService,com.liferay.portal.kernel.service.PersistedResourcedModelLocalService,com.liferay.portal.kernel.service.ServiceWrapper<JournalArticleLocalService>
JournalArticleLocalService.- See Also:
- Generated:
-
Constructor Summary
ConstructorsConstructorDescriptionJournalArticleLocalServiceWrapper(JournalArticleLocalService journalArticleLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddArticle(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.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.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) voidaddArticleResources(long groupId, String articleId, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the most recently created web content article.voidaddArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the web content article.voidaddArticleResources(JournalArticle article, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the web content article.addJournalArticle(JournalArticle journalArticle) Adds the journal article to the database.checkArticleResourcePrimKey(long groupId, String articleId, double version) Returns the web content article with the group, article ID, and version.voidcheckArticles(long companyId) Checks all web content articles by handling their expirations and sending review notifications based on their current workflow.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.createJournalArticle(long id) Creates a new journal article with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) 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.voiddeleteArticle(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.deleteArticle(JournalArticle article) Deletes the web content article and its resources.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.voiddeleteArticleDefaultValues(long groupId, String articleId, long ddmStructureId) voiddeleteArticles(long groupId) Deletes all the group's web content articles and resources.voiddeleteArticles(long groupId, long folderId) Deletes all the group's web content articles and resources in the folder, including recycled articles.voiddeleteArticles(long groupId, long folderId, boolean includeTrashedEntries) Deletes all the group's web content articles and resources in the folder, optionally including recycled articles.voiddeleteArticles(long groupId, String className, long classPK) Deletes all the group's web content articles and resources matching the class name and class primary key.deleteJournalArticle(long id) Deletes the journal article with the primary key from the database.deleteJournalArticle(JournalArticle journalArticle) Deletes the journal article from the database.voiddeleteLayoutArticleReferences(long groupId, String layoutUuid) Deletes the layout's association with the web content articles for the group.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.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.voidexpireArticle(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.versionsportal property istrue, otherwise expiring only its latest approved version.fetchArticle(long id) Returns the web content article with the ID.fetchArticle(long groupId, String articleId) fetchArticle(long groupId, String articleId, double version) Returns the web content article matching the group, article ID, and version.fetchArticleByUrlTitle(long groupId, String urlTitle) fetchArticleByUrlTitle(long groupId, String urlTitle, double version) fetchDisplayArticle(long groupId, String articleId) fetchJournalArticle(long id) fetchJournalArticleByUuidAndGroupId(String uuid, long groupId) Returns the journal article matching the UUID and group.fetchLatestArticle(long resourcePrimKey) fetchLatestArticle(long resourcePrimKey, int status) fetchLatestArticle(long resourcePrimKey, int[] statuses) 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.fetchLatestArticle(long groupId, String articleId, int status) Returns the latest web content article matching the group, article ID, and workflow status.fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int[] statuses) fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) fetchLatestArticleByUrlTitle(long groupId, String urlTitle, int status) fetchLatestIndexableArticle(long resourcePrimKey) Returns the latest indexable web content article matching the resource primary key.com.liferay.portal.kernel.model.PersistedModelfetchPersistedModel(Serializable primaryKeyObj) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetArticle(long id) Returns the web content article with the ID.getArticle(long groupId, String articleId) Returns the latest approved web content article, or the latest unapproved article if none are approved.getArticle(long groupId, String articleId, double version) Returns the web content article matching the group, article ID, and version.getArticle(long groupId, String className, long classPK) Returns the web content article matching the group, class name, and class PK.getArticleByUrlTitle(long groupId, String urlTitle) Returns the latest web content article that is approved, or the latest unapproved article if none are approved.getArticleContent(long groupId, String articleId, double version, String 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.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.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.getArticleDescription(long articlePK, String languageId) getArticleDescription(long articlePK, Locale locale) getArticleDescriptionMap(long articlePK) 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.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.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.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.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.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.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) Returns all the web content articles present in the system.getArticles(long groupId) Returns all the web content articles belonging to the group.getArticles(long groupId, int start, int end) Returns a range of all the web content articles belonging to the group.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.getArticles(long groupId, long folderId) Returns all the web content articles matching the group and folder.getArticles(long groupId, long folderId, int start, int end) Returns a range of all the web content articles matching the group and folder.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.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.getArticles(long groupId, String articleId) Returns all the web content articles matching the group and article ID.getArticles(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) getArticlesByResourcePrimKey(long resourcePrimKey) Returns all the web content articles matching the resource primary key.getArticlesByReviewDate(long companyId, Date previousCheckDate, Date reviewDate) getArticlesBySmallImageId(long smallImageId) Returns all the web content articles matching the small image ID.getArticlesByStructureId(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) getArticlesByStructureId(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) 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) intgetArticlesCount(long groupId) Returns the number of web content articles belonging to the group.intgetArticlesCount(long groupId, long folderId) Returns the number of web content articles matching the group and folder.intgetArticlesCount(long groupId, long folderId, int status) Returns the number of web content articles matching the group, folder, and status.intgetArticlesCount(long groupId, String articleId) intgetArticlesCountByResourcePrimKey(long resourcePrimKey) getArticleTitle(long articlePK, String languageId) getArticleTitle(long articlePK, Locale locale) getArticleTitleMap(long articlePK) com.liferay.portal.kernel.service.persistence.BasePersistence<?>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.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.intgetCompanyArticlesCount(long companyId, double version, int status, int start, int end) Returns the number of web content articles matching the company, version, and workflow status.intgetCompanyArticlesCount(long companyId, int status) Returns the number of web content articles matching the company and workflow status.com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<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.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.com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getGroupIdsByUrlTitle(long companyId, String urlTitle) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetJournalArticle(long id) Returns the journal article with the primary key.getJournalArticleByUuidAndGroupId(String uuid, long groupId) Returns the journal article matching the UUID and group.getJournalArticles(int start, int end) Returns a range of all the journal articles.getJournalArticlesByUuidAndCompanyId(String uuid, long companyId) Returns all the journal articles matching the UUID and company.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.intReturns the number of journal articles.getLatestArticle(long resourcePrimKey) Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.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.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.getLatestArticle(long groupId, String articleId) Returns the latest web content article with the group and article ID.getLatestArticle(long groupId, String articleId, int status) Returns the latest web content article matching the group, article ID, and workflow status.getLatestArticle(long groupId, String className, long classPK) Returns the latest web content article matching the group, class name ID, and class PK.getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) getLatestArticleByUrlTitle(long groupId, String urlTitle, int status) Returns the latest web content article matching the group, URL title, and workflow status.doublegetLatestVersion(long groupId, String articleId) Returns the latest version number of the web content with the group and article ID.doublegetLatestVersion(long groupId, String articleId, int status) Returns the latest version number of the web content with the group, article ID, and workflow status.intgetNotInTrashArticlesCount(long groupId, long folderId) Returns the number of web content articles that are not recycled.getOldestArticle(long groupId, String articleId) Returns the oldest web content article with the group and article ID.getOldestArticle(long groupId, String articleId, int status) Returns the oldest web content article matching the group, article ID, and workflow status.Returns the OSGi service identifier.List<? extends com.liferay.portal.kernel.model.PersistedModel>getPersistedModel(long resourcePrimKey) com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getPreviousApprovedArticle(JournalArticle article) Returns the previously approved version of the web content article.getStructureArticles(long ddmStructureId) Returns the web content articles matching the DDM structure keys.getStructureArticles(long groupId, long ddmStructureId) Returns the web content articles matching the group and DDM structure key.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.intgetStructureArticlesCount(long groupId, long ddmStructureId) Returns the number of web content articles matching the group and DDM structure key.getTemplateArticles(long groupId, String ddmTemplateKey) Returns the web content articles matching the group and DDM template key.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.intgetTemplateArticlesCount(long groupId, String ddmTemplateKey) Returns the number of web content articles matching the group and DDM template key.getUniqueUrlTitle(long groupId, String articleId, String urlTitle) Returns the web content article's unique URL title.booleanhasArticle(long groupId, String articleId) Returnstrueif the specified web content article exists.booleanisLatestVersion(long groupId, String articleId, double version) Returnstrueif the web content article, specified by group and article ID, is the latest version.booleanisLatestVersion(long groupId, String articleId, double version, int status) Returnstrueif the web content article, specified by group, article ID, and workflow status, is the latest version.booleanisListable(JournalArticle article) booleanisRenderable(JournalArticle article, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) 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.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.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.moveArticleToTrash(long userId, JournalArticle article) Moves the latest version of the web content article matching the group and article ID to the recycle bin.voidrebuildTree(long companyId) Rebuilds the web content article's tree path using tree traversal.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.restoreArticleFromTrash(long userId, JournalArticle article) Restores the web content article from the Recycle Bin.voidsetTreePaths(long folderId, String treePath, boolean reindex) voidsetWrappedService(JournalArticleLocalService journalArticleLocalService) voidsubscribe(long userId, long groupId, long articleId) Subscribes the user to changes in elements that belong to the web content article.voidsubscribeStructure(long groupId, long userId, long ddmStructureId) Subscribes the user to changes in elements that belong to the web content article's DDM structure.voidunsubscribe(long userId, long groupId, long articleId) Unsubscribes the user from changes in elements that belong to the web content article.voidunsubscribeStructure(long groupId, long userId, long ddmStructureId) Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.updateArticle(long userId, long groupId, long folderId, String articleId, double version, String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder and content.updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, String content, String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.updateArticle(long 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.updateArticle(long id, String urlTitle) Updates the URL title of the web content article.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) 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.voidupdateAsset(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.voidupdateDDMTemplateKey(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.updateJournalArticle(JournalArticle journalArticle) Updates the journal article in the database or adds it if it does not yet exist.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.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.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.<R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JournalArticle>, R, E> updateUnsafeFunction)
-
Constructor Details
-
JournalArticleLocalServiceWrapper
public JournalArticleLocalServiceWrapper() -
JournalArticleLocalServiceWrapper
-
-
Method Details
-
addArticle
public 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>- Specified by:
addArticlein interfaceJournalArticleLocalService- 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 theclassNameIdparameter, the primary key of the class associated with the web content article, or0otherwisearticleId- 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, or0otherwiseddmTemplateKey- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addArticle
public 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.- Specified by:
addArticlein interfaceJournalArticleLocalService- 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, or0otherwiseddmTemplateKey- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addArticleDefaultValues
public 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) - Specified by:
addArticleDefaultValuesin interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addArticleResources
public void addArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the web content article.- Specified by:
addArticleResourcesin interfaceJournalArticleLocalService- Parameters:
article- the web content articleaddGroupPermissions- whether to add group permissionsaddGuestPermissions- whether to add guest permissions- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addArticleResources
public 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.- Specified by:
addArticleResourcesin interfaceJournalArticleLocalService- Parameters:
article- the web content article to add resources tomodelPermissions- the model permissions- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
addArticleResources
public 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.- Specified by:
addArticleResourcesin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
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.
- Specified by:
addJournalArticlein interfaceJournalArticleLocalService- Parameters:
journalArticle- the journal article- Returns:
- the journal article that was added
-
checkArticleResourcePrimKey
public 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.- Specified by:
checkArticleResourcePrimKeyin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
checkArticles
public 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.- Specified by:
checkArticlesin interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
copyArticle
public 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.- Specified by:
copyArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
createJournalArticle
Creates a new journal article with the primary key. Does not add the journal article to the database.- Specified by:
createJournalArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key for the new journal article- Returns:
- the new journal article
-
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfaceJournalArticleLocalService- Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteArticle
public JournalArticle deleteArticle(JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException Deletes the web content article and its resources.- Specified by:
deleteArticlein interfaceJournalArticleLocalService- Parameters:
article- the web content article- Returns:
- the deleted web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticle
public 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.- Specified by:
deleteArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticle
public 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.- Specified by:
deleteArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticle
public 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.- Specified by:
deleteArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticleDefaultValues
public void deleteArticleDefaultValues(long groupId, String articleId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteArticleDefaultValuesin interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteArticles
public void deleteArticles(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the group's web content articles and resources.- Specified by:
deleteArticlesin interfaceJournalArticleLocalService- Parameters:
groupId- the primary key of the web content article's group- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticles
public 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.- Specified by:
deleteArticlesin interfaceJournalArticleLocalService- Parameters:
groupId- the primary key of the web content article's groupfolderId- the primary key of the web content article folder- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticles
public 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.- Specified by:
deleteArticlesin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
deleteArticles
public 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.- Specified by:
deleteArticlesin interfaceJournalArticleLocalService- 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 theclassNameparameter, the primary key of the class associated with the web content article, or0otherwise- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
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.
- Specified by:
deleteJournalArticlein interfaceJournalArticleLocalService- Parameters:
journalArticle- the journal article- Returns:
- the journal article that was removed
-
deleteJournalArticle
public 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.
- Specified by:
deleteJournalArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key of the journal article- Returns:
- the journal article that was removed
- Throws:
PortalException- if a journal article with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
deleteLayoutArticleReferences
Deletes the layout's association with the web content articles for the group.- Specified by:
deleteLayoutArticleReferencesin interfaceJournalArticleLocalService- 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 com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfaceJournalArticleLocalService- Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfaceJournalArticleLocalService- Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfaceJournalArticleLocalService- Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQueryin interfaceJournalArticleLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfaceJournalArticleLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl.- Specified by:
dynamicQueryin interfaceJournalArticleLocalService- 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 <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl.- Specified by:
dynamicQueryin interfaceJournalArticleLocalService- 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 long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceJournalArticleLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public 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.- Specified by:
dynamicQueryCountin interfaceJournalArticleLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
expireArticle
public 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.- Specified by:
expireArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
expireArticle
public 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.versionsportal property istrue, otherwise expiring only its latest approved version.- Specified by:
expireArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
fetchArticle
Returns the web content article with the ID.- Specified by:
fetchArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key of the web content article- Returns:
- the web content article with the ID
-
fetchArticle
- Specified by:
fetchArticlein interfaceJournalArticleLocalService
-
fetchArticle
Returns the web content article matching the group, article ID, and version.- Specified by:
fetchArticlein interfaceJournalArticleLocalService- 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
nullif no web content article could be found
-
fetchArticleByUrlTitle
- Specified by:
fetchArticleByUrlTitlein interfaceJournalArticleLocalService
-
fetchArticleByUrlTitle
- Specified by:
fetchArticleByUrlTitlein interfaceJournalArticleLocalService
-
fetchDisplayArticle
- Specified by:
fetchDisplayArticlein interfaceJournalArticleLocalService
-
fetchJournalArticle
- Specified by:
fetchJournalArticlein interfaceJournalArticleLocalService
-
fetchJournalArticleByUuidAndGroupId
Returns the journal article matching the UUID and group.- Specified by:
fetchJournalArticleByUuidAndGroupIdin interfaceJournalArticleLocalService- Parameters:
uuid- the journal article's UUIDgroupId- the primary key of the group- Returns:
- the matching journal article, or
nullif a matching journal article could not be found
-
fetchLatestArticle
- Specified by:
fetchLatestArticlein interfaceJournalArticleLocalService
-
fetchLatestArticle
- Specified by:
fetchLatestArticlein interfaceJournalArticleLocalService
-
fetchLatestArticle
Returns the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status.- Specified by:
fetchLatestArticlein interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instancestatus- the web content article's workflow status. For more information seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.preferApproved- whether to prefer returning the latest matching article that has workflow statusWorkflowConstants#STATUS_APPROVEDover 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
nullif no matching web content article could be found
-
fetchLatestArticle
- Specified by:
fetchLatestArticlein interfaceJournalArticleLocalService
-
fetchLatestArticle
Returns the latest web content article matching the group, article ID, and workflow status.- Specified by:
fetchLatestArticlein interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article, or
nullif no matching web content article could be found
-
fetchLatestArticleByExternalReferenceCode
public JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) Returns the latest web content article matching the group and the external reference code.- Specified by:
fetchLatestArticleByExternalReferenceCodein interfaceJournalArticleLocalService- 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
nullif no matching web content article could be found
-
fetchLatestArticleByExternalReferenceCode
public JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) - Specified by:
fetchLatestArticleByExternalReferenceCodein interfaceJournalArticleLocalService
-
fetchLatestArticleByExternalReferenceCode
public JournalArticle fetchLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int[] statuses) - Specified by:
fetchLatestArticleByExternalReferenceCodein interfaceJournalArticleLocalService
-
fetchLatestArticleByUrlTitle
- Specified by:
fetchLatestArticleByUrlTitlein interfaceJournalArticleLocalService
-
fetchLatestIndexableArticle
Returns the latest indexable web content article matching the resource primary key.- Specified by:
fetchLatestIndexableArticlein interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instance- Returns:
- the latest indexable web content article matching the resource
primary key, or
nullif no matching web content article could be found
-
fetchPersistedModel
public com.liferay.portal.kernel.model.PersistedModel fetchPersistedModel(Serializable primaryKeyObj) - Specified by:
fetchPersistedModelin interfaceJournalArticleLocalService- Specified by:
fetchPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQueryin interfaceJournalArticleLocalService
-
getArticle
public JournalArticle getArticle(long id) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article with the ID.- Specified by:
getArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key of the web content article- Returns:
- the web content article with the ID
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticle
public JournalArticle getArticle(long groupId, String articleId) throws com.liferay.portal.kernel.exception.PortalException Returns the latest approved web content article, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and article ID.- Specified by:
getArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticle
public JournalArticle getArticle(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the group, article ID, and version.- Specified by:
getArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticle
public JournalArticle getArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the group, class name, and class PK.- Specified by:
getArticlein interfaceJournalArticleLocalService- 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 theclassNameparameter, the primary key of the class associated with the web content article, or0otherwise- Returns:
- the matching web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleByUrlTitle
public JournalArticle getArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article that is approved, or the latest unapproved article if none are approved. Both approved and unapproved articles must match the group and URL title.- Specified by:
getArticleByUrlTitlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleContent
public 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.- Specified by:
getArticleContentin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleContent
public 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.- Specified by:
getArticleContentin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleContent
public 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.- Specified by:
getArticleContentin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDescription
- Specified by:
getArticleDescriptionin interfaceJournalArticleLocalService
-
getArticleDescription
- Specified by:
getArticleDescriptionin interfaceJournalArticleLocalService
-
getArticleDescriptionMap
- Specified by:
getArticleDescriptionMapin interfaceJournalArticleLocalService
-
getArticleDisplay
public 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.- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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.- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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).- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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).- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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.- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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).- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleDisplay
public 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).- Specified by:
getArticleDisplayin interfaceJournalArticleLocalService- 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
nullif the article has expired or if article's display date/time is after the current date/time - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getArticleLocalizationLanguageIds
- Specified by:
getArticleLocalizationLanguageIdsin interfaceJournalArticleLocalService
-
getArticles
Returns all the web content articles present in the system.- Specified by:
getArticlesin interfaceJournalArticleLocalService- Returns:
- the web content articles present in the system
-
getArticles
Returns all the web content articles belonging to the group.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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.- Specified by:
getArticlesin interfaceJournalArticleLocalService- 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 List<JournalArticle> getArticles(long groupId, String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesin interfaceJournalArticleLocalService
-
getArticlesByResourcePrimKey
Returns all the web content articles matching the resource primary key.- Specified by:
getArticlesByResourcePrimKeyin interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instance- Returns:
- the web content articles matching the resource primary key
-
getArticlesByReviewDate
public List<JournalArticle> getArticlesByReviewDate(long companyId, Date previousCheckDate, Date reviewDate) - Specified by:
getArticlesByReviewDatein interfaceJournalArticleLocalService
-
getArticlesBySmallImageId
Returns all the web content articles matching the small image ID.- Specified by:
getArticlesBySmallImageIdin interfaceJournalArticleLocalService- 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 List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesByStructureIdin interfaceJournalArticleLocalService
-
getArticlesByStructureId
public List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesByStructureIdin interfaceJournalArticleLocalService
-
getArticlesByStructureId
public List<JournalArticle> getArticlesByStructureId(long groupId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesByStructureIdin interfaceJournalArticleLocalService
-
getArticlesByStructureId
public List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesByStructureIdin interfaceJournalArticleLocalService
-
getArticlesByStructureId
public List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, long ddmStructureId, Locale locale, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) - Specified by:
getArticlesByStructureIdin interfaceJournalArticleLocalService
-
getArticlesClassPKsWithDefaultDisplayPage
- Specified by:
getArticlesClassPKsWithDefaultDisplayPagein interfaceJournalArticleLocalService
-
getArticlesCount
public int getArticlesCount(long groupId) Returns the number of web content articles belonging to the group.- Specified by:
getArticlesCountin interfaceJournalArticleLocalService- 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 int getArticlesCount(long groupId, long folderId) Returns the number of web content articles matching the group and folder.- Specified by:
getArticlesCountin interfaceJournalArticleLocalService- 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 int getArticlesCount(long groupId, long folderId, int status) Returns the number of web content articles matching the group, folder, and status.- Specified by:
getArticlesCountin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the number of matching web content articles
-
getArticlesCount
- Specified by:
getArticlesCountin interfaceJournalArticleLocalService
-
getArticlesCountByResourcePrimKey
public int getArticlesCountByResourcePrimKey(long resourcePrimKey) - Specified by:
getArticlesCountByResourcePrimKeyin interfaceJournalArticleLocalService
-
getArticleTitle
- Specified by:
getArticleTitlein interfaceJournalArticleLocalService
-
getArticleTitle
- Specified by:
getArticleTitlein interfaceJournalArticleLocalService
-
getArticleTitleMap
- Specified by:
getArticleTitleMapin interfaceJournalArticleLocalService
-
getCompanyArticles
public 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getCompanyArticlesin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor 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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getCompanyArticlesin interfaceJournalArticleLocalService- Parameters:
companyId- the primary key of the web content article's companystatus- the web content article's workflow status. For more information seeWorkflowConstantsfor 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getCompanyArticlesCountin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor 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 int getCompanyArticlesCount(long companyId, int status) Returns the number of web content articles matching the company and workflow status.- Specified by:
getCompanyArticlesCountin interfaceJournalArticleLocalService- Parameters:
companyId- the primary key of the web content article's companystatus- the web content article's workflow status. For more information seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the number of matching web content articles
-
getDisplayArticle
public 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.- Specified by:
getDisplayArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getDisplayArticleByUrlTitle
public JournalArticle getDisplayArticleByUrlTitle(long groupId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.- Specified by:
getDisplayArticleByUrlTitlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getExportActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQueryin interfaceJournalArticleLocalService
-
getGroupIdsByUrlTitle
- Specified by:
getGroupIdsByUrlTitlein interfaceJournalArticleLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQueryin interfaceJournalArticleLocalService
-
getJournalArticle
public JournalArticle getJournalArticle(long id) throws com.liferay.portal.kernel.exception.PortalException Returns the journal article with the primary key.- Specified by:
getJournalArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key of the journal article- Returns:
- the journal article
- Throws:
PortalException- if a journal article with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getJournalArticleByUuidAndGroupId
public JournalArticle getJournalArticleByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the journal article matching the UUID and group.- Specified by:
getJournalArticleByUuidAndGroupIdin interfaceJournalArticleLocalService- Parameters:
uuid- the journal article's UUIDgroupId- the primary key of the group- Returns:
- the matching journal article
- Throws:
PortalException- if a matching journal article could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getJournalArticles
Returns a range of all the journal articles.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.journal.model.impl.JournalArticleModelImpl.- Specified by:
getJournalArticlesin interfaceJournalArticleLocalService- 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
Returns all the journal articles matching the UUID and company.- Specified by:
getJournalArticlesByUuidAndCompanyIdin interfaceJournalArticleLocalService- 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 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.- Specified by:
getJournalArticlesByUuidAndCompanyIdin interfaceJournalArticleLocalService- 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 int getJournalArticlesCount()Returns the number of journal articles.- Specified by:
getJournalArticlesCountin interfaceJournalArticleLocalService- Returns:
- the number of journal articles
-
getLatestArticle
public JournalArticle getLatestArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instance- Returns:
- the latest web content article matching the resource primary key, preferring articles with approved workflow status
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticle
public 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.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instancestatus- the web content article's workflow status. For more information seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the latest web content article matching the resource primary key and workflow status, preferring articles with approved workflow status
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticle
public 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.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- Parameters:
resourcePrimKey- the primary key of the resource instancestatus- the web content article's workflow status. For more information seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.preferApproved- whether to prefer returning the latest matching article that has workflow statusWorkflowConstants#STATUS_APPROVEDover returning one that has a different status- Returns:
- the latest web content article matching the resource primary key and workflow status, optionally preferring articles with approved workflow status
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticle
public 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.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticle
public JournalArticle getLatestArticle(long groupId, String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group, article ID, and workflow status.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticle
public JournalArticle getLatestArticle(long groupId, String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group, class name ID, and class PK.- Specified by:
getLatestArticlein interfaceJournalArticleLocalService- 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 theclassNameparameter, the primary key of the class associated with the web content article, or0otherwise- Returns:
- the latest matching web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticleByExternalReferenceCode
public JournalArticle getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException Returns the latest web content article matching the group and the external reference code.- Specified by:
getLatestArticleByExternalReferenceCodein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestArticleByExternalReferenceCode
public JournalArticle getLatestArticleByExternalReferenceCode(long groupId, String externalReferenceCode, int status, boolean preferApproved) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestArticleByExternalReferenceCodein interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestArticleByUrlTitle
public 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.- Specified by:
getLatestArticleByUrlTitlein interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the latest matching web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestVersion
public 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.- Specified by:
getLatestVersionin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getLatestVersion
public 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.- Specified by:
getLatestVersionin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the latest version number of the matching web content
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getNoAssetArticles
- Specified by:
getNoAssetArticlesin interfaceJournalArticleLocalService
-
getNoPermissionArticles
- Specified by:
getNoPermissionArticlesin interfaceJournalArticleLocalService
-
getNotInTrashArticlesCount
public int getNotInTrashArticlesCount(long groupId, long folderId) Returns the number of web content articles that are not recycled.- Specified by:
getNotInTrashArticlesCountin interfaceJournalArticleLocalService- 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 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.- Specified by:
getOldestArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getOldestArticle
public 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.- Specified by:
getOldestArticlein interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
- the oldest matching web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceJournalArticleLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
public List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfaceJournalArticleLocalService- Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedResourcedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfaceJournalArticleLocalService- Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.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.- Specified by:
getPreviousApprovedArticlein interfaceJournalArticleLocalService- 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.- Specified by:
getStructureArticlesin interfaceJournalArticleLocalService- 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.- Specified by:
getStructureArticlesin interfaceJournalArticleLocalService- 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getStructureArticlesin interfaceJournalArticleLocalService- 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 int getStructureArticlesCount(long groupId, long ddmStructureId) Returns the number of web content articles matching the group and DDM structure key.- Specified by:
getStructureArticlesCountin interfaceJournalArticleLocalService- 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.- Specified by:
getTemplateArticlesin interfaceJournalArticleLocalService- 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
getTemplateArticlesin interfaceJournalArticleLocalService- 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.- Specified by:
getTemplateArticlesCountin interfaceJournalArticleLocalService- 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 String getUniqueUrlTitle(long groupId, String articleId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Returns the web content article's unique URL title.- Specified by:
getUniqueUrlTitlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
hasArticle
Returnstrueif the specified web content article exists.- Specified by:
hasArticlein interfaceJournalArticleLocalService- Parameters:
groupId- the primary key of the grouparticleId- the primary key of the web content article- Returns:
trueif the specified web content article exists;falseotherwise
-
isLatestVersion
public boolean isLatestVersion(long groupId, String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException Returnstrueif the web content article, specified by group and article ID, is the latest version.- Specified by:
isLatestVersionin interfaceJournalArticleLocalService- 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:
trueif the specified web content article is the latest version;falseotherwise- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
isLatestVersion
public boolean isLatestVersion(long groupId, String articleId, double version, int status) throws com.liferay.portal.kernel.exception.PortalException Returnstrueif the web content article, specified by group, article ID, and workflow status, is the latest version.- Specified by:
isLatestVersionin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor constants starting with the "STATUS_" prefix.- Returns:
trueif the specified web content article is the latest version;falseotherwise- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
isListable
- Specified by:
isListablein interfaceJournalArticleLocalService
-
isRenderable
public boolean isRenderable(JournalArticle article, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) - Specified by:
isRenderablein interfaceJournalArticleLocalService
-
moveArticle
public 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.- Specified by:
moveArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
moveArticleFromTrash
public 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.- Specified by:
moveArticleFromTrashin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
moveArticleToTrash
public 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.- Specified by:
moveArticleToTrashin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
moveArticleToTrash
public 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.- Specified by:
moveArticleToTrashin interfaceJournalArticleLocalService- 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
nullif no matching article was found - Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
rebuildTree
public 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)- Specified by:
rebuildTreein interfaceJournalArticleLocalService- Parameters:
companyId- the primary key of the web content article's company- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
removeArticleLocale
public JournalArticle removeArticleLocale(long groupId, String articleId, double version, String languageId) throws com.liferay.portal.kernel.exception.PortalException Removes the web content of the web content article matching the group, article ID, and version, and language.- Specified by:
removeArticleLocalein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
restoreArticleFromTrash
public JournalArticle restoreArticleFromTrash(long userId, JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException Restores the web content article from the Recycle Bin.- Specified by:
restoreArticleFromTrashin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
setTreePaths
public void setTreePaths(long folderId, String treePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
setTreePathsin interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribe
public 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.- Specified by:
subscribein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
subscribeStructure
public void subscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException Subscribes the user to changes in elements that belong to the web content article's DDM structure.- Specified by:
subscribeStructurein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
unsubscribe
public 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.- Specified by:
unsubscribein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
unsubscribeStructure
public void unsubscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException Unsubscribes the user from changes in elements that belong to the web content article's DDM structure.- Specified by:
unsubscribeStructurein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateArticle
public JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, 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.- Specified by:
updateArticlein interfaceJournalArticleLocalService- 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 assmallImageFilevalue, 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 insmallImagevalue oftrueto 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateArticle
public JournalArticle updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale, String> titleMap, Map<Locale, 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.- Specified by:
updateArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateArticle
public 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.- Specified by:
updateArticlein interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateArticle
public JournalArticle updateArticle(long id, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException Updates the URL title of the web content article.- Specified by:
updateArticlein interfaceJournalArticleLocalService- Parameters:
id- the primary key of the web content articleurlTitle- the web content article's URL title- Returns:
- the updated web content article
- Throws:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateArticleDefaultValues
public 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) - Specified by:
updateArticleDefaultValuesin interfaceJournalArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateArticleTranslation
public JournalArticle updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String, byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalExceptionUpdates the translation of the web content article.- Specified by:
updateArticleTranslationin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateAsset
public 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.- Specified by:
updateAssetin interfaceJournalArticleLocalService- 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateDDMTemplateKey
public 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.- Specified by:
updateDDMTemplateKeyin interfaceJournalArticleLocalService- 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.
- Specified by:
updateJournalArticlein interfaceJournalArticleLocalService- Parameters:
journalArticle- the journal article- Returns:
- the journal article that was updated
-
updateStatus
public 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.- Specified by:
updateStatusin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateStatus
public 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.- Specified by:
updateStatusin interfaceJournalArticleLocalService- 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, or0otherwisestatus- the web content article's workflow status. For more information seeWorkflowConstantsfor 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
updateStatus
public 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.- Specified by:
updateStatusin interfaceJournalArticleLocalService- 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 seeWorkflowConstantsfor 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:
PortalException- if a portal exception occurredcom.liferay.portal.kernel.exception.PortalException
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistencein interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getCTPersistence
public com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JournalArticle> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<JournalArticle>- Specified by:
getCTPersistencein interfaceJournalArticleLocalService
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<JournalArticle>- Specified by:
getModelClassin interfaceJournalArticleLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<JournalArticle>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<JournalArticle>- Specified by:
updateWithUnsafeFunctionin interfaceJournalArticleLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<JournalArticleLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<JournalArticleLocalService>
-