@ProviderType
public class JournalArticleLocalServiceUtil
extends java.lang.Object
JournalArticleLocalServiceImpl
and is the
primary access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.JournalArticleLocalService
,
JournalArticleLocalServiceBaseImpl
,
JournalArticleLocalServiceImpl
Constructor and Description |
---|
JournalArticleLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static JournalArticle |
addArticle(long userId,
long groupId,
long folderId,
long classNameId,
long classPK,
java.lang.String articleId,
boolean autoArticleId,
double version,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
java.lang.String smallImageURL,
java.io.File smallImageFile,
java.util.Map<java.lang.String,byte[]> images,
java.lang.String articleURL,
boolean validateReferences,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of 3.24.0
|
static JournalArticle |
addArticle(long userId,
long groupId,
long folderId,
long classNameId,
long classPK,
java.lang.String articleId,
boolean autoArticleId,
double version,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
java.lang.String smallImageURL,
java.io.File smallImageFile,
java.util.Map<java.lang.String,byte[]> images,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a web content article with additional parameters.
|
static JournalArticle |
addArticle(long userId,
long groupId,
long folderId,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Adds a web content article.
|
static void |
addArticleResources(JournalArticle article,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the web content article.
|
static void |
addArticleResources(JournalArticle article,
java.lang.String[] groupPermissions,
java.lang.String[] guestPermissions)
Adds the model resources with the permissions to the web content article.
|
static void |
addArticleResources(long groupId,
java.lang.String articleId,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the most recently created web content article.
|
static void |
addArticleResources(long groupId,
java.lang.String articleId,
java.lang.String[] groupPermissions,
java.lang.String[] guestPermissions)
Adds the resources with the permissions to the most recently created web
content article.
|
static JournalArticle |
addJournalArticle(JournalArticle journalArticle)
Adds the journal article to the database.
|
static JournalArticle |
checkArticleResourcePrimKey(long groupId,
java.lang.String articleId,
double version)
Returns the web content article with the group, article ID, and version.
|
static void |
checkArticles()
Checks all web content articles by handling their expirations and sending
review notifications based on their current workflow.
|
static void |
checkNewLine(long groupId,
java.lang.String articleId,
double version)
Checks the web content article matching the group, article ID, and
version, replacing escaped newline and return characters with non-escaped
newline and return characters.
|
static void |
checkStructure(long groupId,
java.lang.String articleId,
double version)
Checks the web content article matching the group, article ID, and
version for an associated structure.
|
static JournalArticle |
copyArticle(long userId,
long groupId,
java.lang.String oldArticleId,
java.lang.String newArticleId,
boolean autoArticleId,
double version)
Copies the web content article matching the group, article ID, and
version.
|
static JournalArticle |
createJournalArticle(long id)
Creates a new journal article with the primary key.
|
static JournalArticle |
deleteArticle(JournalArticle article)
Deletes the web content article and its resources.
|
static JournalArticle |
deleteArticle(JournalArticle article,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the web content article and its resources, optionally sending
email notifying denial of the article if it had not yet been approved.
|
static JournalArticle |
deleteArticle(long groupId,
java.lang.String articleId,
double version,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes the web content article and its resources matching the group,
article ID, and version, optionally sending email notifying denial of the
web content article if it had not yet been approved.
|
static void |
deleteArticle(long groupId,
java.lang.String articleId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deletes all web content articles and their resources matching the group
and article ID, optionally sending email notifying denial of article if
it had not yet been approved.
|
static void |
deleteArticles(long groupId)
Deletes all the group's web content articles and resources.
|
static void |
deleteArticles(long groupId,
long folderId)
Deletes all the group's web content articles and resources in the folder,
including recycled articles.
|
static void |
deleteArticles(long groupId,
long folderId,
boolean includeTrashedEntries)
Deletes all the group's web content articles and resources in the folder,
optionally including recycled articles.
|
static void |
deleteArticles(long groupId,
java.lang.String className,
long classPK)
Deletes all the group's web content articles and resources matching the
class name and class primary key.
|
static JournalArticle |
deleteJournalArticle(JournalArticle journalArticle)
Deletes the journal article from the database.
|
static JournalArticle |
deleteJournalArticle(long id)
Deletes the journal article with the primary key from the database.
|
static void |
deleteLayoutArticleReferences(long groupId,
java.lang.String layoutUuid)
Deletes the layout's association with the web content articles for the
group.
|
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static JournalArticle |
expireArticle(long userId,
long groupId,
java.lang.String articleId,
double version,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Expires the web content article matching the group, article ID, and
version.
|
static void |
expireArticle(long userId,
long groupId,
java.lang.String articleId,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Expires the web content article matching the group and article ID,
expiring all of its versions if the
journal.article.expire.all.versions portal property is
true , otherwise expiring only its latest approved version. |
static JournalArticle |
fetchArticle(long groupId,
java.lang.String articleId) |
static JournalArticle |
fetchArticle(long groupId,
java.lang.String articleId,
double version)
Returns the web content article matching the group, article ID, and
version.
|
static JournalArticle |
fetchArticleByUrlTitle(long groupId,
java.lang.String urlTitle) |
static JournalArticle |
fetchDisplayArticle(long groupId,
java.lang.String articleId) |
static JournalArticle |
fetchJournalArticle(long id) |
static JournalArticle |
fetchJournalArticleByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the journal article matching the UUID and group.
|
static JournalArticle |
fetchLatestArticle(long resourcePrimKey) |
static JournalArticle |
fetchLatestArticle(long resourcePrimKey,
int status) |
static JournalArticle |
fetchLatestArticle(long resourcePrimKey,
int[] statuses) |
static JournalArticle |
fetchLatestArticle(long resourcePrimKey,
int status,
boolean preferApproved)
Returns the latest web content article matching the resource primary key
and workflow status, optionally preferring articles with approved
workflow status.
|
static JournalArticle |
fetchLatestArticle(long groupId,
java.lang.String articleId,
int status)
Returns the latest web content article matching the group, article ID,
and workflow status.
|
static JournalArticle |
fetchLatestArticleByUrlTitle(long groupId,
java.lang.String urlTitle,
int status) |
static JournalArticle |
fetchLatestIndexableArticle(long resourcePrimKey)
Returns the latest indexable web content article matching the resource
primary key.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static JournalArticle |
getArticle(long id)
Returns the web content article with the ID.
|
static JournalArticle |
getArticle(long groupId,
java.lang.String articleId)
Returns the latest approved web content article, or the latest unapproved
article if none are approved.
|
static JournalArticle |
getArticle(long groupId,
java.lang.String articleId,
double version)
Returns the web content article matching the group, article ID, and
version.
|
static JournalArticle |
getArticle(long groupId,
java.lang.String className,
long classPK)
Returns the web content article matching the group, class name, and class
PK.
|
static JournalArticle |
getArticleByUrlTitle(long groupId,
java.lang.String urlTitle)
Returns the latest web content article that is approved, or the latest
unapproved article if none are approved.
|
static java.lang.String |
getArticleContent(JournalArticle article,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns the web content from the web content article associated with the
portlet request model and the DDM template.
|
static java.lang.String |
getArticleContent(JournalArticle article,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Deprecated.
As of 3.3.0, replaced by
getArticleContent(JournalArticle, String, String, String,
PortletRequestModel,ThemeDisplay) |
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
double version,
java.lang.String viewMode,
java.lang.String ddmTemplateKey,
java.lang.String languageId,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns the web content from the web content article matching the group,
article ID, and version, and associated with the portlet request model
and the DDM template.
|
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
double version,
java.lang.String viewMode,
java.lang.String ddmTemplateKey,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Deprecated.
As of 3.3.0, replaced by
getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay) |
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
double version,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Deprecated.
As of 3.3.0, replaced by
getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay) |
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
java.lang.String viewMode,
java.lang.String ddmTemplateKey,
java.lang.String languageId,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns the latest web content from the web content article matching the
group and article ID, and associated with the portlet request model and
the DDM template.
|
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
java.lang.String viewMode,
java.lang.String ddmTemplateKey,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Deprecated.
As of 3.3.0, replaced by
getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay) |
static java.lang.String |
getArticleContent(long groupId,
java.lang.String articleId,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Deprecated.
As of 3.3.0, replaced by
getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay) |
static JournalArticleDisplay |
getArticleDisplay(JournalArticle article,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
int page,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the specified page of the
latest version of the web content article, based on the DDM template.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
double version,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
int page,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the specified page of the
specified version of the web content article matching the group, article
ID, and DDM template.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
double version,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the first page of the specified
version of the web content article matching the group, article ID, and
DDM template.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
java.lang.String viewMode,
java.lang.String languageId,
int page,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the specified page of the
latest version of the web content article matching the group and article
ID.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
int page,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the specified page of the
latest version of the web content article matching the group, article ID,
and DDM template.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
java.lang.String ddmTemplateKey,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the first page of the latest
version of the web content article matching the group, article ID, and
DDM template.
|
static JournalArticleDisplay |
getArticleDisplay(long groupId,
java.lang.String articleId,
java.lang.String viewMode,
java.lang.String languageId,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
Returns a web content article display for the first page of the latest
version of the web content article matching the group and article ID.
|
static java.util.List<JournalArticle> |
getArticles()
Returns all the web content articles present in the system.
|
static java.util.List<JournalArticle> |
getArticles(long groupId)
Returns all the web content articles belonging to the group.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
int start,
int end)
Returns a range of all the web content articles belonging to the group.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles belonging to the
group.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
long folderId)
Returns all the web content articles matching the group and folder.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
long folderId,
int start,
int end)
Returns a range of all the web content articles matching the group and
folder.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
long folderId,
int status,
int start,
int end)
Returns a range of all the web content articles matching the group,
folder, and status.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
long folderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
Returns an ordered range of all the web content articles matching the
group and folder.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
java.lang.String articleId)
Returns all the web content articles matching the group and article ID.
|
static java.util.List<JournalArticle> |
getArticles(long groupId,
java.lang.String articleId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator) |
static java.util.List<JournalArticle> |
getArticlesByResourcePrimKey(long resourcePrimKey)
Returns all the web content articles matching the resource primary key.
|
static java.util.List<JournalArticle> |
getArticlesBySmallImageId(long smallImageId)
Returns all the web content articles matching the small image ID.
|
static java.util.List<JournalArticle> |
getArticlesByStructureId(long groupId,
long classNameId,
java.lang.String ddmStructureKey,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) |
static java.util.List<JournalArticle> |
getArticlesByStructureId(long groupId,
java.lang.String ddmStructureKey,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) |
static java.util.List<JournalArticle> |
getArticlesByStructureId(long groupId,
java.lang.String ddmStructureKey,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc) |
static int |
getArticlesCount(long groupId)
Returns the number of web content articles belonging to the group.
|
static int |
getArticlesCount(long groupId,
long folderId)
Returns the number of web content articles matching the group and folder.
|
static int |
getArticlesCount(long groupId,
long folderId,
int status)
Returns the number of web content articles matching the group, folder,
and status.
|
static int |
getArticlesCount(long groupId,
java.lang.String articleId) |
static java.util.List<JournalArticle> |
getCompanyArticles(long companyId,
double version,
int status,
int start,
int end)
Returns an ordered range of all the web content articles matching the
company, version, and workflow status.
|
static java.util.List<JournalArticle> |
getCompanyArticles(long companyId,
int status,
int start,
int end)
Returns an ordered range of all the web content articles matching the
company and workflow status.
|
static int |
getCompanyArticlesCount(long companyId,
double version,
int status,
int start,
int end)
Returns the number of web content articles matching the company, version,
and workflow status.
|
static int |
getCompanyArticlesCount(long companyId,
int status)
Returns the number of web content articles matching the company and
workflow status.
|
static JournalArticle |
getDisplayArticle(long groupId,
java.lang.String articleId)
Returns the matching web content article currently displayed or next to
be displayed if no article is currently displayed.
|
static JournalArticle |
getDisplayArticleByUrlTitle(long groupId,
java.lang.String urlTitle)
Returns the web content article matching the URL title that is currently
displayed or next to be displayed if no article is currently displayed.
|
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.util.List<JournalArticle> |
getIndexableArticlesByDDMStructureKey(java.lang.String[] ddmStructureKeys) |
static java.util.List<JournalArticle> |
getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
Returns the indexable web content articles matching the resource primary
key.
|
static JournalArticle |
getJournalArticle(long id)
Returns the journal article with the primary key.
|
static JournalArticle |
getJournalArticleByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the journal article matching the UUID and group.
|
static java.util.List<JournalArticle> |
getJournalArticles(int start,
int end)
Returns a range of all the journal articles.
|
static java.util.List<JournalArticle> |
getJournalArticlesByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns all the journal articles matching the UUID and company.
|
static java.util.List<JournalArticle> |
getJournalArticlesByUuidAndCompanyId(java.lang.String uuid,
long companyId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
Returns a range of journal articles matching the UUID and company.
|
static int |
getJournalArticlesCount()
Returns the number of journal articles.
|
static JournalArticle |
getLatestArticle(long resourcePrimKey)
Returns the latest web content article matching the resource primary key,
preferring articles with approved workflow status.
|
static JournalArticle |
getLatestArticle(long resourcePrimKey,
int status)
Returns the latest web content article matching the resource primary key
and workflow status, preferring articles with approved workflow status.
|
static JournalArticle |
getLatestArticle(long resourcePrimKey,
int status,
boolean preferApproved)
Returns the latest web content article matching the resource primary key
and workflow status, optionally preferring articles with approved
workflow status.
|
static JournalArticle |
getLatestArticle(long groupId,
java.lang.String articleId)
Returns the latest web content article with the group and article ID.
|
static JournalArticle |
getLatestArticle(long groupId,
java.lang.String articleId,
int status)
Returns the latest web content article matching the group, article ID,
and workflow status.
|
static JournalArticle |
getLatestArticle(long groupId,
java.lang.String className,
long classPK)
Returns the latest web content article matching the group, class name ID,
and class PK.
|
static JournalArticle |
getLatestArticleByUrlTitle(long groupId,
java.lang.String urlTitle,
int status)
Returns the latest web content article matching the group, URL title, and
workflow status.
|
static double |
getLatestVersion(long groupId,
java.lang.String articleId)
Returns the latest version number of the web content with the group and
article ID.
|
static double |
getLatestVersion(long groupId,
java.lang.String articleId,
int status)
Returns the latest version number of the web content with the group,
article ID, and workflow status.
|
static java.util.List<JournalArticle> |
getNoAssetArticles() |
static java.util.List<JournalArticle> |
getNoPermissionArticles() |
static int |
getNotInTrashArticlesCount(long groupId,
long folderId)
Returns the number of web content articles that are not recycled.
|
static JournalArticle |
getOldestArticle(long groupId,
java.lang.String articleId)
Returns the oldest web content article with the group and article ID.
|
static JournalArticle |
getOldestArticle(long groupId,
java.lang.String articleId,
int status)
Returns the oldest web content article matching the group, article ID,
and workflow status.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static java.util.List<? extends com.liferay.portal.kernel.model.PersistedModel> |
getPersistedModel(long resourcePrimKey) |
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static JournalArticle |
getPreviousApprovedArticle(JournalArticle article)
Returns the previously approved version of the web content article.
|
static JournalArticleLocalService |
getService() |
static java.util.List<JournalArticle> |
getStructureArticles(long groupId,
java.lang.String ddmStructureKey)
Returns the web content articles matching the group and DDM structure
key.
|
static java.util.List<JournalArticle> |
getStructureArticles(long groupId,
java.lang.String ddmStructureKey,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the
group and DDM structure key.
|
static java.util.List<JournalArticle> |
getStructureArticles(java.lang.String[] ddmStructureKeys)
Returns the web content articles matching the DDM structure keys.
|
static int |
getStructureArticlesCount(long groupId,
java.lang.String ddmStructureKey)
Returns the number of web content articles matching the group and DDM
structure key.
|
static java.util.List<JournalArticle> |
getTemplateArticles(long groupId,
java.lang.String ddmTemplateKey)
Returns the web content articles matching the group and DDM template key.
|
static java.util.List<JournalArticle> |
getTemplateArticles(long groupId,
java.lang.String ddmTemplateKey,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the
group and DDM template key.
|
static int |
getTemplateArticlesCount(long groupId,
java.lang.String ddmTemplateKey)
Returns the number of web content articles matching the group and DDM
template key.
|
static java.lang.String |
getUniqueUrlTitle(long groupId,
java.lang.String articleId,
java.lang.String urlTitle)
Returns the web content article's unique URL title.
|
static boolean |
hasArticle(long groupId,
java.lang.String articleId)
Returns
true if the specified web content article exists. |
static boolean |
isLatestVersion(long groupId,
java.lang.String articleId,
double version)
Returns
true if the web content article, specified by group
and article ID, is the latest version. |
static boolean |
isLatestVersion(long groupId,
java.lang.String articleId,
double version,
int status)
Returns
true if the web content article, specified by group,
article ID, and workflow status, is the latest version. |
static boolean |
isListable(JournalArticle article) |
static boolean |
isRenderable(JournalArticle article,
com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel,
com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) |
static JournalArticle |
moveArticle(long groupId,
java.lang.String articleId,
long newFolderId)
Deprecated.
As of 3.3.0, replaced by
moveArticle(long, String,
long, ServiceContext) |
static JournalArticle |
moveArticle(long groupId,
java.lang.String articleId,
long newFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Moves the web content article matching the group and article ID to a new
folder.
|
static JournalArticle |
moveArticleFromTrash(long userId,
long groupId,
JournalArticle article,
long newFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Moves the web content article from the Recycle Bin to a new folder.
|
static JournalArticle |
moveArticleToTrash(long userId,
JournalArticle article)
Moves the latest version of the web content article matching the group
and article ID to the recycle bin.
|
static JournalArticle |
moveArticleToTrash(long userId,
long groupId,
java.lang.String articleId)
Moves the latest version of the web content article matching the group
and article ID to the recycle bin.
|
static void |
rebuildTree(long companyId)
Rebuilds the web content article's tree path using tree traversal.
|
static JournalArticle |
removeArticleLocale(long groupId,
java.lang.String articleId,
double version,
java.lang.String languageId)
Removes the web content of the web content article matching the group,
article ID, and version, and language.
|
static JournalArticle |
restoreArticleFromTrash(long userId,
JournalArticle article)
Restores the web content article from the Recycle Bin.
|
static java.util.List<JournalArticle> |
search(long groupId,
java.util.List<java.lang.Long> folderIds,
int status,
int start,
int end)
Returns a range of all the web content articles matching the parameters
without using the indexer.
|
static java.util.List<JournalArticle> |
search(long groupId,
long folderId,
int status,
int start,
int end)
Returns a range of all the web content articles in a single folder
matching the parameters without using the indexer.
|
static java.util.List<JournalArticle> |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String keywords,
java.lang.Double version,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the
parameters without using the indexer, including a keywords parameter for
matching with the article's ID, title, description, and content, a DDM
structure key parameter, and a DDM template key parameter.
|
static java.util.List<JournalArticle> |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.Double version,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.lang.String[] ddmStructureKeys,
java.lang.String[] ddmTemplateKeys,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate,
boolean andOperator,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the
parameters without using the indexer, including keyword parameters for
article ID, title, description, and content, a DDM structure keys
(plural) parameter, a DDM template keys (plural) parameter, and an AND
operator switch.
|
static java.util.List<JournalArticle> |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.Double version,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate,
boolean andOperator,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the
parameters without using the indexer, including keyword parameters for
article ID, title, description, and content, a DDM structure key
parameter, a DDM template key parameter, and an AND operator switch.
|
static com.liferay.portal.kernel.search.Hits |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String keywords,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
com.liferay.portal.kernel.search.Sort sort)
Returns an ordered range of all the web content articles matching the
parameters using the indexer, including a keywords parameter for matching
an article's ID, title, description, or content, a DDM structure key
parameter, a DDM template key parameter, and a finder hash map parameter.
|
static com.liferay.portal.kernel.search.Hits |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.String title,
java.lang.String description,
java.lang.String content,
int status,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andSearch,
int start,
int end,
com.liferay.portal.kernel.search.Sort sort)
Returns an ordered range of all the web content articles matching the
parameters using the indexer, including a keywords parameter for matching
an article's ID, title, description, or content, a DDM structure key
parameter, a DDM template key parameter, an AND operator switch, and
parameters for type, status, a finder hash map.
|
static com.liferay.portal.kernel.search.Hits |
search(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.lang.String type,
java.lang.String statusString,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andSearch,
int start,
int end,
com.liferay.portal.kernel.search.Sort sort)
Deprecated.
|
static com.liferay.portal.kernel.search.Hits |
search(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end)
Returns a range of all the web content articles matching the group,
creator, and status using the indexer.
|
static int |
searchCount(long groupId,
java.util.List<java.lang.Long> folderIds,
int status)
Returns the number of web content articles matching the group, folders,
and status.
|
static int |
searchCount(long groupId,
long folderId,
int status)
Returns the number of web content articles matching the group, folder,
and status.
|
static int |
searchCount(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String keywords,
java.lang.Double version,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate)
Returns the number of web content articles matching the parameters,
including a keywords parameter for matching with the article's ID, title,
description, and content, a DDM structure key parameter, and a DDM
template key parameter.
|
static int |
searchCount(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.Double version,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.lang.String[] ddmStructureKeys,
java.lang.String[] ddmTemplateKeys,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate,
boolean andOperator)
Returns the number of web content articles matching the parameters,
including keyword parameters for article ID, title, description, and
content, a DDM structure keys (plural) parameter, a DDM template keys
(plural) parameter, and an AND operator switch.
|
static int |
searchCount(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.Double version,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.Date displayDateGT,
java.util.Date displayDateLT,
int status,
java.util.Date reviewDate,
boolean andOperator)
Returns the number of web content articles matching the parameters,
including keyword parameters for article ID, title, description, and
content, a DDM structure key parameter, a DDM template key parameter, and
an AND operator switch.
|
static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> |
searchJournalArticles(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String keywords,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
com.liferay.portal.kernel.search.Sort sort)
Returns a
BaseModelSearchResult containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including a keywords parameter for matching
an article's ID, title, description, or content, a DDM structure key
parameter, a DDM template key parameter, and a finder hash map parameter. |
static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> |
searchJournalArticles(long companyId,
long groupId,
java.util.List<java.lang.Long> folderIds,
long classNameId,
java.lang.String articleId,
java.lang.String title,
java.lang.String description,
java.lang.String content,
int status,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andSearch,
int start,
int end,
com.liferay.portal.kernel.search.Sort sort)
Returns a
BaseModelSearchResult containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including keyword parameters for article
ID, title, description, or content, a DDM structure key parameter, a DDM
template key parameter, an AND operator switch, and parameters for type,
status, and a finder hash map. |
static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> |
searchJournalArticles(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end)
Returns a
BaseModelSearchResult containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including the web content article's creator
ID and status. |
static void |
setTreePaths(long folderId,
java.lang.String treePath,
boolean reindex) |
static void |
subscribeStructure(long groupId,
long userId,
long ddmStructureId)
Subscribes the user to changes in elements that belong to the web content
article's DDM structure.
|
static void |
unsubscribeStructure(long groupId,
long userId,
long ddmStructureId)
Unsubscribes the user from changes in elements that belong to the web
content article's DDM structure.
|
static JournalArticle |
updateArticle(long userId,
long groupId,
long folderId,
java.lang.String articleId,
double version,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String layoutUuid,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the web content article matching the version, replacing its
folder, title, description, content, and layout UUID.
|
static JournalArticle |
updateArticle(long userId,
long groupId,
long folderId,
java.lang.String articleId,
double version,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
java.lang.String smallImageURL,
java.io.File smallImageFile,
java.util.Map<java.lang.String,byte[]> images,
java.lang.String articleURL,
boolean validateReferences,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Deprecated.
As of 3.24.0
|
static JournalArticle |
updateArticle(long userId,
long groupId,
long folderId,
java.lang.String articleId,
double version,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String content,
java.lang.String ddmStructureKey,
java.lang.String ddmTemplateKey,
java.lang.String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
java.lang.String smallImageURL,
java.io.File smallImageFile,
java.util.Map<java.lang.String,byte[]> images,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the web content article with additional parameters.
|
static JournalArticle |
updateArticle(long userId,
long groupId,
long folderId,
java.lang.String articleId,
double version,
java.lang.String content,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the web content article matching the version, replacing its
folder and content.
|
static JournalArticle |
updateArticleTranslation(long groupId,
java.lang.String articleId,
double version,
java.util.Locale locale,
java.lang.String title,
java.lang.String description,
java.lang.String content,
java.util.Map<java.lang.String,byte[]> images,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the translation of the web content article.
|
static void |
updateAsset(long userId,
JournalArticle article,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
Deprecated.
As of 3.3.0, replaced by
updateAsset(long,
JournalArticle, long[], String[], long[], Double) |
static void |
updateAsset(long userId,
JournalArticle article,
long[] assetCategoryIds,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds,
java.lang.Double priority)
Updates the web content article's asset with the new asset categories,
tag names, and link entries, removing and adding them as necessary.
|
static JournalArticle |
updateContent(long groupId,
java.lang.String articleId,
double version,
java.lang.String content)
Updates the web content article matching the group, article ID, and
version, replacing its content.
|
static void |
updateDDMTemplateKey(long groupId,
long classNameId,
java.lang.String oldDDMTemplateKey,
java.lang.String newDDMTemplateKey)
Updates the web content articles matching the group, class name ID, and
DDM template key, replacing the DDM template key with a new one.
|
static JournalArticle |
updateJournalArticle(JournalArticle journalArticle)
Updates the journal article in the database or adds it if it does not yet exist.
|
static JournalArticle |
updateStatus(long userId,
JournalArticle article,
int status,
java.lang.String articleURL,
com.liferay.portal.kernel.service.ServiceContext serviceContext,
java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
Updates the workflow status of the web content article.
|
static JournalArticle |
updateStatus(long userId,
long classPK,
int status,
java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the workflow status of the web content article matching the class
PK.
|
static JournalArticle |
updateStatus(long userId,
long groupId,
java.lang.String articleId,
double version,
int status,
java.lang.String articleURL,
java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
Updates the workflow status of the web content article matching the
group, article ID, and version.
|
static void |
updateTemplateId(long groupId,
long classNameId,
java.lang.String oldDDMTemplateKey,
java.lang.String newDDMTemplateKey)
Deprecated.
As of 3.3.0, replaced by
updateDDMTemplateKey(long, long, java.lang.String, java.lang.String) |
@Deprecated public static JournalArticle addArticle(long userId, long groupId, long folderId, long classNameId, long classPK, java.lang.String articleId, boolean autoArticleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, boolean validateReferences, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
The web content articles hold HTML content wrapped in XML. The XML lets you specify the article's default locale and available locales. Here is a content example:
<?xml version='1.0' encoding='UTF-8'?>
<root default-locale="en_US" available-locales="en_US">
<static-content language-id="en_US">
<![CDATA[<p><b><i>test<i> content<b></p>]]>
</static-content>
</root>
userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderclassNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseclassPK
- the primary key of the DDM structure, if the primary key
of the DDMStructure class is given as the
classNameId
parameter, the primary key of the class
associated with the web content article, or 0
otherwisearticleId
- the primary key of the web content articleautoArticleId
- whether to auto generate the web content article IDversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XMLddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatelayoutUuid
- the unique string identifying the web content
article's display pagedisplayDateMonth
- the month the web content article is set to
displaydisplayDateDay
- the calendar day the web content article is set to
displaydisplayDateYear
- the year the web content article is set to
displaydisplayDateHour
- the hour the web content article is set to
displaydisplayDateMinute
- the minute the web content article is set to
displayexpirationDateMonth
- the month the web content article is set to
expireexpirationDateDay
- the calendar day the web content article is set
to expireexpirationDateYear
- the year the web content article is set to
expireexpirationDateHour
- the hour the web content article is set to
expireexpirationDateMinute
- the minute the web content article is set to
expireneverExpire
- whether the web content article is not set to auto
expirereviewDateMonth
- the month the web content article is set for
reviewreviewDateDay
- the calendar day the web content article is set for
reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for
reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content article is searchablesmallImage
- whether the web content article has a small imagesmallImageURL
- the web content article's small image URLsmallImageFile
- the web content article's small image fileimages
- the web content's imagesarticleURL
- the web content article's accessible URLvalidateReferences
- whether the article references are validated
or notserviceContext
- the service context to be applied. Can set the
UUID, creation date, modification date, expando bridge
attributes, guest permissions, group permissions, asset category
IDs, asset tag names, asset link entry IDs, URL title, and
workflow actions for the web content article. Can also set
whether to add the default guest and group permissions.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle addArticle(long userId, long groupId, long folderId, long classNameId, long classPK, java.lang.String articleId, boolean autoArticleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
The web content articles hold HTML content wrapped in XML. The XML lets you specify the article's default locale and available locales. Here is a content example:
<?xml version='1.0' encoding='UTF-8'?>
<root default-locale="en_US" available-locales="en_US">
<static-content language-id="en_US">
<![CDATA[<p><b><i>test<i> content<b></p>]]>
</static-content>
</root>
userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderclassNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseclassPK
- the primary key of the DDM structure, if the primary key
of the DDMStructure class is given as the
classNameId
parameter, the primary key of the class
associated with the web content article, or 0
otherwisearticleId
- the primary key of the web content articleautoArticleId
- whether to auto generate the web content article IDversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XMLddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatelayoutUuid
- the unique string identifying the web content
article's display pagedisplayDateMonth
- the month the web content article is set to
displaydisplayDateDay
- the calendar day the web content article is set to
displaydisplayDateYear
- the year the web content article is set to
displaydisplayDateHour
- the hour the web content article is set to
displaydisplayDateMinute
- the minute the web content article is set to
displayexpirationDateMonth
- the month the web content article is set to
expireexpirationDateDay
- the calendar day the web content article is set
to expireexpirationDateYear
- the year the web content article is set to
expireexpirationDateHour
- the hour the web content article is set to
expireexpirationDateMinute
- the minute the web content article is set to
expireneverExpire
- whether the web content article is not set to auto
expirereviewDateMonth
- the month the web content article is set for
reviewreviewDateDay
- the calendar day the web content article is set for
reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for
reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content article is searchablesmallImage
- whether the web content article has a small imagesmallImageURL
- the web content article's small image URLsmallImageFile
- the web content article's small image fileimages
- the web content's imagesarticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the
UUID, creation date, modification date, expando bridge
attributes, guest permissions, group permissions, asset category
IDs, asset tag names, asset link entry IDs, URL title, and
workflow actions for the web content article. Can also set
whether to add the default guest and group permissions.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle addArticle(long userId, long groupId, long folderId, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article foldertitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templateserviceContext
- the service context to be applied. Can set the
UUID, creation date, modification date, expando bridge
attributes, guest permissions, group permissions, asset category
IDs, asset tag names, asset link entry IDs, asset priority, URL
title, and workflow actions for the web content article. Can also
set whether to add the default guest and group permissions.com.liferay.portal.kernel.exception.PortalException
public static void addArticleResources(JournalArticle article, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
article
- the web content articleaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissionscom.liferay.portal.kernel.exception.PortalException
public static void addArticleResources(JournalArticle article, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException
article
- the web content article to add resources togroupPermissions
- the group permissions to be addedguestPermissions
- the guest permissions to be addedcom.liferay.portal.kernel.exception.PortalException
public static void addArticleResources(long groupId, java.lang.String articleId, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissionscom.liferay.portal.kernel.exception.PortalException
public static void addArticleResources(long groupId, java.lang.String articleId, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlegroupPermissions
- the group permissions to be addedguestPermissions
- the guest permissions to be addedcom.liferay.portal.kernel.exception.PortalException
public static JournalArticle addJournalArticle(JournalArticle journalArticle)
journalArticle
- the journal articlepublic static JournalArticle checkArticleResourcePrimKey(long groupId, java.lang.String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versioncom.liferay.portal.kernel.exception.PortalException
public static void checkArticles() throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void checkNewLine(long groupId, java.lang.String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versioncom.liferay.portal.kernel.exception.PortalException
public static void checkStructure(long groupId, java.lang.String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versioncom.liferay.portal.kernel.exception.PortalException
public static JournalArticle copyArticle(long userId, long groupId, java.lang.String oldArticleId, java.lang.String newArticleId, boolean autoArticleId, double version) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the web content article's creator/ownergroupId
- the primary key of the web content article's groupoldArticleId
- the primary key of the old web content articlenewArticleId
- the primary key of the new web content articleautoArticleId
- whether to auto-generate the web content article IDversion
- the web content article's versioncom.liferay.portal.kernel.exception.PortalException
public static JournalArticle createJournalArticle(long id)
id
- the primary key for the new journal articlepublic static JournalArticle deleteArticle(JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException
article
- the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle deleteArticle(JournalArticle article, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
article
- the web content articlearticleURL
- the web content article's accessible URL to include in
email notifications (optionally null
)serviceContext
- the service context to be applied (optionally
null
). Can set the portlet preferences that include
email information to notify recipients of the unapproved web
content's denial.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle deleteArticle(long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionarticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the
portlet preferences that include email information to notify
recipients of the unapproved web content article's denial.com.liferay.portal.kernel.exception.PortalException
public static void deleteArticle(long groupId, java.lang.String articleId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleserviceContext
- the service context to be applied. Can set the
portlet preferences that include email information to notify
recipients of the unapproved web content article's denial.com.liferay.portal.kernel.exception.PortalException
public static void deleteArticles(long groupId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupcom.liferay.portal.kernel.exception.PortalException
public static void deleteArticles(long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article foldercom.liferay.portal.kernel.exception.PortalException
public static void deleteArticles(long groupId, long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderincludeTrashedEntries
- whether to include recycled web content
articlescom.liferay.portal.kernel.exception.PortalException
public static void deleteArticles(long groupId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article
is related to a DDM structure, the primary key of the class name
associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseclassPK
- 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
otherwisecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle deleteJournalArticle(JournalArticle journalArticle)
journalArticle
- the journal articlepublic static JournalArticle deleteJournalArticle(long id) throws com.liferay.portal.kernel.exception.PortalException
id
- the primary key of the journal articlePortalException
- if a journal article with the primary key could not be foundpublic static void deleteLayoutArticleReferences(long groupId, java.lang.String layoutUuid)
groupId
- the primary key of the web content article's grouplayoutUuid
- the unique string identifying the web content article's
display pagepublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from JournalArticleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from JournalArticleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static JournalArticle expireArticle(long userId, long groupId, java.lang.String articleId, double version, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionarticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the
modification date, status date, portlet preferences, and can set
whether to add the default command update for the web content
article. With respect to social activities, by setting the
service context's command to Constants#UPDATE
, the
invocation is considered a web content update activity; otherwise
it is considered a web content add activity.com.liferay.portal.kernel.exception.PortalException
public static void expireArticle(long userId, long groupId, java.lang.String articleId, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
journal.article.expire.all.versions
portal property is
true
, otherwise expiring only its latest approved version.userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlearticleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the
modification date, status date, portlet preferences, and can set
whether to add the default command update for the web content
article. With respect to social activities, by setting the service
context's command to Constants#UPDATE
, the invocation is
considered a web content update activity; otherwise it is
considered a web content add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle fetchArticle(long groupId, java.lang.String articleId)
public static JournalArticle fetchArticle(long groupId, java.lang.String articleId, double version)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionnull
if no web content article could be
foundpublic static JournalArticle fetchArticleByUrlTitle(long groupId, java.lang.String urlTitle)
public static JournalArticle fetchDisplayArticle(long groupId, java.lang.String articleId)
public static JournalArticle fetchJournalArticle(long id)
public static JournalArticle fetchJournalArticleByUuidAndGroupId(java.lang.String uuid, long groupId)
uuid
- the journal article's UUIDgroupId
- the primary key of the groupnull
if a matching journal article could not be foundpublic static JournalArticle fetchLatestArticle(long resourcePrimKey)
public static JournalArticle fetchLatestArticle(long resourcePrimKey, int status)
public static JournalArticle fetchLatestArticle(long resourcePrimKey, int status, boolean preferApproved)
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.preferApproved
- whether to prefer returning the latest matching
article that has workflow status WorkflowConstants#STATUS_APPROVED
over returning one that has a
different statusnull
if no matching web
content article could be foundpublic static JournalArticle fetchLatestArticle(long resourcePrimKey, int[] statuses)
public static JournalArticle fetchLatestArticle(long groupId, java.lang.String articleId, int status)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.null
if
no matching web content article could be foundpublic static JournalArticle fetchLatestArticleByUrlTitle(long groupId, java.lang.String urlTitle, int status)
public static JournalArticle fetchLatestIndexableArticle(long resourcePrimKey)
resourcePrimKey
- the primary key of the resource instancenull
if no matching web content
article could be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static JournalArticle getArticle(long id) throws com.liferay.portal.kernel.exception.PortalException
id
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getArticle(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getArticle(long groupId, java.lang.String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versioncom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getArticle(long groupId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article
is related to a DDM structure, the primary key of the class name
associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseclassPK
- 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
otherwisecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getArticleByUrlTitle(long groupId, java.lang.String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupurlTitle
- the web content article's accessible URL titlecom.liferay.portal.kernel.exception.PortalException
public static java.lang.String getArticleContent(JournalArticle article, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
article
- the web content articleddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
@Deprecated public static java.lang.String getArticleContent(JournalArticle article, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
getArticleContent(JournalArticle, String, String, String,
PortletRequestModel,ThemeDisplay)
article
- the web content articleddmTemplateKey
- the primary key of the web content article's
DDM templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, double version, java.lang.String viewMode, java.lang.String ddmTemplateKey, java.lang.String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's DDM
templatelanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
@Deprecated public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, double version, java.lang.String viewMode, java.lang.String ddmTemplateKey, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's
DDM template (optionally null
). If the article
is related to a DDM structure, the template's structure must
match it.languageId
- the primary key of the language translation to getthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
@Deprecated public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, double version, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, java.lang.String viewMode, java.lang.String ddmTemplateKey, java.lang.String languageId, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's DDM
templatelanguageId
- the primary key of the language translation to getportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
@Deprecated public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, java.lang.String viewMode, java.lang.String ddmTemplateKey, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedddmTemplateKey
- the primary key of the web content article's
DDM templatelanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
@Deprecated public static java.lang.String getArticleContent(long groupId, java.lang.String articleId, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaycom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(JournalArticle article, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
article
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, double version, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, double version, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
null
).groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, java.lang.String viewMode, java.lang.String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
null
).groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, int page, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getpage
- the web content article page to displayportletRequestModel
- the portlet request modelthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, java.lang.String ddmTemplateKey, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
null
).groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleddmTemplateKey
- the primary key of the web content article's DDM
templateviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static JournalArticleDisplay getArticleDisplay(long groupId, java.lang.String articleId, java.lang.String viewMode, java.lang.String languageId, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException
null
).groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleviewMode
- the mode in which the web content is being viewedlanguageId
- the primary key of the language translation to getthemeDisplay
- the theme displaynull
if the
article has expired or if article's display date/time is after
the current date/timecom.liferay.portal.kernel.exception.PortalException
public static java.util.List<JournalArticle> getArticles()
public static java.util.List<JournalArticle> getArticles(long groupId)
groupId
- the primary key of the web content article's grouppublic static java.util.List<JournalArticle> getArticles(long groupId, int start, int end)
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.
groupId
- the primary key of the web content article's groupstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> getArticles(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
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.
groupId
- the primary key of the web content article's groupstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static java.util.List<JournalArticle> getArticles(long groupId, long folderId)
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderpublic static java.util.List<JournalArticle> getArticles(long groupId, long folderId, int start, int end)
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.
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> getArticles(long groupId, long folderId, int status, int start, int end)
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.
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> getArticles(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
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.
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)orderByComparator
- the comparator to order the web content
articlespublic static java.util.List<JournalArticle> getArticles(long groupId, java.lang.String articleId)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlepublic static java.util.List<JournalArticle> getArticles(long groupId, java.lang.String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
public static java.util.List<JournalArticle> getArticlesByResourcePrimKey(long resourcePrimKey)
resourcePrimKey
- the primary key of the resource instancepublic static java.util.List<JournalArticle> getArticlesBySmallImageId(long smallImageId)
smallImageId
- the primary key of the web content article's small
imagepublic static java.util.List<JournalArticle> getArticlesByStructureId(long groupId, long classNameId, java.lang.String ddmStructureKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
public static java.util.List<JournalArticle> getArticlesByStructureId(long groupId, java.lang.String ddmStructureKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
public static java.util.List<JournalArticle> getArticlesByStructureId(long groupId, java.lang.String ddmStructureKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
public static int getArticlesCount(long groupId)
groupId
- the primary key of the web content article's grouppublic static int getArticlesCount(long groupId, long folderId)
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderpublic static int getArticlesCount(long groupId, long folderId, int status)
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article's folderstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.public static int getArticlesCount(long groupId, java.lang.String articleId)
public static java.util.List<JournalArticle> getCompanyArticles(long companyId, double version, int status, int start, int end)
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.
companyId
- the primary key of the web content article's companyversion
- the web content article's versionstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> getCompanyArticles(long companyId, int status, int start, int end)
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.
companyId
- the primary key of the web content article's companystatus
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static int getCompanyArticlesCount(long companyId, double version, int status, int start, int end)
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.
companyId
- the primary key of the web content article's companyversion
- the web content article's versionstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.start
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static int getCompanyArticlesCount(long companyId, int status)
companyId
- the primary key of the web content article's companystatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.public static JournalArticle getDisplayArticle(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getDisplayArticleByUrlTitle(long groupId, java.lang.String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupurlTitle
- the web content article's accessible URL titlecom.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.util.List<JournalArticle> getIndexableArticlesByDDMStructureKey(java.lang.String[] ddmStructureKeys)
public static java.util.List<JournalArticle> getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
resourcePrimKey
- the primary key of the resource instancepublic static JournalArticle getJournalArticle(long id) throws com.liferay.portal.kernel.exception.PortalException
id
- the primary key of the journal articlePortalException
- if a journal article with the primary key could not be foundpublic static JournalArticle getJournalArticleByUuidAndGroupId(java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the journal article's UUIDgroupId
- the primary key of the groupPortalException
- if a matching journal article could not be foundpublic static java.util.List<JournalArticle> getJournalArticles(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil.ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from JournalArticleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of journal articlesend
- the upper bound of the range of journal articles (not inclusive)public static java.util.List<JournalArticle> getJournalArticlesByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the UUID of the journal articlescompanyId
- the primary key of the companypublic static java.util.List<JournalArticle> getJournalArticlesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> orderByComparator)
uuid
- the UUID of the journal articlescompanyId
- the primary key of the companystart
- the lower bound of the range of journal articlesend
- the upper bound of the range of journal articles (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getJournalArticlesCount()
public static JournalArticle getLatestArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException
resourcePrimKey
- the primary key of the resource instancecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticle(long resourcePrimKey, int status, boolean preferApproved) throws com.liferay.portal.kernel.exception.PortalException
resourcePrimKey
- the primary key of the resource instancestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.preferApproved
- whether to prefer returning the latest matching
article that has workflow status WorkflowConstants#STATUS_APPROVED
over returning one that has a
different statuscom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticle(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticle(long groupId, java.lang.String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticle(long groupId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupclassName
- the DDMStructure class name if the web content article
is related to a DDM structure, the class name associated with the
article, or JournalArticleConstants.CLASSNAME_ID_DEFAULT in the
journal-api module otherwiseclassPK
- 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
otherwisecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getLatestArticleByUrlTitle(long groupId, java.lang.String urlTitle, int status) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's groupurlTitle
- the web content article's accessible URL titlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.com.liferay.portal.kernel.exception.PortalException
public static double getLatestVersion(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static double getLatestVersion(long groupId, java.lang.String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.com.liferay.portal.kernel.exception.PortalException
public static java.util.List<JournalArticle> getNoAssetArticles()
public static java.util.List<JournalArticle> getNoPermissionArticles()
public static int getNotInTrashArticlesCount(long groupId, long folderId)
groupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderpublic static JournalArticle getOldestArticle(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle getOldestArticle(long groupId, java.lang.String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.com.liferay.portal.kernel.exception.PortalException
public static java.lang.String getOSGiServiceIdentifier()
public static java.util.List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalArticle getPreviousApprovedArticle(JournalArticle article)
WorkflowConstants#STATUS_APPROVED
.article
- the web content articlepublic static java.util.List<JournalArticle> getStructureArticles(long groupId, java.lang.String ddmStructureKey)
groupId
- the primary key of the web content article's groupddmStructureKey
- the primary key of the web content article's DDM
structurepublic static java.util.List<JournalArticle> getStructureArticles(long groupId, java.lang.String ddmStructureKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
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.
groupId
- the primary key of the web content article's groupddmStructureKey
- the primary key of the web content article's DDM
structurestart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static java.util.List<JournalArticle> getStructureArticles(java.lang.String[] ddmStructureKeys)
ddmStructureKeys
- the primary keys of the web content article's
DDM structurespublic static int getStructureArticlesCount(long groupId, java.lang.String ddmStructureKey)
groupId
- the primary key of the web content article's groupddmStructureKey
- the primary key of the web content article's DDM
structurepublic static java.util.List<JournalArticle> getTemplateArticles(long groupId, java.lang.String ddmTemplateKey)
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM
templatepublic static java.util.List<JournalArticle> getTemplateArticles(long groupId, java.lang.String ddmTemplateKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
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.
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM
templatestart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static int getTemplateArticlesCount(long groupId, java.lang.String ddmTemplateKey)
groupId
- the primary key of the web content article's groupddmTemplateKey
- the primary key of the web content article's DDM
templatepublic static java.lang.String getUniqueUrlTitle(long groupId, java.lang.String articleId, java.lang.String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleurlTitle
- the web content article's accessible URL titlecom.liferay.portal.kernel.exception.PortalException
public static boolean hasArticle(long groupId, java.lang.String articleId)
true
if the specified web content article exists.groupId
- the primary key of the grouparticleId
- the primary key of the web content articletrue
if the specified web content article exists;
false
otherwisepublic static boolean isLatestVersion(long groupId, java.lang.String articleId, double version) throws com.liferay.portal.kernel.exception.PortalException
true
if the web content article, specified by group
and article ID, is the latest version.groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versiontrue
if the specified web content article is the
latest version; false
otherwisecom.liferay.portal.kernel.exception.PortalException
public static boolean isLatestVersion(long groupId, java.lang.String articleId, double version, int status) throws com.liferay.portal.kernel.exception.PortalException
true
if the web content article, specified by group,
article ID, and workflow status, is the latest version.groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.true
if the specified web content article is the
latest version; false
otherwisecom.liferay.portal.kernel.exception.PortalException
public static boolean isListable(JournalArticle article)
public static boolean isRenderable(JournalArticle article, com.liferay.portal.kernel.portlet.PortletRequestModel portletRequestModel, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay)
@Deprecated public static JournalArticle moveArticle(long groupId, java.lang.String articleId, long newFolderId) throws com.liferay.portal.kernel.exception.PortalException
moveArticle(long, String,
long, ServiceContext)
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlenewFolderId
- the primary key of the web content article's new
foldercom.liferay.portal.kernel.exception.PortalException
public static JournalArticle moveArticle(long groupId, java.lang.String articleId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlenewFolderId
- the primary key of the web content article's new
folderserviceContext
- the service context to be applied. Can set the
user ID, language ID, portlet preferences, portlet request,
portlet response, theme display, and can set whether to add the
default command update for the web content article. With respect
to social activities, by setting the service context's command to
Constants#UPDATE
, the invocation is considered a web
content update activity; otherwise it is considered a web content
add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle moveArticleFromTrash(long userId, long groupId, JournalArticle article, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's grouparticle
- the web content articlenewFolderId
- the primary key of the web content article's new
folderserviceContext
- the service context to be applied. Can set the
modification date, portlet preferences, and can set whether to
add the default command update for the web content article. With
respect to social activities, by setting the service context's
command to Constants#UPDATE
, the invocation is considered
a web content update activity; otherwise it is considered a web
content add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle moveArticleToTrash(long userId, JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlearticle
- the web content articlecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle moveArticleToTrash(long userId, long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articlenull
if no matching
article was foundcom.liferay.portal.kernel.exception.PortalException
public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException
For example, here is a conceptualization of a web content article tree path:
/(Folder's folderId)/(Subfolder's folderId)/(article's articleId)
companyId
- the primary key of the web content article's companycom.liferay.portal.kernel.exception.PortalException
public static JournalArticle removeArticleLocale(long groupId, java.lang.String articleId, double version, java.lang.String languageId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionlanguageId
- the primary key of the language locale to removecom.liferay.portal.kernel.exception.PortalException
public static JournalArticle restoreArticleFromTrash(long userId, JournalArticle article) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user restoring the web content
articlearticle
- the web content articlecom.liferay.portal.kernel.exception.PortalException
public static java.util.List<JournalArticle> search(long groupId, java.util.List<java.lang.Long> folderIds, int status, int start, int end)
search(long, long, long, int, int, int)
instead of this method
wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> search(long groupId, long folderId, int status, int start, int end)
search(long, long, long, int, int, int)
instead of this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the group (optionally 0
)folderId
- the primary key of the web content article folderstatus
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)public static java.util.List<JournalArticle> search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
search(long, long, List,
long, String, String, String, LinkedHashMap, int, int, Sort)
instead of
this method wherever possible for performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisekeywords
- the keywords (space separated), which may occur in the
web content article ID, title, description, or content
(optionally null
). If the keywords value is not
null
, the search uses the OR operator in connecting
query criteria; otherwise it uses the AND operator.version
- the web content article's version (optionally
null
)ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatedisplayDateGT
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static java.util.List<JournalArticle> search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
search(long, long, List,
long, String, String, String, String, int, String, String, LinkedHashMap,
boolean, int, int, Sort)
instead of this method wherever possible for
performance reasons.
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)version
- the web content article's version (optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatedisplayDateGT
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static java.util.List<JournalArticle> search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalArticle> obc)
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.
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)version
- the web content article's version (optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)ddmStructureKeys
- the primary keys of the web content article's
DDM structures, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKeys
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)obc
- the comparator to order the web content articlespublic static com.liferay.portal.kernel.search.Hits search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort)
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.
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatekeywords
- the keywords (space separated), which may occur in the
web content article ID, title, description, or content
(optionally null
). If the keywords value is not
null
, the search uses the OR operator in connecting
query criteria; otherwise it uses the AND operator.params
- the finder parameters (optionally null
)start
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)sort
- the field, type, and direction by which to sort (optionally
null
)sort
public static com.liferay.portal.kernel.search.Hits search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.String title, java.lang.String description, java.lang.String content, int status, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)
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.
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)status
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templateparams
- the finder parameters (optionally null
). The
includeDiscussions
parameter can be set to
true
to search for the keywords in the web content
article discussions.andSearch
- whether every field must match its value or keywords,
or just one field must matchstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)sort
- the field, type, and direction by which to sort (optionally
null
)sort
@Deprecated public static com.liferay.portal.kernel.search.Hits search(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String statusString, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort)
search(long, long, List,
long, String, String, String, String, int, String, String,
LinkedHashMap, boolean, int, int, Sort)
public static com.liferay.portal.kernel.search.Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
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.
groupId
- the primary key of the group (optionally 0
)userId
- the primary key of the user searching for web content
articlescreatorUserId
- the primary key of the web content article's
creatorstatus
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)com.liferay.portal.kernel.exception.PortalException
public static int searchCount(long groupId, java.util.List<java.lang.Long> folderIds, int status)
groupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)status
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.public static int searchCount(long groupId, long folderId, int status)
groupId
- the primary key of the group (optionally 0
)folderId
- the primary key of the web content article folderstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.public static int searchCount(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate)
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisekeywords
- the keywords (space separated), which may occur in the
web content article ID, title, description, or content
(optionally null
). If the keywords value is not
null
, the search uses the OR operator in connecting
query criteria; otherwise it uses the AND operator.version
- the web content article's version (optionally
null
)ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatedisplayDateGT
- 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
)public static int searchCount(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator)
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)version
- the web content article's version (optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatedisplayDateGT
- 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.public static int searchCount(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator)
companyId
- the primary key of the web content article's companygroupId
- the primary key of the group (optionally 0
)folderIds
- the primary keys of the web content article folders
(optionally Collections#EMPTY_LIST
)classNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)version
- the web content article's version (optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)ddmStructureKeys
- the primary keys of the web content article's
DDM structures, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKeys
- 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.public static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
BaseModelSearchResult
containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including a keywords parameter for matching
an article's ID, title, description, or content, a DDM structure key
parameter, a DDM template key parameter, and a finder hash map parameter.
It is preferable to use this method instead of the non-indexed version
whenever possible for performance reasons.
The start
and end
parameters only affect the
amount of web content articles returned as results, not the total number
of hits.
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.
companyId
- the primary key of the web content article's companygroupId
- 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, the
primary key of the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseddmStructureKey
- the primary key of the web content article's DDM
structureddmTemplateKey
- the primary key of the web content article's DDM
templatekeywords
- the keywords (space separated), which may occur in the
web content article ID, title, description, or content
(optionally null
). If the keywords value is not
null
, the search uses the OR operator in connecting
query criteria; otherwise it uses the AND operator.params
- the finder parameters (optionally null
)start
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)sort
- the field, type, and direction by which to sort (optionally
null
)BaseModelSearchResult
containing the total number of
hits and an ordered range of all the matching web content
articles ordered by sort
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId, long groupId, java.util.List<java.lang.Long> folderIds, long classNameId, java.lang.String articleId, java.lang.String title, java.lang.String description, java.lang.String content, int status, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andSearch, int start, int end, com.liferay.portal.kernel.search.Sort sort) throws com.liferay.portal.kernel.exception.PortalException
BaseModelSearchResult
containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including keyword parameters for article
ID, title, description, or content, a DDM structure key parameter, a DDM
template key parameter, an AND operator switch, and parameters for type,
status, and a finder hash map. It is preferable to use this method
instead of the non-indexed version whenever possible for performance
reasons.
The start
and end
parameters only affect the
amount of web content articles returned as results, not the total number
of hits.
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.
companyId
- the primary key of the web content article's companygroupId
- 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, the
primary key of the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwisearticleId
- the article ID keywords (space separated, optionally
null
)title
- the title keywords (space separated, optionally
null
)description
- the description keywords (space separated, optionally
null
)content
- the content keywords (space separated, optionally
null
)status
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.ddmStructureKey
- the primary key of the web content article's DDM
structureddmTemplateKey
- the primary key of the web content article's DDM
templateparams
- the finder parameters (optionally null
). The
includeDiscussions
parameter can be set to
true
to search for the keywords in the web content
article discussions.andSearch
- whether every field must match its value or keywords,
or just one field must matchstart
- the lower bound of the range of web content articles to
returnend
- the upper bound of the range of web content articles to
return (not inclusive)sort
- the field, type, and direction by which to sort (optionally
null
)BaseModelSearchResult
containing the total number of
hits and an ordered range of all the matching web content
articles ordered by sort
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.search.BaseModelSearchResult<JournalArticle> searchJournalArticles(long groupId, long userId, long creatorUserId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
BaseModelSearchResult
containing the total number of
hits and an ordered range of all the web content articles matching the
parameters using the indexer, including the web content article's creator
ID and status. It is preferable to use this method instead of the
non-indexed version whenever possible for performance reasons.
The start
and end
parameters only affect the
amount of web content articles returned as results, not the total number
of hits.
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.
groupId
- the primary key of the group (optionally 0
)userId
- the primary key of the user searching for web content
articlescreatorUserId
- the primary key of the web content article's
creatorstatus
- 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
returnend
- the upper bound of the range of web content articles to
return (not inclusive)BaseModelSearchResult
containing the total number of
hits and an ordered range of all the matching web content
articles ordered by sort
com.liferay.portal.kernel.exception.PortalException
public static void setTreePaths(long folderId, java.lang.String treePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void subscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the folder's groupuserId
- the primary key of the user to be subscribedddmStructureId
- the primary key of the structure to subscribe tocom.liferay.portal.kernel.exception.PortalException
public static void unsubscribeStructure(long groupId, long userId, long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the folder's groupuserId
- the primary key of the user to be subscribedddmStructureId
- the primary key of the structure to subscribe tocom.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateArticle(long userId, long groupId, long folderId, java.lang.String articleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String layoutUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.layoutUuid
- the unique string identifying the web content
article's display pageserviceContext
- the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, asset priority, workflow
actions, URL title, and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants#UPDATE
, the invocation is considered a web
content update activity; otherwise it is considered a web content
add activity.com.liferay.portal.kernel.exception.PortalException
@Deprecated public static JournalArticle updateArticle(long userId, long groupId, long folderId, java.lang.String articleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, boolean validateReferences, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatelayoutUuid
- the unique string identifying the web content
article's display pagedisplayDateMonth
- the month the web content article is set to
displaydisplayDateDay
- the calendar day the web content article is set to
displaydisplayDateYear
- the year the web content article is set to
displaydisplayDateHour
- the hour the web content article is set to
displaydisplayDateMinute
- the minute the web content article is set to
displayexpirationDateMonth
- the month the web content article is set to
expireexpirationDateDay
- the calendar day the web content article is set
to expireexpirationDateYear
- the year the web content article is set to
expireexpirationDateHour
- the hour the web content article is set to
expireexpirationDateMinute
- the minute the web content article is set to
expireneverExpire
- whether the web content article is not set to auto
expirereviewDateMonth
- the month the web content article is set for
reviewreviewDateDay
- the calendar day the web content article is set for
reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for
reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content is searchablesmallImage
- whether to update web content article's a small image.
A file must be passed in as smallImageFile
value,
otherwise the current small image is deleted.smallImageURL
- the web content article's small image URL
(optionally null
)smallImageFile
- the web content article's new small image file
(optionally null
). Must pass in
smallImage
value of true
to replace the
article's small image file.images
- the web content's images (optionally null
)articleURL
- the web content article's accessible URL (optionally
null
)validateReferences
- whether the article references are validated
or notserviceContext
- the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, asset priority, workflow
actions, URL title , and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants#UPDATE
, the invocation is considered a web
content update activity; otherwise it is considered a web content
add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateArticle(long userId, long groupId, long folderId, java.lang.String articleId, double version, java.util.Map<java.util.Locale,java.lang.String> titleMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String content, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallImageFile, java.util.Map<java.lang.String,byte[]> images, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versiontitleMap
- the web content article's locales and localized titlesdescriptionMap
- the web content article's locales and localized
descriptionscontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.ddmStructureKey
- the primary key of the web content article's DDM
structure, if the article is related to a DDM structure, or
null
otherwiseddmTemplateKey
- the primary key of the web content article's DDM
templatelayoutUuid
- the unique string identifying the web content
article's display pagedisplayDateMonth
- the month the web content article is set to
displaydisplayDateDay
- the calendar day the web content article is set to
displaydisplayDateYear
- the year the web content article is set to
displaydisplayDateHour
- the hour the web content article is set to
displaydisplayDateMinute
- the minute the web content article is set to
displayexpirationDateMonth
- the month the web content article is set to
expireexpirationDateDay
- the calendar day the web content article is set
to expireexpirationDateYear
- the year the web content article is set to
expireexpirationDateHour
- the hour the web content article is set to
expireexpirationDateMinute
- the minute the web content article is set to
expireneverExpire
- whether the web content article is not set to auto
expirereviewDateMonth
- the month the web content article is set for
reviewreviewDateDay
- the calendar day the web content article is set for
reviewreviewDateYear
- the year the web content article is set for reviewreviewDateHour
- the hour the web content article is set for reviewreviewDateMinute
- the minute the web content article is set for
reviewneverReview
- whether the web content article is not set for reviewindexable
- whether the web content is searchablesmallImage
- whether to update web content article's a small image.
A file must be passed in as smallImageFile
value,
otherwise the current small image is deleted.smallImageURL
- the web content article's small image URL
(optionally null
)smallImageFile
- the web content article's new small image file
(optionally null
). Must pass in
smallImage
value of true
to replace the
article's small image file.images
- the web content's images (optionally null
)articleURL
- the web content article's accessible URL (optionally
null
)serviceContext
- the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, asset priority, workflow
actions, URL title , and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants#UPDATE
, the invocation is considered a web
content update activity; otherwise it is considered a web content
add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateArticle(long userId, long groupId, long folderId, java.lang.String articleId, double version, java.lang.String content, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
articlegroupId
- the primary key of the web content article's groupfolderId
- the primary key of the web content article folderarticleId
- the primary key of the web content articleversion
- the web content article's versioncontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.serviceContext
- the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, asset priority, workflow
actions, URL title, and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants#UPDATE
, the invocation is considered a web
content update activity; otherwise it is considered a web content
add activity.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateArticleTranslation(long groupId, java.lang.String articleId, double version, java.util.Locale locale, java.lang.String title, java.lang.String description, java.lang.String content, java.util.Map<java.lang.String,byte[]> images, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionlocale
- the locale of the web content article's display templatetitle
- the translated web content article titledescription
- the translated web content article descriptioncontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.images
- the web content's imagesserviceContext
- the service context to be applied. Can set the
modification date and URL title for the web content article.com.liferay.portal.kernel.exception.PortalException
@Deprecated public static void updateAsset(long userId, JournalArticle article, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds) throws com.liferay.portal.kernel.exception.PortalException
updateAsset(long,
JournalArticle, long[], String[], long[], Double)
userId
- the primary key of the user updating the web content
article's assetarticle
- the web content articleassetCategoryIds
- the primary keys of the new asset categoriesassetTagNames
- the new asset tag namesassetLinkEntryIds
- the primary keys of the new asset link
entriescom.liferay.portal.kernel.exception.PortalException
public static void updateAsset(long userId, JournalArticle article, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
article's assetarticle
- the web content articleassetCategoryIds
- the primary keys of the new asset categoriesassetTagNames
- the new asset tag namesassetLinkEntryIds
- the primary keys of the new asset link entriespriority
- the priority of the assetcom.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateContent(long groupId, java.lang.String articleId, double version, java.lang.String content) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versioncontent
- the HTML content wrapped in XML. For more information,
see the content example in the addArticle(long, long,
long, long, long, String, boolean, double, Map, Map, String,
String, String, String, int, int, int, int, int, int, int, int,
int, int, boolean, int, int, int, int, int, boolean, boolean,
boolean, String, File, Map, String, ServiceContext)
description.com.liferay.portal.kernel.exception.PortalException
public static void updateDDMTemplateKey(long groupId, long classNameId, java.lang.String oldDDMTemplateKey, java.lang.String newDDMTemplateKey)
groupId
- the primary key of the web content article's groupclassNameId
- the primary key of the DDMStructure class if the web
content article is related to a DDM structure, the primary key of
the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the journal-api
module otherwiseoldDDMTemplateKey
- the primary key of the web content article's old
DDM templatenewDDMTemplateKey
- the primary key of the web content article's new
DDM templatepublic static JournalArticle updateJournalArticle(JournalArticle journalArticle)
journalArticle
- the journal articlepublic static JournalArticle updateStatus(long userId, JournalArticle article, int status, java.lang.String articleURL, com.liferay.portal.kernel.service.ServiceContext serviceContext, java.util.Map<java.lang.String,java.io.Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
article's statusarticle
- the web content articlestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.articleURL
- the web content article's accessible URLserviceContext
- the service context to be applied. Can set the
modification date, status date, and portlet preferences. With
respect to social activities, by setting the service context's
command to Constants#UPDATE
, the invocation is considered
a web content update activity; otherwise it is considered a web
content add activity.workflowContext
- the web content article's configured workflow
contextcom.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateStatus(long userId, long classPK, int status, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
article's statusclassPK
- the primary key of the DDM structure, if the web content
article is related to a DDM structure, the primary key of the
class associated with the article, or 0
otherwisestatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.workflowContext
- the web content article's configured workflowserviceContext
- the service context to be applied. Can set the
modification date, portlet preferences, and can set whether to
add the default command update for the web content article.com.liferay.portal.kernel.exception.PortalException
public static JournalArticle updateStatus(long userId, long groupId, java.lang.String articleId, double version, int status, java.lang.String articleURL, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
userId
- the primary key of the user updating the web content
article's statusgroupId
- the primary key of the web content article's grouparticleId
- the primary key of the web content articleversion
- the web content article's versionstatus
- the web content article's workflow status. For more
information see WorkflowConstants
for constants starting
with the "STATUS_" prefix.articleURL
- the web content article's accessible URLworkflowContext
- the web content article's configured workflowserviceContext
- the service context to be applied. Can set the
modification date, portlet preferences, and can set whether to
add the default command update for the web content article.com.liferay.portal.kernel.exception.PortalException
@Deprecated public static void updateTemplateId(long groupId, long classNameId, java.lang.String oldDDMTemplateKey, java.lang.String newDDMTemplateKey)
updateDDMTemplateKey(long, long, java.lang.String, java.lang.String)
groupId
- the primary key of the web content article's groupclassNameId
- the primary key of the DDMStructure class if the
web content article is related to a DDM structure, the
primary key of the class name associated with the article, or
JournalArticleConstants.CLASSNAME_ID_DEFAULT in the
journal-api module otherwiseoldDDMTemplateKey
- the primary key of the web content
article's old DDM templatenewDDMTemplateKey
- the primary key of the web content
article's new DDM templatepublic static JournalArticleLocalService getService()