JournalArticleServiceUtil (Liferay 6.2-ce-ga5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.journal.service
Class JournalArticleServiceUtil

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

@ProviderType public class JournalArticleServiceUtil
extends Object
extends Object

Provides the remote service utility for JournalArticle. This utility wraps com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl and is the primary access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:: JournalArticleService, com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl

Constructor Summary
`JournalArticleServiceUtil()`

Method Summary
`static JournalArticle`	addArticle(long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String type, String ddmStructureKey, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext) Adds a web content article with additional parameters.
`static JournalArticle`	addArticle(long groupId, long folderId, long classNameId, long classPK, String articleId, boolean autoArticleId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String type, String ddmStructureKey, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, String articleURL, ServiceContext serviceContext) Adds a web content article without any images.
`static JournalArticle`	`copyArticle(long groupId, String oldArticleId, String newArticleId, boolean autoArticleId, double version)` Copies the web content article matching the group, article ID, and version.
`static void`	`deleteArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)` Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved.
`static void`	`deleteArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)` Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved.
`static JournalArticle`	`expireArticle(long groupId, String articleId, double version, String articleURL, ServiceContext serviceContext)` Expires the web content article matching the group, article ID, and version.
`static void`	`expireArticle(long groupId, String articleId, String articleURL, ServiceContext serviceContext)` Expires the web content article matching the group and article ID, expiring all of its versions if the `journal.article.expire.all.versions` portal property is `true`, otherwise expiring only its latest approved version.
`static JournalArticle`	`fetchArticle(long groupId, String articleId)`
`static JournalArticle`	`getArticle(long id)` Returns the web content article with the ID.
`static JournalArticle`	`getArticle(long groupId, String articleId)` Returns the latest approved web content article, or the latest unapproved article if none are approved.
`static JournalArticle`	`getArticle(long groupId, String articleId, double version)` Returns the web content article matching the group, article ID, and version.
`static JournalArticle`	`getArticle(long groupId, String className, long classPK)` Returns the web content article matching the group, class name, and class PK.
`static JournalArticle`	`getArticleByUrlTitle(long groupId, String urlTitle)` Returns the latest web content article that is approved, or the latest unapproved article if none are approved.
`static String`	`getArticleContent(long groupId, String articleId, double version, String languageId, ThemeDisplay themeDisplay)` Returns the web content matching the group, article ID, and version.
`static String`	`getArticleContent(long groupId, String articleId, String languageId, ThemeDisplay themeDisplay)` Returns the latest web content matching the group and article ID.
`static List<JournalArticle>`	`getArticles(long groupId, long folderId)` Returns all the web content articles matching the group and folder.
`static List<JournalArticle>`	`getArticles(long groupId, long folderId, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group and folder.
`static List<JournalArticle>`	`getArticlesByArticleId(long groupId, String articleId, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group and article ID.
`static List<JournalArticle>`	`getArticlesByLayoutUuid(long groupId, String layoutUuid)` Returns all the web content articles matching the group and layout UUID.
`static List<JournalArticle>`	`getArticlesByStructureId(long groupId, long classNameId, String ddmStructureKey, int status, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status.
`static List<JournalArticle>`	`getArticlesByStructureId(long groupId, String ddmStructureKey, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key.
`static int`	`getArticlesCount(long groupId, long folderId)` Returns the number of web content articles matching the group and folder.
`static int`	`getArticlesCount(long groupId, long folderId, int status)`
`static int`	`getArticlesCountByArticleId(long groupId, String articleId)` Returns the number of web content articles matching the group and article ID.
`static int`	`getArticlesCountByStructureId(long groupId, long classNameId, String ddmStructureKey, int status)` Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status.
`static int`	`getArticlesCountByStructureId(long groupId, String ddmStructureKey)` Returns the number of web content articles matching the group, default class name ID, and DDM structure key.
`static String`	`getBeanIdentifier()` Returns the Spring bean ID for this bean.
`static JournalArticle`	`getDisplayArticleByUrlTitle(long groupId, String urlTitle)` Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed.
`static int`	`getFoldersAndArticlesCount(long groupId, List<Long> folderIds)` Returns the number of folders containing web content articles belonging to the group.
`static List<JournalArticle>`	`getGroupArticles(long groupId, long userId, long rootFolderId, int status, boolean includeOwner, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
`static List<JournalArticle>`	`getGroupArticles(long groupId, long userId, long rootFolderId, int status, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
`static List<JournalArticle>`	`getGroupArticles(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders.
`static int`	`getGroupArticlesCount(long groupId, long userId, long rootFolderId)` Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders.
`static int`	`getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status)`
`static int`	`getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status, boolean includeOwner)` Returns the number of web content articles matching the group, user, the root folder or any of its subfolders.
`static JournalArticle`	`getLatestArticle(long resourcePrimKey)` Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status.
`static JournalArticle`	`getLatestArticle(long groupId, String articleId, int status)` Returns the latest web content article matching the group, article ID, and workflow status.
`static JournalArticle`	`getLatestArticle(long groupId, String className, long classPK)` Returns the latest web content article matching the group, class name ID, and class PK.
`static JournalArticleService`	`getService()`
`static void`	`moveArticle(long groupId, String articleId, long newFolderId)` Moves all versions of the the web content article matching the group and article ID to the folder.
`static JournalArticle`	`moveArticleFromTrash(long groupId, long resourcePrimKey, long newFolderId, ServiceContext serviceContext)` Moves the web content article from the Recycle Bin to the folder.
`static JournalArticle`	`moveArticleFromTrash(long groupId, String articleId, long newFolderId, ServiceContext serviceContext)` Moves the web content article from the Recycle Bin to the folder.
`static JournalArticle`	`moveArticleToTrash(long groupId, String articleId)` Moves the latest version of the web content article matching the group and article ID to the recycle bin.
`static void`	`removeArticleLocale(long companyId, String languageId)` Removes the web content of all the company's web content articles matching the language.
`static JournalArticle`	`removeArticleLocale(long groupId, String articleId, double version, String languageId)` Removes the web content of the web content article matching the group, article ID, and version, and language.
`static void`	`restoreArticleFromTrash(long resourcePrimKey)` Restores the web content article associated with the resource primary key from the Recycle Bin.
`static void`	`restoreArticleFromTrash(long groupId, String articleId)` Restores the web content article from the Recycle Bin.
`static Hits`	`search(long groupId, long creatorUserId, int status, int start, int end)`
`static List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.
`static List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String[] ddmStructureKeys, String[] ddmTemplateKeys, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.
`static List<JournalArticle>`	`search(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator, int start, int end, OrderByComparator obc)` Returns an ordered range of all the web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.
`static int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String keywords, Double version, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate)` Returns the number of web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter.
`static int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String[] ddmStructureKeys, String[] ddmTemplateKeys, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)` Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch.
`static int`	`searchCount(long companyId, long groupId, List<Long> folderIds, long classNameId, String articleId, Double version, String title, String description, String content, String type, String ddmStructureKey, String ddmTemplateKey, Date displayDateGT, Date displayDateLT, int status, Date reviewDate, boolean andOperator)` Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch.
`static void`	`setBeanIdentifier(String beanIdentifier)` Sets the Spring bean ID for this bean.
`void`	`setService(JournalArticleService service)` Deprecated. As of 6.2.0
`static void`	`subscribe(long groupId)` Subscribes the user to notifications for the web content article matching the group, notifying him the instant versions of the article are created, deleted, or modified.
`static void`	`unsubscribe(long groupId)` Unsubscribes the user from notifications for the web content article matching the group.
`static JournalArticle`	`updateArticle(long userId, long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String layoutUuid, ServiceContext serviceContext)` Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID.
`static JournalArticle`	updateArticle(long groupId, long folderId, String articleId, double version, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, String content, String type, String ddmStructureKey, String ddmTemplateKey, String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, String smallImageURL, File smallFile, Map<String,byte[]> images, String articleURL, ServiceContext serviceContext) Updates the web content article with additional parameters.
`static JournalArticle`	`updateArticle(long groupId, long folderId, String articleId, double version, String content, ServiceContext serviceContext)` Updates the web content article matching the version, replacing its folder and content.
`static JournalArticle`	`updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images)` Deprecated. As of 6.2.0, replaced by `updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)`
`static JournalArticle`	`updateArticleTranslation(long groupId, String articleId, double version, Locale locale, String title, String description, String content, Map<String,byte[]> images, ServiceContext serviceContext)` Updates the translation of the web content article.
`static JournalArticle`	`updateContent(long groupId, String articleId, double version, String content)` Updates the web content article matching the group, article ID, and version, replacing its content.
`static JournalArticle`	`updateStatus(long groupId, String articleId, double version, int status, String articleURL, ServiceContext serviceContext)` Updates the workflow status of the web content article matching the group, article ID, and version.

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

Constructor Detail

JournalArticleServiceUtil

public JournalArticleServiceUtil()

Method Detail

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:: the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

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

addArticle

public static JournalArticle addArticle(long groupId,
                                        long folderId,
                                        long classNameId,
                                        long classPK,
                                        String articleId,
                                        boolean autoArticleId,
                                        Map<Locale,String> titleMap,
                                        Map<Locale,String> descriptionMap,
                                        String content,
                                        String type,
                                        String ddmStructureKey,
                                        String ddmTemplateKey,
                                        String layoutUuid,
                                        int displayDateMonth,
                                        int displayDateDay,
                                        int displayDateYear,
                                        int displayDateHour,
                                        int displayDateMinute,
                                        int expirationDateMonth,
                                        int expirationDateDay,
                                        int expirationDateYear,
                                        int expirationDateHour,
                                        int expirationDateMinute,
                                        boolean neverExpire,
                                        int reviewDateMonth,
                                        int reviewDateDay,
                                        int reviewDateYear,
                                        int reviewDateHour,
                                        int reviewDateMinute,
                                        boolean neverReview,
                                        boolean indexable,
                                        boolean smallImage,
                                        String smallImageURL,
                                        File smallFile,
                                        Map<String,byte[]> images,
                                        String articleURL,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Adds a web content article with additional parameters.

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; classPK - the primary key of the DDM structure, if the primary key of the DDMStructure class is given as the classNameId parameter, the primary key of the class associated with the web content article, or 0 otherwise; articleId - the primary key of the web content article; autoArticleId - whether to auto generate the web content article ID; titleMap - the web content article's locales and localized titles; descriptionMap - the web content article's locales and localized descriptions; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; type - the structure's type, if the web content article is related to a DDM structure. For more information, see DDMStructureConstants.; ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise; ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.; layoutUuid - the unique string identifying the web content article's display page; displayDateMonth - the month the web content article is set to display; displayDateDay - the calendar day the web content article is set to display; displayDateYear - the year the web content article is set to display; displayDateHour - the hour the web content article is set to display; displayDateMinute - the minute the web content article is set to display; expirationDateMonth - the month the web content article is set to expire; expirationDateDay - the calendar day the web content article is set to expire; expirationDateYear - the year the web content article is set to expire; expirationDateHour - the hour the web content article is set to expire; expirationDateMinute - the minute the web content article is set to expire; neverExpire - whether the web content article is not set to auto expire; reviewDateMonth - the month the web content article is set for review; reviewDateDay - the calendar day the web content article is set for review; reviewDateYear - the year the web content article is set for review; reviewDateHour - the hour the web content article is set for review; reviewDateMinute - the minute the web content article is set for review; neverReview - whether the web content article is not set for review; indexable - whether the web content article is searchable; smallImage - whether the web content article has a small image; smallImageURL - the web content article's small image URL; smallFile - the web content article's small image file; images - the web content's images; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, the "urlTitle" attribute, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.
Returns:: the web content article
Throws:: PortalException - if the user did not have permission to add the web content article or if a portal exception occurred; SystemException - if a system exception occurred

addArticle

public static JournalArticle addArticle(long groupId,
                                        long folderId,
                                        long classNameId,
                                        long classPK,
                                        String articleId,
                                        boolean autoArticleId,
                                        Map<Locale,String> titleMap,
                                        Map<Locale,String> descriptionMap,
                                        String content,
                                        String type,
                                        String ddmStructureKey,
                                        String ddmTemplateKey,
                                        String layoutUuid,
                                        int displayDateMonth,
                                        int displayDateDay,
                                        int displayDateYear,
                                        int displayDateHour,
                                        int displayDateMinute,
                                        int expirationDateMonth,
                                        int expirationDateDay,
                                        int expirationDateYear,
                                        int expirationDateHour,
                                        int expirationDateMinute,
                                        boolean neverExpire,
                                        int reviewDateMonth,
                                        int reviewDateDay,
                                        int reviewDateYear,
                                        int reviewDateHour,
                                        int reviewDateMinute,
                                        boolean neverReview,
                                        boolean indexable,
                                        String articleURL,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Adds a web content article without any images.

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; classPK - the primary key of the DDM structure, if the primary key of the DDMStructure class is given as the classNameId parameter, the primary key of the class associated with the web content article, or 0 otherwise; articleId - the primary key of the web content article; autoArticleId - whether to auto generate the web content article ID; titleMap - the web content article's locales and localized titles; descriptionMap - the web content article's locales and localized descriptions; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; type - the structure's type, if the web content article is related to a DDM structure. For more information, see DDMStructureConstants.; ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise; ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.; layoutUuid - the unique string identifying the web content article's display page; displayDateMonth - the month the web content article is set to display; displayDateDay - the calendar day the web content article is set to display; displayDateYear - the year the web content article is set to display; displayDateHour - the hour the web content article is set to display; displayDateMinute - the minute the web content article is set to display; expirationDateMonth - the month the web content article is set to expire; expirationDateDay - the calendar day the web content article is set to expire; expirationDateYear - the year the web content article is set to expire; expirationDateHour - the hour the web content article is set to expire; expirationDateMinute - the minute the web content article is set to expire; neverExpire - whether the web content article is not set to auto expire; reviewDateMonth - the month the web content article is set for review; reviewDateDay - the calendar day the web content article is set for review; reviewDateYear - the year the web content article is set for review; reviewDateHour - the hour the web content article is set for review; reviewDateMinute - the minute the web content article is set for review; neverReview - whether the web content article is not set for review; indexable - whether the web content article is searchable; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the UUID, creation date, modification date, expando bridge attributes, guest permissions, group permissions, asset category IDs, asset tag names, asset link entry IDs, the "urlTitle" attribute, and workflow actions for the web content article. Can also set whether to add the default guest and group permissions.
Returns:: the web content article
Throws:: PortalException - if the user did not have permission to add the web content article or if a portal exception occurred; SystemException - if a system exception occurred

copyArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; oldArticleId - the primary key of the old web content article; newArticleId - the primary key of the new web content article; autoArticleId - whether to auto-generate the web content article ID; version - the web content article's version
Returns:: the new web content article
Throws:: PortalException - if the user did not have permission to add the copy the web content article, if a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

deleteArticle

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

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

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

deleteArticle

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

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

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

expireArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the web content article
Throws:: PortalException - if the user did not have permission to expire the web content article, if a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

expireArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the modification date, status date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Throws:: PortalException - if the user did not have permission to expire the web content article, if a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

fetchArticle

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

Throws:: PortalException; SystemException

getArticle

public static JournalArticle getArticle(long id)
                                 throws PortalException,
                                        SystemException

Returns the web content article with the ID.

Parameters:: id - the primary key of the web content article
Returns:: the web content article with the ID
Throws:: PortalException - if a matching web content article could not be found or if the user did not have permission to view the web content article; SystemException - if a system exception occurred

getArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article
Returns:: the matching web content article
Throws:: PortalException - if the user did not have permission to view the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

getArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version
Returns:: the matching web content article
Throws:: PortalException - if the user did not have permission to view the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

getArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; className - the DDMStructure class name if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; classPK - the primary key of the DDM structure, if the the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise
Returns:: the matching web content article
Throws:: PortalException - if a matching web content article could not be found or if the user did not have permission to view the web content article; SystemException - if a system exception occurred

getArticleByUrlTitle

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

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

Parameters:: groupId - the primary key of the web content article's group; urlTitle - the web content article's accessible URL title
Returns:: the matching web content article
Throws:: PortalException - if the user did not have permission to view the web content article or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; languageId - the primary key of the language translation to get; themeDisplay - the theme display
Returns:: the matching web content
Throws:: PortalException - if the user did not have permission to view the web content article, if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticleContent

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; languageId - the primary key of the language translation to get; themeDisplay - the theme display
Returns:: the matching web content
Throws:: PortalException - if the user did not have permission to view the web content article, if a matching web content article or DDM template could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getArticles

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

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

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder
Returns:: the matching web content articles
Throws:: SystemException - if a system exception occurred

getArticles

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

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

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

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the matching web content articles
Throws:: SystemException - if a system exception occurred

getArticlesByArticleId

public static List<JournalArticle> getArticlesByArticleId(long groupId,
                                                          String articleId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator obc)
                                                   throws SystemException

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: SystemException - if a system exception occurred

getArticlesByLayoutUuid

public static List<JournalArticle> getArticlesByLayoutUuid(long groupId,
                                                           String layoutUuid)
                                                    throws SystemException

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

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

getArticlesByStructureId

public static List<JournalArticle> getArticlesByStructureId(long groupId,
                                                            long classNameId,
                                                            String ddmStructureKey,
                                                            int status,
                                                            int start,
                                                            int end,
                                                            OrderByComparator obc)
                                                     throws SystemException

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

Parameters:: groupId - the primary key of the web content article's group; classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; ddmStructureKey - the primary key of the web content article's DDM structure; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: SystemException - if a system exception occurred

getArticlesByStructureId

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

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

Parameters:: groupId - the primary key of the web content article's group; ddmStructureKey - the primary key of the web content article's DDM structure; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: SystemException - if a system exception occurred

getArticlesCount

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

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

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

getArticlesCount

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

Throws:: SystemException

getArticlesCountByArticleId

public static int getArticlesCountByArticleId(long groupId,
                                              String articleId)
                                       throws SystemException

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

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

getArticlesCountByStructureId

public static int getArticlesCountByStructureId(long groupId,
                                                long classNameId,
                                                String ddmStructureKey,
                                                int status)
                                         throws SystemException

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

Parameters:: groupId - the primary key of the web content article's group; classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; ddmStructureKey - the primary key of the web content article's DDM structure; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
Returns:: the number of matching web content articles
Throws:: SystemException - if a system exception occurred

getArticlesCountByStructureId

public static int getArticlesCountByStructureId(long groupId,
                                                String ddmStructureKey)
                                         throws SystemException

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

Parameters:: groupId - the primary key of the web content article's group; ddmStructureKey - the primary key of the web content article's DDM structure
Returns:: the number of matching web content articles
Throws:: SystemException - if a system exception occurred

getDisplayArticleByUrlTitle

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

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

Parameters:: groupId - the primary key of the web content article's group; urlTitle - the web content article's accessible URL title
Returns:: the web content article matching the URL title that is currently displayed, or next one to be displayed if no version of the article is currently displayed
Throws:: PortalException - if the user did not have permission to view the web content article or if no approved matching web content articles could be found; SystemException - if a system exception occurred

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(long groupId,
                                             List<Long> folderIds)
                                      throws SystemException

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

Parameters:: groupId - the primary key of the web content article's group; folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST)
Returns:: the number of matching folders containing web content articles
Throws:: SystemException - if a system exception occurred

getGroupArticles

public static List<JournalArticle> getGroupArticles(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int status,
                                                    boolean includeOwner,
                                                    int start,
                                                    int end,
                                                    OrderByComparator orderByComparator)
                                             throws PortalException,
                                                    SystemException

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

Parameters:: groupId - the primary key of the web content article's group; userId - the primary key of the user (optionally 0); rootFolderId - the primary key of the root folder to begin the search; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); orderByComparator - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: PortalException - if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred; SystemException - if a system exception occurred

getGroupArticles

public static List<JournalArticle> getGroupArticles(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int status,
                                                    int start,
                                                    int end,
                                                    OrderByComparator orderByComparator)
                                             throws PortalException,
                                                    SystemException

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

Parameters:: groupId - the primary key of the web content article's group; userId - the primary key of the user (optionally 0); rootFolderId - the primary key of the root folder to begin the search; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); orderByComparator - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: PortalException - if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred; SystemException - if a system exception occurred

getGroupArticles

public static List<JournalArticle> getGroupArticles(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator orderByComparator)
                                             throws PortalException,
                                                    SystemException

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

Parameters:: groupId - the primary key of the web content article's group; userId - the primary key of the user (optionally 0); rootFolderId - the primary key of the root folder to begin the search; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); orderByComparator - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: PortalException - if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred; SystemException - if a system exception occurred

getGroupArticlesCount

public static int getGroupArticlesCount(long groupId,
                                        long userId,
                                        long rootFolderId)
                                 throws PortalException,
                                        SystemException

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

Parameters:: groupId - the primary key of the web content article's group; userId - the primary key of the user (optionally 0); rootFolderId - the primary key of the root folder to begin the search
Returns:: the number of matching web content articles
Throws:: PortalException - if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred; SystemException - if a system exception occurred

getGroupArticlesCount

public static int getGroupArticlesCount(long groupId,
                                        long userId,
                                        long rootFolderId,
                                        int status)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getGroupArticlesCount

public static int getGroupArticlesCount(long groupId,
                                        long userId,
                                        long rootFolderId,
                                        int status,
                                        boolean includeOwner)
                                 throws PortalException,
                                        SystemException

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

Parameters:: groupId - the primary key of the web content article's group; userId - the primary key of the user (optionally 0); rootFolderId - the primary key of the root folder to begin the search; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
Returns:: the range of matching web content articles ordered by the comparator
Throws:: PortalException - if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred; SystemException - if a system exception occurred

getLatestArticle

public static JournalArticle getLatestArticle(long resourcePrimKey)
                                       throws PortalException,
                                              SystemException

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

Parameters:: resourcePrimKey - the primary key of the resource instance
Returns:: the latest web content article matching the resource primary key, preferring articles with approved workflow status
Throws:: PortalException - if the user did not have permission to view the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

getLatestArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.
Returns:: the latest matching web content article
Throws:: PortalException - if the user did not have permission to view the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

getLatestArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; className - the DDMStructure class name if the web content article is related to a DDM structure, the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; classPK - the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise
Returns:: the latest matching web content article
Throws:: PortalException - if a matching web content article could not be found or if the user did not have permission to view the web content article; SystemException - if a system exception occurred

moveArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; newFolderId - the primary key of the web content article's new folder
Throws:: PortalException - if the user did not have permission to update any one of the versions of the web content article or if any one of the versions of the web content article could not be moved to the folder; SystemException - if a system exception occurred

moveArticleFromTrash

public static JournalArticle moveArticleFromTrash(long groupId,
                                                  long resourcePrimKey,
                                                  long newFolderId,
                                                  ServiceContext serviceContext)
                                           throws PortalException,
                                                  SystemException

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

Parameters:: groupId - the primary key of the web content article's group; resourcePrimKey - the primary key of the resource instance; newFolderId - the primary key of the web content article's new folder; serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the updated web content article, which was moved from the Recycle Bin to the folder
Throws:: PortalException - if the user did not have permission to view or update the web content article, if a matching trashed web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

moveArticleFromTrash

public static JournalArticle moveArticleFromTrash(long groupId,
                                                  String articleId,
                                                  long newFolderId,
                                                  ServiceContext serviceContext)
                                           throws PortalException,
                                                  SystemException

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; newFolderId - the primary key of the web content article's new folder; serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the updated web content article, which was moved from the Recycle Bin to the folder
Throws:: PortalException - if the user did not have permission to view or update the web content article, if a trashed web content article with the primary key could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

moveArticleToTrash

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article
Returns:: the moved web content article or null if no matching article was found
Throws:: PortalException - if the user did not have permission to move the article to the Recycle Bin or if a portal exception occurred; SystemException - if a system exception occurred

removeArticleLocale

public static void removeArticleLocale(long companyId,
                                       String languageId)
                                throws PortalException,
                                       SystemException

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

Parameters:: companyId - the primary key of the web content article's company; languageId - the primary key of the language locale to remove
Throws:: PortalException - if the user did not have permission to update any one of the the web content articles or if web content matching the language could not be found for any one of the articles; SystemException - if a system exception occurred

removeArticleLocale

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; languageId - the primary key of the language locale to remove
Returns:: the updated web content article with the locale removed
Throws:: PortalException - if the user did not have permission to update the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

restoreArticleFromTrash

public static void restoreArticleFromTrash(long resourcePrimKey)
                                    throws PortalException,
                                           SystemException

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

Parameters:: resourcePrimKey - the primary key of the resource instance
Throws:: PortalException - if a matching web content article could not be found in the Recycle Bin, if the user did not have permission to view or restore the article, or if a portal exception occurred; SystemException - if a system exception occurred

restoreArticleFromTrash

public static void restoreArticleFromTrash(long groupId,
                                           String articleId)
                                    throws PortalException,
                                           SystemException

Restores the web content article from the Recycle Bin.

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article
Throws:: PortalException - if the web content article with the primary key could not be found in the Recycle Bin, if the user did not have permission to restore the article, or if a portal exception occurred; SystemException - if a system exception occurred

search

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

Throws:: PortalException; SystemException

search

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

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

Parameters:: companyId - the primary key of the web content article's company; groupId - the primary key of the group (optionally 0); folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST); classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; keywords - the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.; version - the web content article's version (optionally null); type - the web content article's type (optionally null); ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise; ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.; displayDateGT - the date after which a matching web content article's display date must be after (optionally null); displayDateLT - the date before which a matching web content article's display date must be before (optionally null); status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; reviewDate - the web content article's scheduled review date (optionally null); start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: SystemException - if a system exception occurred

search

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

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

Parameters:: companyId - the primary key of the web content article's company; groupId - the primary key of the group (optionally 0); folderIds - the primary keys of the web content article folders (optionally Collections.EMPTY_LIST); classNameId - the primary key of the DDMStructure class if the web content article is related to a DDM structure, the primary key of the class name associated with the article, or JournalArticleConstants#CLASSNAME_ID_DEFAULT otherwise; articleId - the article ID keywords (space separated, optionally null); version - the web content article's version (optionally null); title - the title keywords (space separated, optionally null); description - the description keywords (space separated, optionally null); content - the content keywords (space separated, optionally null); type - the web content article's type (optionally null); ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise; ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.; displayDateGT - the date after which a matching web content article's display date must be after (optionally null); displayDateLT - the date before which a matching web content article's display date must be before (optionally null); status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; reviewDate - the web content article's scheduled review date (optionally null); andOperator - whether every field must match its value or keywords, or just one field must match. Company, group, folder IDs, class name ID, and status must all match their values.; start - the lower bound of the range of web content articles to return; end - the upper bound of the range of web content articles to return (not inclusive); obc - the comparator to order the web content articles
Returns:: the range of matching web content articles ordered by the comparator
Throws:: SystemException - if a system exception occurred

search

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

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

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

searchCount

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

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

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

searchCount

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

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

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

searchCount

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

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

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

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

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

Parameters:: groupId - the primary key of the group
Throws:: PortalException - if the user did not have permission to subscribe to the web content article or if a matching user or group could not be found; SystemException - if a system exception occurred

unsubscribe

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

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

Parameters:: groupId - the primary key of the group
Throws:: PortalException - if the user did not have permission to subscribe to the web content article or if a matching user or subscription could not be found; SystemException - if a system exception occurred

updateArticle

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

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

Parameters:: userId - the primary key of the user updating the web content article; groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; articleId - the primary key of the web content article; version - the web content article's version; titleMap - the web content article's locales and localized titles; descriptionMap - the web content article's locales and localized descriptions; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; layoutUuid - the unique string identifying the web content article's display page; serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the updated web content article
Throws:: PortalException - if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

updateArticle

public static JournalArticle updateArticle(long groupId,
                                           long folderId,
                                           String articleId,
                                           double version,
                                           Map<Locale,String> titleMap,
                                           Map<Locale,String> descriptionMap,
                                           String content,
                                           String type,
                                           String ddmStructureKey,
                                           String ddmTemplateKey,
                                           String layoutUuid,
                                           int displayDateMonth,
                                           int displayDateDay,
                                           int displayDateYear,
                                           int displayDateHour,
                                           int displayDateMinute,
                                           int expirationDateMonth,
                                           int expirationDateDay,
                                           int expirationDateYear,
                                           int expirationDateHour,
                                           int expirationDateMinute,
                                           boolean neverExpire,
                                           int reviewDateMonth,
                                           int reviewDateDay,
                                           int reviewDateYear,
                                           int reviewDateHour,
                                           int reviewDateMinute,
                                           boolean neverReview,
                                           boolean indexable,
                                           boolean smallImage,
                                           String smallImageURL,
                                           File smallFile,
                                           Map<String,byte[]> images,
                                           String articleURL,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Updates the web content article with additional parameters.

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; articleId - the primary key of the web content article; version - the web content article's version; titleMap - the web content article's locales and localized titles; descriptionMap - the web content article's locales and localized descriptions; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; type - the structure's type, if the web content article is related to a DDM structure. For more information, see DDMStructureConstants.; ddmStructureKey - the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise; ddmTemplateKey - the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it.; layoutUuid - the unique string identifying the web content article's display page; displayDateMonth - the month the web content article is set to display; displayDateDay - the calendar day the web content article is set to display; displayDateYear - the year the web content article is set to display; displayDateHour - the hour the web content article is set to display; displayDateMinute - the minute the web content article is set to display; expirationDateMonth - the month the web content article is set to expire; expirationDateDay - the calendar day the web content article is set to expire; expirationDateYear - the year the web content article is set to expire; expirationDateHour - the hour the web content article is set to expire; expirationDateMinute - the minute the web content article is set to expire; neverExpire - whether the web content article is not set to auto expire; reviewDateMonth - the month the web content article is set for review; reviewDateDay - the calendar day the web content article is set for review; reviewDateYear - the year the web content article is set for review; reviewDateHour - the hour the web content article is set for review; reviewDateMinute - the minute the web content article is set for review; neverReview - whether the web content article is not set for review; indexable - whether the web content is searchable; smallImage - whether to update web content article's a small image. A file must be passed in as smallImageFile value, otherwise the current small image is deleted.; smallImageURL - the web content article's small image URL (optionally null); smallFile - the web content article's new small image file (optionally null). Must pass in smallImage value of true to replace the article's small image file.; images - the web content's images (optionally null); articleURL - the web content article's accessible URL (optionally null); serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the updated web content article
Throws:: PortalException - if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

updateArticle

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

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

Parameters:: groupId - the primary key of the web content article's group; folderId - the primary key of the web content article folder; articleId - the primary key of the web content article; version - the web content article's version; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; serviceContext - the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to Constants.UPDATE, the invocation is considered a web content update activity; otherwise it is considered a web content add activity.
Returns:: the updated web content article
Throws:: PortalException - if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

updateArticleTranslation

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

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

Throws:: PortalException; SystemException

updateArticleTranslation

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

Updates the translation of the web content article.

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; locale - the locale of the web content article's display template; title - the translated web content article title; description - the translated web content article description; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.; images - the web content's images; serviceContext - the service context to be applied. Can set the modification date and "urlTitle" attribute for the web content article.
Returns:: the updated web content article
Throws:: PortalException - if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

updateContent

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

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; content - the HTML content wrapped in XML. For more information, see the content example in the class description for JournalArticleLocalServiceImpl.
Returns:: the updated web content article
Throws:: PortalException - if the user did not have permission to update the web content article or if a matching web content article could not be found; SystemException - if a system exception occurred

updateStatus

public static JournalArticle updateStatus(long groupId,
                                          String articleId,
                                          double version,
                                          int status,
                                          String articleURL,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

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

Parameters:: groupId - the primary key of the web content article's group; articleId - the primary key of the web content article; version - the web content article's version; status - the web content article's workflow status. For more information see WorkflowConstants for constants starting with the "STATUS_" prefix.; articleURL - the web content article's accessible URL; serviceContext - the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article.
Returns:: the updated web content article
Throws:: PortalException - if the user did not have permission to update the web content article, if a matching web content article could not be found, or if a portal exception occurred; SystemException - if a system exception occurred

getService

public static JournalArticleService getService()

setService

public void setService(JournalArticleService service)

Deprecated. As of 6.2.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.2-ce-ga5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.journal.service Class JournalArticleServiceUtil

JournalArticleServiceUtil

getBeanIdentifier

setBeanIdentifier

addArticle

addArticle

copyArticle

deleteArticle

deleteArticle

expireArticle

expireArticle

fetchArticle

getArticle

getArticle

getArticle

getArticle

getArticleByUrlTitle

getArticleContent

getArticleContent

getArticles

getArticles

getArticlesByArticleId

getArticlesByLayoutUuid

getArticlesByStructureId

getArticlesByStructureId

getArticlesCount

getArticlesCount

getArticlesCountByArticleId

getArticlesCountByStructureId

getArticlesCountByStructureId

getDisplayArticleByUrlTitle

getFoldersAndArticlesCount

getGroupArticles

getGroupArticles

getGroupArticles

getGroupArticlesCount

getGroupArticlesCount

getGroupArticlesCount

getLatestArticle

getLatestArticle

getLatestArticle

moveArticle

moveArticleFromTrash

moveArticleFromTrash

moveArticleToTrash

removeArticleLocale

removeArticleLocale

restoreArticleFromTrash

restoreArticleFromTrash

search

search

search

search

searchCount

searchCount

searchCount

subscribe

unsubscribe

updateArticle

updateArticle

updateArticle

updateArticleTranslation

updateArticleTranslation

updateContent

updateStatus

getService

setService

com.liferay.portlet.journal.service
Class JournalArticleServiceUtil