|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface JournalArticleServiceProvides the remote service interface for JournalArticle. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
JournalArticleServiceUtil,
com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl,
com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl| Method Summary | |
|---|---|
JournalArticle |
addArticle(long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
String smallImageURL,
File smallFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
Adds a web content article with additional parameters. |
JournalArticle |
addArticle(long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
String articleURL,
ServiceContext serviceContext)
Adds a web content article without any images. |
JournalArticle |
copyArticle(long groupId,
String oldArticleId,
String newArticleId,
boolean autoArticleId,
double version)
Copies the web content article matching the group, article ID, and version. |
void |
deleteArticle(long groupId,
String articleId,
double version,
String articleURL,
ServiceContext serviceContext)
Deletes the web content article and its resources matching the group, article ID, and version, optionally sending email notifying denial of the web content article if it had not yet been approved. |
void |
deleteArticle(long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
Deletes all web content articles and their resources matching the group and article ID, optionally sending email notifying denial of article if it had not yet been approved. |
JournalArticle |
expireArticle(long groupId,
String articleId,
double version,
String articleURL,
ServiceContext serviceContext)
Expires the web content article matching the group, article ID, and version. |
void |
expireArticle(long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
Expires the web content article matching the group and article ID, expiring all of its versions if the journal.article.expire.all.versions portal property is
true, otherwise expiring only its latest approved version. |
JournalArticle |
getArticle(long id)
Returns the web content article with the ID. |
JournalArticle |
getArticle(long groupId,
String articleId)
Returns the latest approved web content article, or the latest unapproved article if none are approved. |
JournalArticle |
getArticle(long groupId,
String articleId,
double version)
Returns the web content article matching the group, article ID, and version. |
JournalArticle |
getArticle(long groupId,
String className,
long classPK)
Returns the web content article matching the group, class name, and class PK. |
JournalArticle |
getArticleByUrlTitle(long groupId,
String urlTitle)
Returns the latest web content article that is approved, or the latest unapproved article if none are approved. |
String |
getArticleContent(long groupId,
String articleId,
double version,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
Returns the web content from the web content article matching the group, article ID, and version. |
String |
getArticleContent(long groupId,
String articleId,
double version,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, double, String, PortletRequestModel, ThemeDisplay) |
String |
getArticleContent(long groupId,
String articleId,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
Returns the latest web content from the web content article matching the group and article ID. |
String |
getArticleContent(long groupId,
String articleId,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, String, PortletRequestModel, ThemeDisplay) |
List<JournalArticle> |
getArticles(long groupId,
long folderId)
Returns all the web content articles matching the group and folder. |
List<JournalArticle> |
getArticles(long groupId,
long folderId,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group and folder. |
List<JournalArticle> |
getArticlesByArticleId(long groupId,
String articleId,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group and article ID. |
List<JournalArticle> |
getArticlesByLayoutUuid(long groupId,
String layoutUuid)
Returns all the web content articles matching the group and layout UUID. |
List<JournalArticle> |
getArticlesByStructureId(long groupId,
long classNameId,
String ddmStructureKey,
int status,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group, class name ID, DDM structure key, and workflow status. |
List<JournalArticle> |
getArticlesByStructureId(long groupId,
String ddmStructureKey,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group, default class name ID, and DDM structure key. |
int |
getArticlesCount(long groupId,
long folderId)
Returns the number of web content articles matching the group and folder. |
int |
getArticlesCount(long groupId,
long folderId,
int status)
Returns the number of web content articles matching the group, folder, and status. |
int |
getArticlesCountByArticleId(long groupId,
String articleId)
Returns the number of web content articles matching the group and article ID. |
int |
getArticlesCountByStructureId(long groupId,
long classNameId,
String ddmStructureKey,
int status)
Returns the number of web content articles matching the group, class name ID, DDM structure key, and workflow status. |
int |
getArticlesCountByStructureId(long groupId,
String ddmStructureKey)
Returns the number of web content articles matching the group, default class name ID, and DDM structure key. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
JournalArticle |
getDisplayArticleByUrlTitle(long groupId,
String urlTitle)
Returns the web content article matching the URL title that is currently displayed or next to be displayed if no article is currently displayed. |
int |
getFoldersAndArticlesCount(long groupId,
List<Long> folderIds)
Returns the number of folders containing web content articles belonging to the group. |
List<JournalArticle> |
getGroupArticles(long groupId,
long userId,
long rootFolderId,
int status,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders. |
List<JournalArticle> |
getGroupArticles(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
Returns an ordered range of all the web content articles matching the group, user, the root folder or any of its subfolders. |
int |
getGroupArticlesCount(long groupId,
long userId,
long rootFolderId)
Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders. |
int |
getGroupArticlesCount(long groupId,
long userId,
long rootFolderId,
int status)
Returns the number of web content articles matching the group, user, and the root folder or any of its subfolders. |
JournalArticle |
getLatestArticle(long resourcePrimKey)
Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status. |
JournalArticle |
getLatestArticle(long groupId,
String articleId,
int status)
Returns the latest web content article matching the group, article ID, and workflow status. |
JournalArticle |
getLatestArticle(long groupId,
String className,
long classPK)
Returns the latest web content article matching the group, class name ID, and class PK. |
void |
moveArticle(long groupId,
String articleId,
long newFolderId)
Moves all versions of the the web content article matching the group and article ID to the folder. |
JournalArticle |
moveArticleFromTrash(long groupId,
long resourcePrimKey,
long newFolderId,
ServiceContext serviceContext)
Moves the web content article from the Recycle Bin to the folder. |
JournalArticle |
moveArticleFromTrash(long groupId,
String articleId,
long newFolderId,
ServiceContext serviceContext)
Moves the web content article from the Recycle Bin to the folder. |
JournalArticle |
moveArticleToTrash(long groupId,
String articleId)
Moves the latest version of the web content article matching the group and article ID to the recycle bin. |
void |
removeArticleLocale(long companyId,
String languageId)
Removes the web content of all the company's web content articles matching the language. |
JournalArticle |
removeArticleLocale(long groupId,
String articleId,
double version,
String languageId)
Removes the web content of the web content article matching the group, article ID, and version, and language. |
void |
restoreArticleFromTrash(long resourcePrimKey)
Restores the web content article associated with the resource primary key from the Recycle Bin. |
void |
restoreArticleFromTrash(long groupId,
String articleId)
Restores the web content article from the Recycle Bin. |
Hits |
search(long groupId,
long creatorUserId,
int status,
int start,
int end)
Returns a range of all the web content articles matching the group, creator, creator, and workflow status using the indexer. |
List<JournalArticle> |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String keywords,
Double version,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter. |
List<JournalArticle> |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String[] ddmStructureKeys,
String[] ddmTemplateKeys,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch. |
List<JournalArticle> |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch. |
int |
searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String keywords,
Double version,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate)
Returns the number of web content articles matching the parameters, including a keywords parameter for matching with the article's ID, title, description, and content, a DDM structure key parameter, and a DDM template key parameter. |
int |
searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String[] ddmStructureKeys,
String[] ddmTemplateKeys,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure keys (plural) parameter, a DDM template keys (plural) parameter, and an AND operator switch. |
int |
searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator)
Returns the number of web content articles matching the parameters, including keyword parameters for article ID, title, description, and content, a DDM structure key parameter, a DDM template key parameter, and an AND operator switch. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
subscribeStructure(long groupId,
long userId,
long ddmStructureId)
Subscribes the user to changes in elements that belong to the web content article's DDM structure. |
void |
unsubscribeStructure(long groupId,
long userId,
long ddmStructureId)
Unsubscribes the user from changes in elements that belong to the web content article's DDM structure. |
JournalArticle |
updateArticle(long userId,
long groupId,
long folderId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String layoutUuid,
ServiceContext serviceContext)
Updates the web content article matching the version, replacing its folder, title, description, content, and layout UUID. |
JournalArticle |
updateArticle(long groupId,
long folderId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
String smallImageURL,
File smallFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
Updates the web content article with additional parameters. |
JournalArticle |
updateArticle(long groupId,
long folderId,
String articleId,
double version,
String content,
ServiceContext serviceContext)
Updates the web content article matching the version, replacing its folder and content. |
JournalArticle |
updateArticleTranslation(long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images)
Deprecated. As of 6.2.0, replaced by updateArticleTranslation(long, String, double, Locale,
String, String, String, Map, ServiceContext) |
JournalArticle |
updateArticleTranslation(long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images,
ServiceContext serviceContext)
Updates the translation of the web content article. |
JournalArticle |
updateContent(long groupId,
String articleId,
double version,
String content)
Updates the web content article matching the group, article ID, and version, replacing its content. |
JournalArticle |
updateStatus(long groupId,
String articleId,
double version,
int status,
String articleURL,
ServiceContext serviceContext)
Updates the workflow status of the web content article matching the group, article ID, and version. |
| Method Detail |
|---|
JournalArticle addArticle(long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
String articleURL,
ServiceContext serviceContext)
throws PortalException
groupId - 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 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 IDtitleMap - 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 class description for JournalArticleLocalServiceImpl.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 article is searchablearticleURL - 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, the "urlTitle"
attribute, and workflow actions for the web content article. Can
also set whether to add the default guest and group permissions.
PortalException - if the user did not have permission to add the
web content article or if a portal exception occurred
JournalArticle addArticle(long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
String smallImageURL,
File smallFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
throws PortalException
groupId - 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 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 IDtitleMap - 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 class description for JournalArticleLocalServiceImpl.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 article is searchablesmallImage - whether the web content article has a small imagesmallImageURL - the web content article's small image URLsmallFile - 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, the "urlTitle"
attribute, and workflow actions for the web content article. Can
also set whether to add the default guest and group permissions.
PortalException - if the user did not have permission to add the
web content article or if a portal exception occurred
JournalArticle copyArticle(long groupId,
String oldArticleId,
String newArticleId,
boolean autoArticleId,
double version)
throws PortalException
groupId - 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 version
PortalException - if the user did not have permission to add the
copy the web content article, if a matching web content article
could not be found, or if a portal exception occurred
void deleteArticle(long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
throws PortalException
groupId - 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
portlet preferences that include email information to notify
recipients of the unapproved web content article's denial.
PortalException - if the user did not have permission to delete the
web content article or if a portal exception occurred
void deleteArticle(long groupId,
String articleId,
double version,
String articleURL,
ServiceContext serviceContext)
throws 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.
PortalException - if the user did not have permission to delete the
web content article, if a matching web content article could not
be found, or if a portal exception occurred
void expireArticle(long groupId,
String articleId,
String articleURL,
ServiceContext serviceContext)
throws PortalException
journal.article.expire.all.versions portal property is
true, otherwise expiring only its latest approved version.
groupId - 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.
PortalException - if the user did not have permission to expire the
web content article, if a matching web content article could not
be found, or if a portal exception occurred
JournalArticle expireArticle(long groupId,
String articleId,
double version,
String articleURL,
ServiceContext serviceContext)
throws 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
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.
PortalException - if the user did not have permission to expire the
web content article, if a matching web content article could not
be found, or if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getArticle(long groupId,
String articleId)
throws PortalException
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content article
PortalException - if the user did not have permission to view the
web content article or if a matching web content article could
not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getArticle(long groupId,
String articleId,
double version)
throws 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 version
PortalException - if the user did not have permission to view the
web content article or if a matching web content article could
not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getArticle(long groupId,
String className,
long classPK)
throws 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 otherwiseclassPK - the primary key of the DDM structure, if the the
DDMStructure class name is given as the className
parameter, the primary key of the class associated with the web
content article, or 0 otherwise
PortalException - if a matching web content article could not be
found or if the user did not have permission to view the web
content article
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getArticle(long id)
throws PortalException
id - the primary key of the web content article
PortalException - if a matching web content article could not be
found or if the user did not have permission to view the web
content article
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getArticleByUrlTitle(long groupId,
String urlTitle)
throws PortalException
groupId - the primary key of the web content article's groupurlTitle - the web content article's accessible URL title
PortalException - if the user did not have permission to view the
web content article or if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getArticleContent(long groupId,
String articleId,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws PortalException
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content articlelanguageId - the primary key of the language translation to getportletRequestModel - the portlet request modelthemeDisplay - the theme display
PortalException - if the user did not have permission to view the
web content article, if a matching web content article or DDM
template could not be found, or if a portal exception occurred
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getArticleContent(long groupId,
String articleId,
String languageId,
ThemeDisplay themeDisplay)
throws PortalException
getArticleContent(long,
String, String, PortletRequestModel, ThemeDisplay)
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content articlelanguageId - the primary key of the language translation to getthemeDisplay - the theme display
PortalException - if the user did not have permission to view
the web content article, if a matching web content article or
DDM template could not be found, or if a portal exception
occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getArticleContent(long groupId,
String articleId,
double version,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws 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 translation to getportletRequestModel - the portlet request modelthemeDisplay - the theme display
PortalException - if the user did not have permission to view the
web content article, if a matching web content article or DDM
template could not be found, or if a portal exception occurred
@Deprecated
@Transactional(propagation=SUPPORTS,
readOnly=true)
String getArticleContent(long groupId,
String articleId,
double version,
String languageId,
ThemeDisplay themeDisplay)
throws PortalException
getArticleContent(long,
String, double, 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 versionlanguageId - the primary key of the language translation to getthemeDisplay - the theme display
PortalException - if the user did not have permission to view
the web content article, if a matching web content article or
DDM template could not be found, or if a portal exception
occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 folder
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getArticles(long groupId,
long folderId,
int start,
int end,
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 groupfolderId - the primary key of the web content article 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)obc - the comparator to order the web content articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getArticlesByArticleId(long groupId,
String articleId,
int start,
int end,
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 grouparticleId - the primary key of the web content articlestart - 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 articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getArticlesByLayoutUuid(long groupId,
String layoutUuid)
groupId - the primary key of the web content article's grouplayoutUuid - the unique string identifying the web content
article's display page
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getArticlesByStructureId(long groupId,
long classNameId,
String ddmStructureKey,
int status,
int start,
int end,
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 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 otherwiseddmStructureKey - the primary key of the web content article's DDM
structurestatus - 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)obc - the comparator to order the web content articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getArticlesByStructureId(long groupId,
String ddmStructureKey,
int start,
int end,
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 articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 folder
@Transactional(propagation=SUPPORTS,
readOnly=true)
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.
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getArticlesCountByArticleId(long groupId,
String articleId)
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content article
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getArticlesCountByStructureId(long groupId,
long classNameId,
String ddmStructureKey,
int status)
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 otherwiseddmStructureKey - the primary key of the web content article's DDM
structurestatus - the web content article's workflow status. For more
information see WorkflowConstants for constants starting
with the "STATUS_" prefix.
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getArticlesCountByStructureId(long groupId,
String ddmStructureKey)
groupId - the primary key of the web content article's groupddmStructureKey - the primary key of the web content article's DDM
structure
String getBeanIdentifier()
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getDisplayArticleByUrlTitle(long groupId,
String urlTitle)
throws PortalException
groupId - the primary key of the web content article's groupurlTitle - the web content article's accessible URL title
PortalException - if the user did not have permission to view the
web content article or if no approved matching web content
articles could be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getFoldersAndArticlesCount(long groupId,
List<Long> folderIds)
groupId - the primary key of the web content article's groupfolderIds - the primary keys of the web content article folders
(optionally Collections.EMPTY_LIST)
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getGroupArticles(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
throws 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 web content article's groupuserId - the primary key of the user (optionally 0)rootFolderId - the primary key of the root folder to begin the
searchstart - the lower bound of the range of web content articles to
returnend - the upper bound of the range of web content articles to
return (not inclusive)orderByComparator - the comparator to order the web content
articles
PortalException - if the root folder could not be found, if the
current user did not have permission to view the root folder, or
if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> getGroupArticles(long groupId,
long userId,
long rootFolderId,
int status,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
throws 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 web content article's groupuserId - the primary key of the user (optionally 0)rootFolderId - the primary key of the root folder to begin the
searchstatus - 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)orderByComparator - the comparator to order the web content
articles
PortalException - if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getGroupArticlesCount(long groupId,
long userId,
long rootFolderId)
throws PortalException
groupId - the primary key of the web content article's groupuserId - the primary key of the user (optionally 0)rootFolderId - the primary key of the root folder to begin the
search
PortalException - if the root folder could not be found, if the
current user did not have permission to view the root folder, or
if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int getGroupArticlesCount(long groupId,
long userId,
long rootFolderId,
int status)
throws PortalException
groupId - the primary key of the web content article's groupuserId - the primary key of the user (optionally 0)rootFolderId - the primary key of the root folder to begin the
searchstatus - the web content article's workflow status. For more
information see WorkflowConstants for constants starting
with the "STATUS_" prefix.
PortalException - if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getLatestArticle(long groupId,
String articleId,
int status)
throws 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.
PortalException - if the user did not have permission to view the
web content article or if a matching web content article could
not be found
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getLatestArticle(long groupId,
String className,
long classPK)
throws 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
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 otherwise
PortalException - if a matching web content article could not be
found or if the user did not have permission to view the web
content article
@Transactional(propagation=SUPPORTS,
readOnly=true)
JournalArticle getLatestArticle(long resourcePrimKey)
throws PortalException
resourcePrimKey - the primary key of the resource instance
PortalException - if the user did not have permission to view the
web content article or if a matching web content article could
not be found
void moveArticle(long groupId,
String articleId,
long newFolderId)
throws 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
folder
PortalException - if the user did not have permission to update any
one of the versions of the web content article or if any one of
the versions of the web content article could not be moved to the
folder
JournalArticle moveArticleFromTrash(long groupId,
String articleId,
long newFolderId,
ServiceContext serviceContext)
throws 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
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.
PortalException - if the user did not have permission to view or
update the web content article, if a trashed web content article
with the primary key could not be found, or if a portal exception
occurred
JournalArticle moveArticleFromTrash(long groupId,
long resourcePrimKey,
long newFolderId,
ServiceContext serviceContext)
throws PortalException
groupId - the primary key of the web content article's groupresourcePrimKey - the primary key of the resource instancenewFolderId - 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.
PortalException - if the user did not have permission to view or
update the web content article, if a matching trashed web content
article could not be found, or if a portal exception occurred
JournalArticle moveArticleToTrash(long groupId,
String articleId)
throws PortalException
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content article
null if no matching
article was found
PortalException - if the user did not have permission to move the
article to the Recycle Bin or if a portal exception occurred
void removeArticleLocale(long companyId,
String languageId)
throws PortalException
companyId - the primary key of the web content article's companylanguageId - the primary key of the language locale to remove
PortalException - if the user did not have permission to update any
one of the the web content articles or if web content matching
the language could not be found for any one of the articles
JournalArticle removeArticleLocale(long groupId,
String articleId,
double version,
String languageId)
throws 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 remove
PortalException - if the user did not have permission to update the
web content article or if a matching web content article could
not be found
void restoreArticleFromTrash(long groupId,
String articleId)
throws PortalException
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content article
PortalException - if the web content article with the primary key
could not be found in the Recycle Bin, if the user did not have
permission to restore the article, or if a portal exception
occurred
void restoreArticleFromTrash(long resourcePrimKey)
throws PortalException
resourcePrimKey - the primary key of the resource instance
PortalException - if a matching web content article could not be
found in the Recycle Bin, if the user did not have permission to
view or restore the article, or if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
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 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 articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String[] ddmStructureKeys,
String[] ddmTemplateKeys,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
boolean andOperator,
int start,
int end,
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 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 articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<JournalArticle> search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String keywords,
Double version,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
Date reviewDate,
int start,
int end,
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 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 articles
@Transactional(propagation=SUPPORTS,
readOnly=true)
Hits search(long groupId,
long creatorUserId,
int status,
int start,
int end)
throws 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 web content article's groupcreatorUserId - 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)
PortalException - if a portal exception occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
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 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.
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
Double version,
String title,
String description,
String content,
String[] ddmStructureKeys,
String[] ddmTemplateKeys,
Date displayDateGT,
Date displayDateLT,
int status,
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 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.
@Transactional(propagation=SUPPORTS,
readOnly=true)
int searchCount(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String keywords,
Double version,
String ddmStructureKey,
String ddmTemplateKey,
Date displayDateGT,
Date displayDateLT,
int status,
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 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)
void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
void subscribeStructure(long groupId,
long userId,
long ddmStructureId)
throws 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 to
PortalException - if a matching user or group could not be found
void unsubscribeStructure(long groupId,
long userId,
long ddmStructureId)
throws 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 to
PortalException - if a matching user or subscription could not be
found
JournalArticle updateArticle(long groupId,
long folderId,
String articleId,
double version,
String content,
ServiceContext serviceContext)
throws PortalException
groupId - 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 class description for JournalArticleLocalServiceImpl.serviceContext - the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, workflow actions, the and
"urlTitle" attributes, and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants.UPDATE, the
invocation is considered a web content update activity; otherwise
it is considered a web content add activity.
PortalException - if the user did not have permission to update the
web content article, if a user with the primary key or a matching
web content article could not be found, or if a portal exception
occurred
JournalArticle updateArticle(long groupId,
long folderId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
String layoutUuid,
int displayDateMonth,
int displayDateDay,
int displayDateYear,
int displayDateHour,
int displayDateMinute,
int expirationDateMonth,
int expirationDateDay,
int expirationDateYear,
int expirationDateHour,
int expirationDateMinute,
boolean neverExpire,
int reviewDateMonth,
int reviewDateDay,
int reviewDateYear,
int reviewDateHour,
int reviewDateMinute,
boolean neverReview,
boolean indexable,
boolean smallImage,
String smallImageURL,
File smallFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
throws PortalException
groupId - 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 class description for JournalArticleLocalServiceImpl.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)smallFile - the web content article's new small image file
(optionally null). Must pass in
smallImage value of true to replace the
article's small image file.images - the web content's images (optionally null)articleURL - the web content article's accessible URL (optionally
null)serviceContext - the service context to be applied. Can set the
modification date, expando bridge attributes, asset category IDs,
asset tag names, asset link entry IDs, workflow actions, the and
"urlTitle" attributes, and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants.UPDATE, the
invocation is considered a web content update activity; otherwise
it is considered a web content add activity.
PortalException - if the user did not have permission to update the
web content article, if a user with the primary key or a matching
web content article could not be found, or if a portal exception
occurred
JournalArticle updateArticle(long userId,
long groupId,
long folderId,
String articleId,
double version,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String layoutUuid,
ServiceContext serviceContext)
throws PortalException
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 class description for JournalArticleLocalServiceImpl.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, workflow actions, the and
"urlTitle" attributes, and can set whether to add the default
command update for the web content article. With respect to
social activities, by setting the service context's command to
Constants.UPDATE, the
invocation is considered a web content update activity; otherwise
it is considered a web content add activity.
PortalException - if a user with the primary key or a matching web
content article could not be found, or if a portal exception
occurred
@Deprecated
JournalArticle updateArticleTranslation(long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images)
throws PortalException
updateArticleTranslation(long, String, double, Locale,
String, String, String, Map, ServiceContext)
PortalException
JournalArticle updateArticleTranslation(long groupId,
String articleId,
double version,
Locale locale,
String title,
String description,
String content,
Map<String,byte[]> images,
ServiceContext serviceContext)
throws 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 class description for JournalArticleLocalServiceImpl.images - the web content's imagesserviceContext - the service context to be applied. Can set the
modification date and "urlTitle" attribute for the web content
article.
PortalException - if the user did not have permission to update the
web content article, if a user with the primary key or a matching
web content article could not be found, or if a portal exception
occurred
JournalArticle updateContent(long groupId,
String articleId,
double version,
String content)
throws 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 class description for JournalArticleLocalServiceImpl.
PortalException - if the user did not have permission to update the
web content article or if a matching web content article could
not be found
JournalArticle updateStatus(long groupId,
String articleId,
double version,
int status,
String articleURL,
ServiceContext serviceContext)
throws 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 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 URLserviceContext - 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.
PortalException - if the user did not have permission to update the
web content article, if a matching web content article could not
be found, or if a portal exception occurred
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||