|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.service.BaseLocalServiceImpl
com.liferay.portlet.journal.service.base.JournalArticleLocalServiceBaseImpl
com.liferay.portlet.journal.service.impl.JournalArticleLocalServiceImpl
public class JournalArticleLocalServiceImpl
Provides the local service for accessing, adding, deleting, and updating web content articles.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
JournalArticleLocalServiceImpl()
|
|
| Method Summary | |
|---|---|
JournalArticle |
addArticle(long userId,
long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
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 smallImageFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
Adds a web content article with additional parameters. |
JournalArticle |
addArticle(long userId,
long groupId,
long folderId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
ServiceContext serviceContext)
Adds a web content article. |
void |
addArticleResources(JournalArticle article,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the web content article. |
void |
addArticleResources(JournalArticle article,
String[] groupPermissions,
String[] guestPermissions)
Adds the model resources with the permissions to the web content article. |
void |
addArticleResources(long groupId,
String articleId,
boolean addGroupPermissions,
boolean addGuestPermissions)
Adds the resources to the most recently created web content article. |
void |
addArticleResources(long groupId,
String articleId,
String[] groupPermissions,
String[] guestPermissions)
Adds the resources with the permissions to the most recently created web content article. |
protected String |
buildArticleURL(String articleURL,
long groupId,
long folderId,
String articleId)
|
protected SearchContext |
buildSearchContext(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
|
protected SearchContext |
buildSearchContext(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end)
|
JournalArticle |
checkArticleResourcePrimKey(long groupId,
String articleId,
double version)
Returns the web content article with the group, article ID, and version. |
void |
checkArticles()
Checks all web content articles by handling their expirations and sending review notifications based on their current workflow. |
protected void |
checkArticlesByDisplayDate(Date displayDate)
|
protected void |
checkArticlesByExpirationDate(Date expirationDate)
|
protected void |
checkArticlesByReviewDate(Date reviewDate)
|
void |
checkNewLine(long groupId,
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. |
protected void |
checkStructure(Document contentDocument,
DDMForm ddmForm)
|
protected void |
checkStructure(JournalArticle article)
|
protected void |
checkStructure(JournalArticle article,
DDMStructure ddmStructure)
|
void |
checkStructure(long groupId,
String articleId,
double version)
Checks the web content article matching the group, article ID, and version for an associated structure. |
protected void |
checkStructureField(DDMFormField ddmFormField,
Element contentElement)
|
JournalArticle |
copyArticle(long userId,
long groupId,
String oldArticleId,
String newArticleId,
boolean autoArticleId,
double version)
Copies the web content article matching the group, article ID, and version. |
protected void |
copyArticleImages(JournalArticle oldArticle,
JournalArticle newArticle)
|
protected Map<String,String> |
createFieldsValuesMap(Element parentElement)
|
protected Map<String,String> |
createFieldsValuesMap(String content)
|
JournalArticle |
deleteArticle(JournalArticle article)
Deletes the web content article and its resources. |
JournalArticle |
deleteArticle(JournalArticle article,
String articleURL,
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. |
JournalArticle |
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,
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. |
void |
deleteArticles(long groupId)
Deletes all the group's web content articles and resources. |
void |
deleteArticles(long groupId,
long folderId)
Deletes all the group's web content articles and resources in the folder, including recycled articles. |
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. |
void |
deleteLayoutArticleReferences(long groupId,
String layoutUuid)
Deletes the layout's association with the web content articles for the group. |
JournalArticle |
expireArticle(long userId,
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 userId,
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 |
fetchArticle(long groupId,
String articleId)
|
JournalArticle |
fetchArticle(long groupId,
String articleId,
double version)
Returns the web content article matching the group, article ID, and version. |
JournalArticle |
fetchArticleByUrlTitle(long groupId,
String urlTitle)
|
JournalArticle |
fetchDisplayArticle(long groupId,
String articleId)
|
JournalArticle |
fetchLatestArticle(long resourcePrimKey)
|
JournalArticle |
fetchLatestArticle(long resourcePrimKey,
int status)
|
JournalArticle |
fetchLatestArticle(long resourcePrimKey,
int[] statuses)
|
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. |
JournalArticle |
fetchLatestArticle(long groupId,
String articleId,
int status)
Returns the latest web content article matching the group, article ID, and workflow status. |
JournalArticle |
fetchLatestArticleByUrlTitle(long groupId,
String urlTitle,
int status)
|
JournalArticle |
fetchLatestIndexableArticle(long resourcePrimKey)
Returns the latest indexable web content article matching the resource primary key. |
protected void |
format(User user,
long groupId,
String articleId,
double version,
boolean incrementVersion,
Element root,
Map<String,byte[]> images)
|
protected String |
format(User user,
long groupId,
String articleId,
double version,
boolean incrementVersion,
String content,
Map<String,byte[]> images)
|
protected void |
formatDocumentLibrary(Element dynamicElementElement)
|
protected void |
formatImage(long groupId,
String articleId,
double version,
boolean incrementVersion,
Element el,
String elInstanceId,
String elName,
Map<String,byte[]> images)
|
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(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
Returns the web content from the web content article associated with the portlet request model and the DDM template. |
String |
getArticleContent(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(JournalArticle, String, String, String,
PortletRequestModel,ThemeDisplay) |
String |
getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String ddmTemplateKey,
String languageId,
PortletRequestModel portletRequestModel,
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. |
String |
getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String ddmTemplateKey,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay) |
String |
getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, double, String, String, String, PortletRequestModel,
ThemeDisplay) |
String |
getArticleContent(long groupId,
String articleId,
String viewMode,
String ddmTemplateKey,
String languageId,
PortletRequestModel portletRequestModel,
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. |
String |
getArticleContent(long groupId,
String articleId,
String viewMode,
String ddmTemplateKey,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay) |
String |
getArticleContent(long groupId,
String articleId,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
Deprecated. As of 7.0.0, replaced by getArticleContent(long,
String, String, String, String, PortletRequestModel,
ThemeDisplay) |
protected Locale |
getArticleDefaultLocale(String content)
|
JournalArticleDisplay |
getArticleDisplay(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
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. |
protected JournalArticleDisplay |
getArticleDisplay(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay,
boolean propagateException)
|
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
double version,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
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. |
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
double version,
String ddmTemplateKey,
String viewMode,
String languageId,
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. |
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
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. |
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
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. |
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
String ddmTemplateKey,
String viewMode,
String languageId,
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. |
JournalArticleDisplay |
getArticleDisplay(long groupId,
String articleId,
String viewMode,
String languageId,
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. |
List<JournalArticle> |
getArticles()
Returns all the web content articles present in the system. |
List<JournalArticle> |
getArticles(long groupId)
Returns all the web content articles belonging to the group. |
List<JournalArticle> |
getArticles(long groupId,
int start,
int end)
Returns a range of all the web content articles belonging to the group. |
List<JournalArticle> |
getArticles(long groupId,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles belonging to the group. |
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)
Returns a range of all the web content articles matching the group and folder. |
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. |
List<JournalArticle> |
getArticles(long groupId,
long folderId,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
Returns an ordered range of all the web content articles matching the group and folder. |
List<JournalArticle> |
getArticles(long groupId,
String articleId)
Returns all the web content articles matching the group and article ID. |
List<JournalArticle> |
getArticles(long groupId,
String articleId,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
|
List<JournalArticle> |
getArticlesByResourcePrimKey(long resourcePrimKey)
Returns all the web content articles matching the resource primary key. |
List<JournalArticle> |
getArticlesBySmallImageId(long smallImageId)
Returns all the web content articles matching the small image ID. |
int |
getArticlesCount(long groupId)
Returns the number of web content articles belonging to the group. |
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 |
getArticlesCount(long groupId,
String articleId)
|
protected List<ObjectValuePair<Long,Integer>> |
getArticleVersionStatuses(List<JournalArticle> articles)
|
protected long |
getClassTypeId(JournalArticle article)
|
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. |
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. |
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. |
int |
getCompanyArticlesCount(long companyId,
int status)
Returns the number of web content articles matching the company and workflow status. |
JournalArticle |
getDisplayArticle(long groupId,
String articleId)
Returns the matching web content article currently displayed or next to be displayed if no article is currently displayed. |
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. |
protected JournalArticle |
getFirstArticle(long groupId,
String articleId,
int status,
OrderByComparator<JournalArticle> orderByComparator)
|
List<JournalArticle> |
getIndexableArticlesByDDMStructureKey(String[] ddmStructureKeys)
|
List<JournalArticle> |
getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
Returns the indexable web content articles matching the resource primary key. |
JournalArticle |
getLatestArticle(long resourcePrimKey)
Returns the latest web content article matching the resource primary key, preferring articles with approved workflow status. |
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. |
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. |
JournalArticle |
getLatestArticle(long groupId,
String articleId)
Returns the latest web content article with the group and article ID. |
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. |
JournalArticle |
getLatestArticleByUrlTitle(long groupId,
String urlTitle,
int status)
Returns the latest web content article matching the group, URL title, and workflow status. |
double |
getLatestVersion(long groupId,
String articleId)
Returns the latest version number of the web content with the group and article ID. |
double |
getLatestVersion(long groupId,
String articleId,
int status)
Returns the latest version number of the web content with the group, article ID, and workflow status. |
List<JournalArticle> |
getNoAssetArticles()
|
List<JournalArticle> |
getNoPermissionArticles()
|
int |
getNotInTrashArticlesCount(long groupId,
long folderId)
Returns the number of web content articles that are not recycled. |
JournalArticle |
getOldestArticle(long groupId,
String articleId)
Returns the oldest web content article with the group and article ID. |
JournalArticle |
getOldestArticle(long groupId,
String articleId,
int status)
Returns the oldest web content article matching the group, article ID, and workflow status. |
JournalArticle |
getPreviousApprovedArticle(JournalArticle article)
Returns the previously approved version of the web content article. |
List<JournalArticle> |
getStructureArticles(long groupId,
String ddmStructureKey)
Returns the web content articles matching the group and DDM structure key. |
List<JournalArticle> |
getStructureArticles(long groupId,
String ddmStructureKey,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group and DDM structure key. |
List<JournalArticle> |
getStructureArticles(String[] ddmStructureKeys)
Returns the web content articles matching the DDM structure keys. |
int |
getStructureArticlesCount(long groupId,
String ddmStructureKey)
Returns the number of web content articles matching the group and DDM structure key. |
List<JournalArticle> |
getTemplateArticles(long groupId,
String ddmTemplateKey)
Returns the web content articles matching the group and DDM template key. |
List<JournalArticle> |
getTemplateArticles(long groupId,
String ddmTemplateKey,
int start,
int end,
OrderByComparator<JournalArticle> obc)
Returns an ordered range of all the web content articles matching the group and DDM template key. |
int |
getTemplateArticlesCount(long groupId,
String ddmTemplateKey)
Returns the number of web content articles matching the group and DDM template key. |
protected String |
getUniqueUrlTitle(long id,
long groupId,
String articleId,
String title)
|
protected String |
getUniqueUrlTitle(long id,
long groupId,
String articleId,
String title,
String oldUrlTitle,
ServiceContext serviceContext)
|
String |
getUniqueUrlTitle(long groupId,
String articleId,
String urlTitle)
Returns the web content article's unique URL title. |
boolean |
hasArticle(long groupId,
String articleId)
Returns true if the specified web content article exists. |
protected boolean |
hasModifiedLatestApprovedVersion(long groupId,
String articleId,
double version)
|
boolean |
isLatestVersion(long groupId,
String articleId,
double version)
Returns true if the web content article, specified by group
and article ID, is the latest version. |
boolean |
isLatestVersion(long groupId,
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. |
boolean |
isRenderable(JournalArticle article,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
|
JournalArticle |
moveArticle(long groupId,
String articleId,
long newFolderId)
Deprecated. As of 7.0.0, replaced by moveArticle(long, String,
long, ServiceContext) |
JournalArticle |
moveArticle(long groupId,
String articleId,
long newFolderId,
ServiceContext serviceContext)
Moves the web content article matching the group and article ID to a new folder. |
JournalArticle |
moveArticleFromTrash(long userId,
long groupId,
JournalArticle article,
long newFolderId,
ServiceContext serviceContext)
Moves the web content article from the Recycle Bin to a new folder. |
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. |
JournalArticle |
moveArticleToTrash(long userId,
long groupId,
String articleId)
Moves the latest version of the web content article matching the group and article ID to the recycle bin. |
protected void |
notifySubscribers(long userId,
JournalArticle article,
String articleURL,
String action,
ServiceContext serviceContext)
|
void |
rebuildTree(long companyId)
Rebuilds the web content article's tree path using tree traversal. |
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. |
JournalArticle |
restoreArticleFromTrash(long userId,
JournalArticle article)
Restores the web content article from the Recycle Bin. |
protected void |
saveImages(boolean smallImage,
long smallImageId,
File smallImageFile,
byte[] smallImageBytes)
|
List<JournalArticle> |
search(long groupId,
List<Long> folderIds,
int status,
int start,
int end)
Returns a range of all the web content articles matching the parameters without using the indexer. |
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. |
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 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. |
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 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. |
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 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. |
Hits |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String ddmStructureKey,
String ddmTemplateKey,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
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. |
Hits |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
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. |
Hits |
search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
String type,
String statusString,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
Deprecated. As of 7.0.0, replaced by search(long, long, List,
long, String, String, String, String, int, String, String,
LinkedHashMap, boolean, int, int, Sort) |
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. |
int |
searchCount(long groupId,
List<Long> folderIds,
int status)
Returns the number of web content articles matching the group, folders, and status. |
int |
searchCount(long groupId,
long folderId,
int status)
Returns the number of web content articles matching the group, folder, and status. |
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. |
BaseModelSearchResult<JournalArticle> |
searchJournalArticles(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String ddmStructureKey,
String ddmTemplateKey,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
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. |
BaseModelSearchResult<JournalArticle> |
searchJournalArticles(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
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. |
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. |
protected BaseModelSearchResult<JournalArticle> |
searchJournalArticles(SearchContext searchContext)
|
protected void |
sendEmail(JournalArticle article,
String articleURL,
PortletPreferences preferences,
String emailType,
ServiceContext serviceContext)
|
void |
setTreePaths(long folderId,
String treePath,
boolean reindex)
|
protected void |
startWorkflowInstance(long userId,
JournalArticle article,
ServiceContext serviceContext)
|
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 userId,
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 smallImageFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
Updates the web content article with additional parameters. |
JournalArticle |
updateArticle(long userId,
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. |
void |
updateAsset(long userId,
JournalArticle article,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
Updates the web content article's asset with the new asset categories, tag names, and link entries, removing and adding them as necessary. |
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. |
protected void |
updateDDMFormFieldPredefinedValue(DDMFormField ddmFormField,
String ddmFormFieldValue)
|
protected void |
updateDDMLinks(long id,
long groupId,
String ddmStructureKey,
String ddmTemplateKey,
boolean incrementVersion)
|
protected void |
updateDDMStructurePredefinedValues(long ddmStructureId,
String content,
ServiceContext serviceContext)
|
void |
updateDDMTemplateKey(long groupId,
long classNameId,
String oldDDMTemplateKey,
String newDDMTemplateKey)
Updates the web content articles matching the group, class name ID, and DDM template key, replacing the DDM template key with a new one. |
protected void |
updatePreviousApprovedArticle(JournalArticle article)
|
JournalArticle |
updateStatus(long userId,
JournalArticle article,
int status,
String articleURL,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext)
Updates the workflow status of the web content article. |
JournalArticle |
updateStatus(long userId,
long classPK,
int status,
Map<String,Serializable> workflowContext,
ServiceContext serviceContext)
Updates the workflow status of the web content article matching the class PK. |
JournalArticle |
updateStatus(long userId,
long groupId,
String articleId,
double version,
int status,
String articleURL,
Map<String,Serializable> workflowContext,
ServiceContext serviceContext)
Updates the workflow status of the web content article matching the group, article ID, and version. |
void |
updateTemplateId(long groupId,
long classNameId,
String oldDDMTemplateKey,
String newDDMTemplateKey)
Deprecated. As of 7.0.0, replaced by updateDDMTemplateKey(long, long, java.lang.String, java.lang.String) |
protected void |
updateUrlTitles(long groupId,
String articleId,
String urlTitle)
|
protected void |
validate(long companyId,
long groupId,
long classNameId,
Map<Locale,String> titleMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date expirationDate,
boolean smallImage,
String smallImageURL,
File smallImageFile,
byte[] smallImageBytes,
ServiceContext serviceContext)
|
protected void |
validate(long companyId,
long groupId,
long classNameId,
String articleId,
boolean autoArticleId,
double version,
Map<Locale,String> titleMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date expirationDate,
boolean smallImage,
String smallImageURL,
File smallImageFile,
byte[] smallImageBytes,
ServiceContext serviceContext)
|
protected void |
validate(String articleId)
|
protected void |
validateContent(String content)
|
protected void |
validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
Fields fields)
|
protected void |
validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
ServiceContext serviceContext)
|
protected void |
validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
String content)
|
protected void |
validateDDMStructureId(long groupId,
long folderId,
String ddmStructureKey)
|
| Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
|---|
getClassLoader, getLocalizationMap |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public JournalArticleLocalServiceImpl()
| Method Detail |
|---|
@Indexable(type=REINDEX)
public JournalArticle addArticle(long userId,
long groupId,
long folderId,
long classNameId,
long classPK,
String articleId,
boolean autoArticleId,
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 smallImageFile,
Map<String,byte[]> images,
String articleURL,
ServiceContext serviceContext)
throws 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 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.
PortalException - if a portal exception occurred
public JournalArticle addArticle(long userId,
long groupId,
long folderId,
Map<Locale,String> titleMap,
Map<Locale,String> descriptionMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
ServiceContext serviceContext)
throws 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, URL title, and
workflow actions for the web content article. Can also set
whether to add the default guest and group permissions.
PortalException - if a portal exception occurred
public void addArticleResources(JournalArticle article,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException
article - the web content articleaddGroupPermissions - whether to add group permissionsaddGuestPermissions - whether to add guest permissions
PortalException - if no portal actions could be found associated
with the web content article or if a portal exception occurred
public void addArticleResources(JournalArticle article,
String[] groupPermissions,
String[] guestPermissions)
throws PortalException
article - the web content article to add resources togroupPermissions - the group permissions to be addedguestPermissions - the guest permissions to be added
PortalException - if a portal exception occurred
public void addArticleResources(long groupId,
String articleId,
boolean addGroupPermissions,
boolean addGuestPermissions)
throws 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 permissions
PortalException - if a portal exception occurred
public void addArticleResources(long groupId,
String articleId,
String[] groupPermissions,
String[] guestPermissions)
throws 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 added
PortalException - if a portal exception occurred
public JournalArticle checkArticleResourcePrimKey(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 a matching web content article could not be
found
public void checkArticles()
throws PortalException
PortalException - if a portal exception occurred
public void checkNewLine(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 a matching web content article could not be
found
public void checkStructure(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 a matching web content article could not be
found, if the article's structure does not match it, or if a
portal exception occurred
@Indexable(type=REINDEX)
public JournalArticle copyArticle(long userId,
long groupId,
String oldArticleId,
String newArticleId,
boolean autoArticleId,
double version)
throws 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 version
PortalException - if a matching web content article could not be
found or if a portal exception occurred
@SystemEvent(action=1,
send=false,
type=1)
public JournalArticle deleteArticle(JournalArticle article)
throws PortalException
article - the web content article
PortalException - if a portal exception occurred
@Indexable(type=DELETE)
@SystemEvent(action=1,
send=false,
type=1)
public JournalArticle deleteArticle(JournalArticle article,
String articleURL,
ServiceContext serviceContext)
throws 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.
PortalException - if a portal exception occurred
public JournalArticle 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 a matching web content article could not be
found or if a portal exception occurred
public void deleteArticle(long groupId,
String articleId,
ServiceContext serviceContext)
throws 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.
PortalException - if a portal exception occurred
public void deleteArticles(long groupId)
throws PortalException
groupId - the primary key of the web content article's group
PortalException - if a portal exception occurred
public void deleteArticles(long groupId,
long folderId)
throws PortalException
groupId - the primary key of the web content article's groupfolderId - the primary key of the web content article folder
PortalException - if a portal exception occurred
public void deleteArticles(long groupId,
long folderId,
boolean includeTrashedEntries)
throws 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
articles
PortalException - if a portal exception occurred
public void deleteLayoutArticleReferences(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
@Indexable(type=REINDEX)
public JournalArticle expireArticle(long userId,
long groupId,
String articleId,
double version,
String articleURL,
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 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 a matching web content article could not be
found or if a portal exception occurred
public void expireArticle(long userId,
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.
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.
PortalException - if a matching web content article could not be
found or if a portal exception occurred
public JournalArticle fetchArticle(long groupId,
String articleId)
public JournalArticle fetchArticle(long groupId,
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 version
null if no web content article could be
found
public JournalArticle fetchArticleByUrlTitle(long groupId,
String urlTitle)
public JournalArticle fetchDisplayArticle(long groupId,
String articleId)
public JournalArticle fetchLatestArticle(long resourcePrimKey)
public JournalArticle fetchLatestArticle(long resourcePrimKey,
int status)
public 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 status
null if no matching web
content article could be found
public JournalArticle fetchLatestArticle(long resourcePrimKey,
int[] statuses)
public JournalArticle fetchLatestArticle(long groupId,
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 found
public JournalArticle fetchLatestArticleByUrlTitle(long groupId,
String urlTitle,
int status)
public JournalArticle fetchLatestIndexableArticle(long resourcePrimKey)
resourcePrimKey - the primary key of the resource instance
null if no matching web content
article could be found
public 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
public 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 a matching web content article could not be
found
public 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 a matching web content article could not be
found
public 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
public 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 a portal exception occurred
public String getArticleContent(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching DDM template could not be found, or
if a portal exception occurred
@Deprecated
public String getArticleContent(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching DDM template could not be
found, or if a portal exception occurred
public String getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String ddmTemplateKey,
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 versionviewMode - the mode in which the web content is being viewedddmTemplateKey - the primary key of the web content article's DDM
templatelanguageId - the primary key of the language translation to getportletRequestModel - the portlet request modelthemeDisplay - the theme display
PortalException - if a matching web content article or DDM template
could not be found, or if a portal exception occurred
@Deprecated
public String getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String ddmTemplateKey,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching web content article or DDM
template could not be found, or if a portal exception
occurred
@Deprecated
public String getArticleContent(long groupId,
String articleId,
double version,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching web content article or DDM
template could not be found, or if a portal exception
occurred
public String getArticleContent(long groupId,
String articleId,
String viewMode,
String ddmTemplateKey,
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 articleviewMode - the mode in which the web content is being viewedddmTemplateKey - the primary key of the web content article's DDM
templatelanguageId - the primary key of the language translation to getportletRequestModel - the portlet request modelthemeDisplay - the theme display
PortalException - if a matching web content article or DDM template
could not be found, or if a portal exception occurred
@Deprecated
public String getArticleContent(long groupId,
String articleId,
String viewMode,
String ddmTemplateKey,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching web content article or DDM
template could not be found, or if a portal exception
occurred
@Deprecated
public String getArticleContent(long groupId,
String articleId,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
PortalException - if a matching web content article or DDM
template could not be found, or if a portal exception
occurred
public JournalArticleDisplay getArticleDisplay(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
double version,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
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 versionddmTemplateKey - the primary key of the web content article's DDM
templateviewMode - the mode in which the web content is being viewedlanguageId - the primary key of the language translation to getpage - the web content article page to displayportletRequestModel - the portlet request modelthemeDisplay - the theme display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
double version,
String ddmTemplateKey,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a matching web content article or DDM template
could not be found, or if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
String ddmTemplateKey,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a matching web content article or DDM template
could not be found, or if a portal exception occurred
public JournalArticleDisplay getArticleDisplay(long groupId,
String articleId,
String viewMode,
String languageId,
ThemeDisplay themeDisplay)
throws 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 display
null if the
article has expired or if article's display date/time is after
the current date/time
PortalException - if a matching web content article or DDM template
could not be found, or if a portal exception occurredpublic List<JournalArticle> getArticles()
public List<JournalArticle> getArticles(long groupId)
groupId - the primary key of the web content article's group
public 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 List<JournalArticle> getArticles(long groupId,
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 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 articles
public 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
public 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 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 List<JournalArticle> getArticles(long groupId,
long folderId,
int start,
int end,
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
articles
public List<JournalArticle> getArticles(long groupId,
String articleId)
groupId - the primary key of the web content article's grouparticleId - the primary key of the web content article
public List<JournalArticle> getArticles(long groupId,
String articleId,
int start,
int end,
OrderByComparator<JournalArticle> orderByComparator)
public List<JournalArticle> getArticlesByResourcePrimKey(long resourcePrimKey)
resourcePrimKey - the primary key of the resource instance
public List<JournalArticle> getArticlesBySmallImageId(long smallImageId)
smallImageId - the primary key of the web content article's small
image
public int getArticlesCount(long groupId)
groupId - the primary key of the web content article's group
public 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 folder
public 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 int getArticlesCount(long groupId,
String articleId)
public 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 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 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 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 JournalArticle getDisplayArticle(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 no approved matching web content articles
could be found
public 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 no approved matching web content articles
could be foundpublic List<JournalArticle> getIndexableArticlesByDDMStructureKey(String[] ddmStructureKeys)
public List<JournalArticle> getIndexableArticlesByResourcePrimKey(long resourcePrimKey)
resourcePrimKey - the primary key of the resource instance
public JournalArticle getLatestArticle(long resourcePrimKey)
throws PortalException
resourcePrimKey - the primary key of the resource instance
PortalException - if a matching web content article could not be
found
public JournalArticle getLatestArticle(long resourcePrimKey,
int status)
throws 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.
PortalException - if a matching web content article could not be
found
public JournalArticle getLatestArticle(long resourcePrimKey,
int status,
boolean preferApproved)
throws 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 status
PortalException - if a matching web content article could not be
found
public JournalArticle getLatestArticle(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 a matching web content article could not be
found
public 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 a matching web content article could not be
found
public 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
public JournalArticle getLatestArticleByUrlTitle(long groupId,
String urlTitle,
int status)
throws 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.
PortalException - if a matching web content article could not be
found
public double getLatestVersion(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 a matching web content article could not be
found
public double getLatestVersion(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 a matching web content article could not be
foundpublic List<JournalArticle> getNoAssetArticles()
public List<JournalArticle> getNoPermissionArticles()
public 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 folder
public JournalArticle getOldestArticle(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 a matching web content article could not be
found
public JournalArticle getOldestArticle(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 a matching web content article could not be
foundpublic JournalArticle getPreviousApprovedArticle(JournalArticle article)
WorkflowConstants.STATUS_APPROVED.
article - the web content article
public List<JournalArticle> getStructureArticles(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
public List<JournalArticle> getStructureArticles(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
public List<JournalArticle> getStructureArticles(String[] ddmStructureKeys)
ddmStructureKeys - the primary keys of the web content article's
DDM structures
public int getStructureArticlesCount(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
public List<JournalArticle> getTemplateArticles(long groupId,
String ddmTemplateKey)
groupId - the primary key of the web content article's groupddmTemplateKey - the primary key of the web content article's DDM
template
public List<JournalArticle> getTemplateArticles(long groupId,
String ddmTemplateKey,
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 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 articles
public int getTemplateArticlesCount(long groupId,
String ddmTemplateKey)
groupId - the primary key of the web content article's groupddmTemplateKey - the primary key of the web content article's DDM
template
public String getUniqueUrlTitle(long groupId,
String articleId,
String urlTitle)
throws 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 title
PortalException - if a portal exception occurred
public boolean hasArticle(long groupId,
String articleId)
true if the specified web content article exists.
groupId - the primary key of the grouparticleId - the primary key of the web content article
true if the specified web content article exists;
false otherwise
public boolean isLatestVersion(long groupId,
String articleId,
double version)
throws 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 version
true if the specified web content article is the
latest version; false otherwise
PortalException - if a matching web content article could not be
found
public boolean isLatestVersion(long groupId,
String articleId,
double version,
int status)
throws 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 otherwise
PortalException - if a matching web content article could not be
found
public boolean isRenderable(JournalArticle article,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay)
@Deprecated
@Indexable(type=REINDEX)
public JournalArticle moveArticle(long groupId,
String articleId,
long newFolderId)
throws 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
folder
PortalException - if a matching web content article could not
be found
@Indexable(type=REINDEX)
public JournalArticle moveArticle(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
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.
PortalException - if a matching web content article could not be
found
@Indexable(type=REINDEX)
public JournalArticle moveArticleFromTrash(long userId,
long groupId,
JournalArticle article,
long newFolderId,
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 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.
PortalException - if a trashed web content article with the primary
key could not be found or if a portal exception occurred
@Indexable(type=REINDEX)
public JournalArticle moveArticleToTrash(long userId,
JournalArticle article)
throws PortalException
userId - the primary key of the user updating the web content
articlearticle - the web content article
PortalException - if the user did not have permission to move the
article to the Recycle Bin or if a portal exception occurred
public JournalArticle moveArticleToTrash(long userId,
long groupId,
String articleId)
throws 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 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
public void rebuildTree(long companyId)
throws 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 company
PortalException - if a portal exception occurred
@Indexable(type=REINDEX)
public 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 a matching web content article could not be
found
@Indexable(type=REINDEX)
public JournalArticle restoreArticleFromTrash(long userId,
JournalArticle article)
throws PortalException
userId - the primary key of the user restoring the web content
articlearticle - 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
public List<JournalArticle> search(long groupId,
List<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 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 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)
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 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
public 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)
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 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
public 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
public Hits search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String ddmStructureKey,
String ddmTemplateKey,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
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 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 Hits search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
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 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 Hits search(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
String type,
String statusString,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
search(long, long, List,
long, String, String, String, String, int, String, String,
LinkedHashMap, boolean, int, int, Sort)
public Hits search(long groupId,
long userId,
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 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)
PortalException - if a portal exception occurred
public int searchCount(long groupId,
List<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 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 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)
public 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.
public 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.
public BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String ddmStructureKey,
String ddmTemplateKey,
String keywords,
LinkedHashMap<String,Object> params,
int start,
int end,
Sort sort)
throws 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 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
PortalException - if a portal exception occurred
public BaseModelSearchResult<JournalArticle> searchJournalArticles(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
throws 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 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
PortalException - if a portal exception occurred
public BaseModelSearchResult<JournalArticle> searchJournalArticles(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end)
throws 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
PortalException - if a portal exception occurred
public void setTreePaths(long folderId,
String treePath,
boolean reindex)
throws PortalException
PortalException
public 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
public 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
public 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 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, 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.
PortalException - if a user with the primary key or a matching web
content article could not be found, or if a portal exception
occurred
@Indexable(type=REINDEX)
public JournalArticle updateArticle(long userId,
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 smallImageFile,
Map<String,byte[]> images,
String articleURL,
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 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, 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.
PortalException - if a user with the primary key or a matching web
content article could not be found, or if a portal exception
occurred
public JournalArticle updateArticle(long userId,
long groupId,
long folderId,
String articleId,
double version,
String content,
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 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, 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.
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
public 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
@Indexable(type=REINDEX)
public 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 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.
PortalException - if a user with the primary key or a matching web
content article could not be found, or if a portal exception
occurred
public void updateAsset(long userId,
JournalArticle article,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
throws 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 entries
PortalException - if a portal exception occurred
@Indexable(type=REINDEX)
public 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 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.
PortalException - if a matching web content article could not be
found
public void updateDDMTemplateKey(long groupId,
long classNameId,
String oldDDMTemplateKey,
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 otherwiseoldDDMTemplateKey - the primary key of the web content article's old
DDM templatenewDDMTemplateKey - the primary key of the web content article's new
DDM template
@Indexable(type=REINDEX)
public JournalArticle updateStatus(long userId,
JournalArticle article,
int status,
String articleURL,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext)
throws 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
context
PortalException - if a portal exception occurred
public JournalArticle updateStatus(long userId,
long classPK,
int status,
Map<String,Serializable> workflowContext,
ServiceContext serviceContext)
throws 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.
PortalException - if a matching web content article could not be
found or if a portal exception occurred
public JournalArticle updateStatus(long userId,
long groupId,
String articleId,
double version,
int status,
String articleURL,
Map<String,Serializable> workflowContext,
ServiceContext serviceContext)
throws 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.
PortalException - if a matching web content article could not be
found or if a portal exception occurred
@Deprecated
public void updateTemplateId(long groupId,
long classNameId,
String oldDDMTemplateKey,
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
otherwiseoldDDMTemplateKey - the primary key of the web content
article's old DDM templatenewDDMTemplateKey - the primary key of the web content
article's new DDM template
protected String buildArticleURL(String articleURL,
long groupId,
long folderId,
String articleId)
protected SearchContext buildSearchContext(long companyId,
long groupId,
List<Long> folderIds,
long classNameId,
String articleId,
String title,
String description,
String content,
int status,
String ddmStructureKey,
String ddmTemplateKey,
LinkedHashMap<String,Object> params,
boolean andSearch,
int start,
int end,
Sort sort)
protected SearchContext buildSearchContext(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end)
throws PortalException
PortalException
protected void checkArticlesByDisplayDate(Date displayDate)
throws PortalException
PortalException
protected void checkArticlesByExpirationDate(Date expirationDate)
throws PortalException
PortalException
protected void checkArticlesByReviewDate(Date reviewDate)
throws PortalException
PortalException
protected void checkStructure(Document contentDocument,
DDMForm ddmForm)
throws PortalException
PortalException
protected void checkStructure(JournalArticle article)
throws PortalException
PortalException
protected void checkStructure(JournalArticle article,
DDMStructure ddmStructure)
throws PortalException
PortalException
protected void checkStructureField(DDMFormField ddmFormField,
Element contentElement)
throws PortalException
PortalException
protected void copyArticleImages(JournalArticle oldArticle,
JournalArticle newArticle)
throws Exception
Exceptionprotected Map<String,String> createFieldsValuesMap(Element parentElement)
protected Map<String,String> createFieldsValuesMap(String content)
protected void format(User user,
long groupId,
String articleId,
double version,
boolean incrementVersion,
Element root,
Map<String,byte[]> images)
throws PortalException
PortalException
protected String format(User user,
long groupId,
String articleId,
double version,
boolean incrementVersion,
String content,
Map<String,byte[]> images)
throws PortalException
PortalException
protected void formatDocumentLibrary(Element dynamicElementElement)
throws PortalException
PortalException
protected void formatImage(long groupId,
String articleId,
double version,
boolean incrementVersion,
Element el,
String elInstanceId,
String elName,
Map<String,byte[]> images)
throws PortalException
PortalExceptionprotected Locale getArticleDefaultLocale(String content)
protected JournalArticleDisplay getArticleDisplay(JournalArticle article,
String ddmTemplateKey,
String viewMode,
String languageId,
int page,
PortletRequestModel portletRequestModel,
ThemeDisplay themeDisplay,
boolean propagateException)
throws PortalException
PortalExceptionprotected List<ObjectValuePair<Long,Integer>> getArticleVersionStatuses(List<JournalArticle> articles)
protected long getClassTypeId(JournalArticle article)
throws PortalException
PortalException
protected JournalArticle getFirstArticle(long groupId,
String articleId,
int status,
OrderByComparator<JournalArticle> orderByComparator)
throws PortalException
PortalException
protected String getUniqueUrlTitle(long id,
long groupId,
String articleId,
String title)
throws PortalException
PortalException
protected String getUniqueUrlTitle(long id,
long groupId,
String articleId,
String title,
String oldUrlTitle,
ServiceContext serviceContext)
throws PortalException
PortalException
protected boolean hasModifiedLatestApprovedVersion(long groupId,
String articleId,
double version)
protected void notifySubscribers(long userId,
JournalArticle article,
String articleURL,
String action,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void saveImages(boolean smallImage,
long smallImageId,
File smallImageFile,
byte[] smallImageBytes)
throws PortalException
PortalException
protected BaseModelSearchResult<JournalArticle> searchJournalArticles(SearchContext searchContext)
throws PortalException
PortalException
protected void sendEmail(JournalArticle article,
String articleURL,
PortletPreferences preferences,
String emailType,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void startWorkflowInstance(long userId,
JournalArticle article,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void updateDDMFormFieldPredefinedValue(DDMFormField ddmFormField,
String ddmFormFieldValue)
protected void updateDDMLinks(long id,
long groupId,
String ddmStructureKey,
String ddmTemplateKey,
boolean incrementVersion)
throws PortalException
PortalException
protected void updateDDMStructurePredefinedValues(long ddmStructureId,
String content,
ServiceContext serviceContext)
protected void updatePreviousApprovedArticle(JournalArticle article)
throws PortalException
PortalException
protected void updateUrlTitles(long groupId,
String articleId,
String urlTitle)
throws PortalException
PortalException
protected void validate(long companyId,
long groupId,
long classNameId,
Map<Locale,String> titleMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date expirationDate,
boolean smallImage,
String smallImageURL,
File smallImageFile,
byte[] smallImageBytes,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void validate(long companyId,
long groupId,
long classNameId,
String articleId,
boolean autoArticleId,
double version,
Map<Locale,String> titleMap,
String content,
String ddmStructureKey,
String ddmTemplateKey,
Date expirationDate,
boolean smallImage,
String smallImageURL,
File smallImageFile,
byte[] smallImageBytes,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void validate(String articleId)
throws PortalException
PortalException
protected void validateContent(String content)
throws PortalException
PortalException
protected void validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
Fields fields)
throws PortalException
PortalException
protected void validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
ServiceContext serviceContext)
throws PortalException
PortalException
protected void validateDDMStructureFields(DDMStructure ddmStructure,
long classNameId,
String content)
throws PortalException
PortalException
protected void validateDDMStructureId(long groupId,
long folderId,
String ddmStructureKey)
throws PortalException
PortalException
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||