All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.liferay.portlet.journal.service.JournalArticleService Maven / Gradle / Ivy

Go to download

Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.

There is a newer version: 7.0.0-nightly
Show newest version
/**
 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portlet.journal.service;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.security.ac.AccessControlled;
import com.liferay.portal.service.BaseService;

/**
 * Provides the remote service interface for JournalArticle. Methods of this
 * service are expected to have security checks based on the propagated JAAS
 * credentials because this service can be accessed remotely.
 *
 * @author Brian Wing Shun Chan
 * @see JournalArticleServiceUtil
 * @see com.liferay.portlet.journal.service.base.JournalArticleServiceBaseImpl
 * @see com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl
 * @generated
 */
@ProviderType
@AccessControlled
@JSONWebService
@Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
	PortalException.class, SystemException.class})
public interface JournalArticleService extends BaseService {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify or reference this interface directly. Always use {@link JournalArticleServiceUtil} to access the journal article remote service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
	 */

	/**
	* Returns the Spring bean ID for this bean.
	*
	* @return the Spring bean ID for this bean
	*/
	public java.lang.String getBeanIdentifier();

	/**
	* Sets the Spring bean ID for this bean.
	*
	* @param beanIdentifier the Spring bean ID for this bean
	*/
	public void setBeanIdentifier(java.lang.String beanIdentifier);

	/**
	* Adds a web content article with additional parameters.
	*
	* @param groupId the primary key of the web content article's group
	* @param folderId the primary key of the web content article folder
	* @param 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 {@link
	JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise
	* @param classPK the primary key of the DDM structure, if the primary key
	of the DDMStructure class is given as the
	classNameId parameter, the primary key of the class
	associated with the web content article, or 0
	otherwise
	* @param articleId the primary key of the web content article
	* @param autoArticleId whether to auto generate the web content article ID
	* @param titleMap the web content article's locales and localized titles
	* @param descriptionMap the web content article's locales and localized
	descriptions
	* @param content the HTML content wrapped in XML. For more information,
	see the content example in the class description for {@link
	JournalArticleLocalServiceImpl}.
	* @param type the structure's type, if the web content article is related
	to a DDM structure. For more information, see {@link
	com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
	* @param ddmStructureKey the primary key of the web content article's DDM
	structure, if the article is related to a DDM structure, or
	null otherwise
	* @param ddmTemplateKey the primary key of the web content article's DDM
	template (optionally null). If the article is
	related to a DDM structure, the template's structure must match
	it.
	* @param layoutUuid the unique string identifying the web content
	article's display page
	* @param displayDateMonth the month the web content article is set to
	display
	* @param displayDateDay the calendar day the web content article is set to
	display
	* @param displayDateYear the year the web content article is set to
	display
	* @param displayDateHour the hour the web content article is set to
	display
	* @param displayDateMinute the minute the web content article is set to
	display
	* @param expirationDateMonth the month the web content article is set to
	expire
	* @param expirationDateDay the calendar day the web content article is set
	to expire
	* @param expirationDateYear the year the web content article is set to
	expire
	* @param expirationDateHour the hour the web content article is set to
	expire
	* @param expirationDateMinute the minute the web content article is set to
	expire
	* @param neverExpire whether the web content article is not set to auto
	expire
	* @param reviewDateMonth the month the web content article is set for
	review
	* @param reviewDateDay the calendar day the web content article is set for
	review
	* @param reviewDateYear the year the web content article is set for review
	* @param reviewDateHour the hour the web content article is set for review
	* @param reviewDateMinute the minute the web content article is set for
	review
	* @param neverReview whether the web content article is not set for review
	* @param indexable whether the web content article is searchable
	* @param smallImage whether the web content article has a small image
	* @param smallImageURL the web content article's small image URL
	* @param smallFile the web content article's small image file
	* @param images the web content's images
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	UUID, creation date, modification date, expando bridge
	attributes, guest permissions, group permissions, asset category
	IDs, asset tag names, asset link entry IDs, the "urlTitle"
	attribute, and workflow actions for the web content article. Can
	also set whether to add the default guest and group permissions.
	* @return the web content article
	* @throws PortalException if the user did not have permission to add the
	web content article or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public com.liferay.portlet.journal.model.JournalArticle addArticle(
		long groupId, long folderId, long classNameId, long classPK,
		java.lang.String articleId, boolean autoArticleId,
		java.util.Map titleMap,
		java.util.Map descriptionMap,
		java.lang.String content, java.lang.String type,
		java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey,
		java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
		int displayDateYear, int displayDateHour, int displayDateMinute,
		int expirationDateMonth, int expirationDateDay, int expirationDateYear,
		int expirationDateHour, int expirationDateMinute, boolean neverExpire,
		int reviewDateMonth, int reviewDateDay, int reviewDateYear,
		int reviewDateHour, int reviewDateMinute, boolean neverReview,
		boolean indexable, boolean smallImage, java.lang.String smallImageURL,
		java.io.File smallFile, java.util.Map images,
		java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Adds a web content article without any images.
	*
	* @param groupId the primary key of the web content article's group
	* @param folderId the primary key of the web content article folder
	* @param 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 {@link
	JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise
	* @param classPK the primary key of the DDM structure, if the primary key
	of the DDMStructure class is given as the
	classNameId parameter, the primary key of the class
	associated with the web content article, or 0
	otherwise
	* @param articleId the primary key of the web content article
	* @param autoArticleId whether to auto generate the web content article ID
	* @param titleMap the web content article's locales and localized titles
	* @param descriptionMap the web content article's locales and localized
	descriptions
	* @param content the HTML content wrapped in XML. For more information,
	see the content example in the class description for {@link
	JournalArticleLocalServiceImpl}.
	* @param type the structure's type, if the web content article is related
	to a DDM structure. For more information, see {@link
	com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}.
	* @param ddmStructureKey the primary key of the web content article's DDM
	structure, if the article is related to a DDM structure, or
	null otherwise
	* @param ddmTemplateKey the primary key of the web content article's DDM
	template (optionally null). If the article is
	related to a DDM structure, the template's structure must match
	it.
	* @param layoutUuid the unique string identifying the web content
	article's display page
	* @param displayDateMonth the month the web content article is set to
	display
	* @param displayDateDay the calendar day the web content article is set to
	display
	* @param displayDateYear the year the web content article is set to
	display
	* @param displayDateHour the hour the web content article is set to
	display
	* @param displayDateMinute the minute the web content article is set to
	display
	* @param expirationDateMonth the month the web content article is set to
	expire
	* @param expirationDateDay the calendar day the web content article is set
	to expire
	* @param expirationDateYear the year the web content article is set to
	expire
	* @param expirationDateHour the hour the web content article is set to
	expire
	* @param expirationDateMinute the minute the web content article is set to
	expire
	* @param neverExpire whether the web content article is not set to auto
	expire
	* @param reviewDateMonth the month the web content article is set for
	review
	* @param reviewDateDay the calendar day the web content article is set for
	review
	* @param reviewDateYear the year the web content article is set for review
	* @param reviewDateHour the hour the web content article is set for review
	* @param reviewDateMinute the minute the web content article is set for
	review
	* @param neverReview whether the web content article is not set for review
	* @param indexable whether the web content article is searchable
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	UUID, creation date, modification date, expando bridge
	attributes, guest permissions, group permissions, asset category
	IDs, asset tag names, asset link entry IDs, the "urlTitle"
	attribute, and workflow actions for the web content article. Can
	also set whether to add the default guest and group permissions.
	* @return the web content article
	* @throws PortalException if the user did not have permission to add the
	web content article or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public com.liferay.portlet.journal.model.JournalArticle addArticle(
		long groupId, long folderId, long classNameId, long classPK,
		java.lang.String articleId, boolean autoArticleId,
		java.util.Map titleMap,
		java.util.Map descriptionMap,
		java.lang.String content, java.lang.String type,
		java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey,
		java.lang.String layoutUuid, int displayDateMonth, int displayDateDay,
		int displayDateYear, int displayDateHour, int displayDateMinute,
		int expirationDateMonth, int expirationDateDay, int expirationDateYear,
		int expirationDateHour, int expirationDateMinute, boolean neverExpire,
		int reviewDateMonth, int reviewDateDay, int reviewDateYear,
		int reviewDateHour, int reviewDateMinute, boolean neverReview,
		boolean indexable, java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Copies the web content article matching the group, article ID, and
	* version. This method creates a new article, extracting all the values
	* from the old one and updating its article ID.
	*
	* @param groupId the primary key of the web content article's group
	* @param oldArticleId the primary key of the old web content article
	* @param newArticleId the primary key of the new web content article
	* @param autoArticleId whether to auto-generate the web content article ID
	* @param version the web content article's version
	* @return the new web content article
	* @throws PortalException if the user did not have permission to add the
	copy the web content article, if a matching web content article
	could not be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public com.liferay.portlet.journal.model.JournalArticle copyArticle(
		long groupId, java.lang.String oldArticleId,
		java.lang.String newArticleId, boolean autoArticleId, double version)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Deletes the web content article and its resources matching the group,
	* article ID, and version, optionally sending email notifying denial of the
	* web content article if it had not yet been approved.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param version the web content article's version
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	portlet preferences that include email information to notify
	recipients of the unapproved web content article's denial.
	* @throws PortalException if the user did not have permission to delete the
	web content article, if a matching web content article could not
	be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public void deleteArticle(long groupId, java.lang.String articleId,
		double version, java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Deletes all web content articles and their resources matching the group
	* and article ID, optionally sending email notifying denial of article if
	* it had not yet been approved.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	portlet preferences that include email information to notify
	recipients of the unapproved web content article's denial.
	* @throws PortalException if the user did not have permission to delete the
	web content article or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public void deleteArticle(long groupId, java.lang.String articleId,
		java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Expires the web content article matching the group, article ID, and
	* version.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param version the web content article's version
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	modification date, status date, portlet preferences, and can set
	whether to add the default command update for the web content
	article. With respect to social activities, by setting the
	service context's command to {@link
	com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation
	is considered a web content update activity; otherwise it is
	considered a web content add activity.
	* @return the web content article
	* @throws PortalException if the user did not have permission to expire the
	web content article, if a matching web content article could not
	be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public com.liferay.portlet.journal.model.JournalArticle expireArticle(
		long groupId, java.lang.String articleId, double version,
		java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Expires the web content article matching the group and article ID,
	* expiring all of its versions if the
	* journal.article.expire.all.versions portal property is
	* true, otherwise expiring only its latest approved version.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param articleURL the web content article's accessible URL
	* @param serviceContext the service context to be applied. Can set the
	modification date, status date, portlet preferences, and can set
	whether to add the default command update for the web content
	article. With respect to social activities, by setting the
	service context's command to {@link
	com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation
	is considered a web content update activity; otherwise it is
	considered a web content add activity.
	* @throws PortalException if the user did not have permission to expire the
	web content article, if a matching web content article could not
	be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	public void expireArticle(long groupId, java.lang.String articleId,
		java.lang.String articleURL,
		com.liferay.portal.service.ServiceContext serviceContext)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the web content article with the ID.
	*
	* @param id the primary key of the web content article
	* @return the web content article with the ID
	* @throws PortalException if a matching web content article could not be
	found or if the user did not have permission to view the web
	content article
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public com.liferay.portlet.journal.model.JournalArticle getArticle(long id)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the latest approved web content article, or the latest unapproved
	* article if none are approved. Both approved and unapproved articles must
	* match the group and article ID.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @return the matching web content article
	* @throws PortalException if the user did not have permission to view the
	web content article or if a matching web content article could
	not be found
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public com.liferay.portlet.journal.model.JournalArticle getArticle(
		long groupId, java.lang.String articleId)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the web content article matching the group, article ID, and
	* version.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param version the web content article's version
	* @return the matching web content article
	* @throws PortalException if the user did not have permission to view the
	web content article or if a matching web content article could
	not be found
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public com.liferay.portlet.journal.model.JournalArticle getArticle(
		long groupId, java.lang.String articleId, double version)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the web content article matching the group, class name, and class
	* PK.
	*
	* @param groupId the primary key of the web content article's group
	* @param className the DDMStructure class name if the web content article
	is related to a DDM structure, the primary key of the class name
	associated with the article, or {@link
	JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise
	* @param classPK the primary key of the DDM structure, if the the
	DDMStructure class name is given as the className
	parameter, the primary key of the class associated with the web
	content article, or 0 otherwise
	* @return the matching web content article
	* @throws PortalException if a matching web content article could not be
	found or if the user did not have permission to view the web
	content article
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public com.liferay.portlet.journal.model.JournalArticle getArticle(
		long groupId, java.lang.String className, long classPK)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the latest web content article that is approved, or the latest
	* unapproved article if none are approved. Both approved and unapproved
	* articles must match the group and URL title.
	*
	* @param groupId the primary key of the web content article's group
	* @param urlTitle the web content article's accessible URL title
	* @return the matching web content article
	* @throws PortalException if the user did not have permission to view the
	web content article or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public com.liferay.portlet.journal.model.JournalArticle getArticleByUrlTitle(
		long groupId, java.lang.String urlTitle)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the web content matching the group, article ID, and version.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param version the web content article's version
	* @param languageId the primary key of the language translation to get
	* @param themeDisplay the theme display
	* @return the matching web content
	* @throws PortalException if the user did not have permission to view the
	web content article, if a matching web content article or DDM
	template could not be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public java.lang.String getArticleContent(long groupId,
		java.lang.String articleId, double version,
		java.lang.String languageId,
		com.liferay.portal.theme.ThemeDisplay themeDisplay)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns the latest web content matching the group and article ID.
	*
	* @param groupId the primary key of the web content article's group
	* @param articleId the primary key of the web content article
	* @param languageId the primary key of the language translation to get
	* @param themeDisplay the theme display
	* @return the matching web content
	* @throws PortalException if the user did not have permission to view the
	web content article, if a matching web content article or DDM
	template could not be found, or if a portal exception occurred
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public java.lang.String getArticleContent(long groupId,
		java.lang.String articleId, java.lang.String languageId,
		com.liferay.portal.theme.ThemeDisplay themeDisplay)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException;

	/**
	* Returns all the web content articles matching the group and folder.
	*
	* @param groupId the primary key of the web content article's group
	* @param folderId the primary key of the web content article folder
	* @return the matching web content articles
	* @throws SystemException if a system exception occurred
	*/
	@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
	public java.util.List getArticles(
		long groupId, long folderId)
		throws com.liferay.portal.kernel.exception.SystemException;

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

* Useful when paginating results. Returns a maximum of end - * start instances. start and end are not * primary keys, they are indexes in the result set. Thus, 0 * refers to the first result in the set. Setting both start * and end to {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param groupId the primary key of the web content article's group * @param folderId the primary key of the web content article folder * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getArticles( long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * group and article ID. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getArticlesByArticleId( long groupId, java.lang.String articleId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns all the web content articles matching the group and layout UUID. * * @param groupId the primary key of the web content article's group * @param layoutUuid the unique string identifying the web content article's display page * @return the matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getArticlesByLayoutUuid( long groupId, java.lang.String layoutUuid) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * group, class name ID, DDM structure key, and workflow status. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param groupId the primary key of the web content article's group * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param ddmStructureKey the primary key of the web content article's DDM structure * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getArticlesByStructureId( long groupId, long classNameId, java.lang.String ddmStructureKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * group, default class name ID, and DDM structure key. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param groupId the primary key of the web content article's group * @param ddmStructureKey the primary key of the web content article's DDM structure * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getArticlesByStructureId( long groupId, java.lang.String ddmStructureKey, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the group and folder. * * @param groupId the primary key of the web content article's group * @param folderId the primary key of the web content article folder * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getArticlesCount(long groupId, long folderId) throws com.liferay.portal.kernel.exception.SystemException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getArticlesCount(long groupId, long folderId, int status) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the group and article * ID. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getArticlesCountByArticleId(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the group, class name * ID, DDM structure key, and workflow status. * * @param groupId the primary key of the web content article's group * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param ddmStructureKey the primary key of the web content article's DDM structure * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getArticlesCountByStructureId(long groupId, long classNameId, java.lang.String ddmStructureKey, int status) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the group, default * class name ID, and DDM structure key. * * @param groupId the primary key of the web content article's group * @param ddmStructureKey the primary key of the web content article's DDM structure * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getArticlesCountByStructureId(long groupId, java.lang.String ddmStructureKey) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the web content article matching the URL title that is currently * displayed or next to be displayed if no article is currently displayed. * * @param groupId the primary key of the web content article's group * @param urlTitle the web content article's accessible URL title * @return the web content article matching the URL title that is currently displayed, or next one to be displayed if no version of the article is currently displayed * @throws PortalException if the user did not have permission to view the web content article or if no approved matching web content articles could be found * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public com.liferay.portlet.journal.model.JournalArticle getDisplayArticleByUrlTitle( long groupId, java.lang.String urlTitle) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of folders containing web content articles belonging * to the group. * * @param groupId the primary key of the web content article's group * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @return the number of matching folders containing web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getFoldersAndArticlesCount(long groupId, java.util.List folderIds) throws com.liferay.portal.kernel.exception.SystemException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getGroupArticles( long groupId, long userId, long rootFolderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * group, user, the root folder or any of its subfolders. * * @param groupId the primary key of the web content article's group * @param userId the primary key of the user (optionally 0) * @param rootFolderId the primary key of the root folder to begin the search * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param orderByComparator the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws PortalException if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List getGroupArticles( long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator orderByComparator) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the group, user, and * the root folder or any of its subfolders. * * @param groupId the primary key of the web content article's group * @param userId the primary key of the user (optionally 0) * @param rootFolderId the primary key of the root folder to begin the search * @return the number of matching web content articles * @throws PortalException if the root folder could not be found, if the current user did not have permission to view the root folder, or if a portal exception occurred * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupArticlesCount(long groupId, long userId, long rootFolderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int getGroupArticlesCount(long groupId, long userId, long rootFolderId, int status) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns the latest web content article matching the resource primary key, * preferring articles with approved workflow status. * * @param resourcePrimKey the primary key of the resource instance * @return the latest web content article matching the resource primary key, preferring articles with approved workflow status * @throws PortalException if the user did not have permission to view the web content article or if a matching web content article could not be found * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns the latest web content article matching the group, article ID, * and workflow status. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @return the latest matching web content article * @throws PortalException if the user did not have permission to view the web content article or if a matching web content article could not be found * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( long groupId, java.lang.String articleId, int status) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns the latest web content article matching the group, class name ID, * and class PK. * * @param groupId the primary key of the web content article's group * @param className the DDMStructure class name if the web content article is related to a DDM structure, the class name associated with the article, or {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param classPK the primary key of the DDM structure, if the DDMStructure class name is given as the className parameter, the primary key of the class associated with the web content article, or 0 otherwise * @return the latest matching web content article * @throws PortalException if a matching web content article could not be found or if the user did not have permission to view the web content article * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public com.liferay.portlet.journal.model.JournalArticle getLatestArticle( long groupId, java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Moves all versions of the the web content article matching the group and * article ID to the folder. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param newFolderId the primary key of the web content article's new folder * @throws PortalException if the user did not have permission to update any one of the versions of the web content article or if any one of the versions of the web content article could not be moved to the folder * @throws SystemException if a system exception occurred */ public void moveArticle(long groupId, java.lang.String articleId, long newFolderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Moves the web content article from the Recycle Bin to the folder. * * @param groupId the primary key of the web content article's group * @param resourcePrimKey the primary key of the resource instance * @param newFolderId the primary key of the web content article's new folder * @param serviceContext the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation is considered a web content update activity; otherwise it is considered a web content add activity. * @return the updated web content article, which was moved from the Recycle Bin to the folder * @throws PortalException if the user did not have permission to view or update the web content article, if a matching trashed web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( long groupId, long resourcePrimKey, long newFolderId, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Moves the web content article from the Recycle Bin to the folder. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param newFolderId the primary key of the web content article's new folder * @param serviceContext the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation is considered a web content update activity; otherwise it is considered a web content add activity. * @return the updated web content article, which was moved from the Recycle Bin to the folder * @throws PortalException if the user did not have permission to view or update the web content article, if a trashed web content article with the primary key could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle moveArticleFromTrash( long groupId, java.lang.String articleId, long newFolderId, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Moves the latest version of the web content article matching the group * and article ID to the recycle bin. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @return the moved web content article or null if no matching article was found * @throws PortalException if the user did not have permission to move the article to the Recycle Bin or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle moveArticleToTrash( long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Removes the web content of all the company's web content articles * matching the language. * * @param companyId the primary key of the web content article's company * @param languageId the primary key of the language locale to remove * @throws PortalException if the user did not have permission to update any one of the the web content articles or if web content matching the language could not be found for any one of the articles * @throws SystemException if a system exception occurred */ public void removeArticleLocale(long companyId, java.lang.String languageId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Removes the web content of the web content article matching the group, * article ID, and version, and language. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param version the web content article's version * @param languageId the primary key of the language locale to remove * @return the updated web content article with the locale removed * @throws PortalException if the user did not have permission to update the web content article or if a matching web content article could not be found * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle removeArticleLocale( long groupId, java.lang.String articleId, double version, java.lang.String languageId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Restores the web content article associated with the resource primary key * from the Recycle Bin. * * @param resourcePrimKey the primary key of the resource instance * @throws PortalException if a matching web content article could not be found in the Recycle Bin, if the user did not have permission to view or restore the article, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public void restoreArticleFromTrash(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Restores the web content article from the Recycle Bin. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @throws PortalException if the web content article with the primary key could not be found in the Recycle Bin, if the user did not have permission to restore the article, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public void restoreArticleFromTrash(long groupId, java.lang.String articleId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public com.liferay.portal.kernel.search.Hits search(long groupId, long creatorUserId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * parameters, including a keywords parameter for matching with the * article's ID, title, description, and content, a DDM structure key * parameter, and a DDM template key parameter. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param keywords the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator. * @param version the web content article's version (optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKey the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKey the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List search( long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String type, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * parameters, including keyword parameters for article ID, title, * description, and content, a DDM structure key parameter, a DDM template * key parameter, and an AND operator switch. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param articleId the article ID keywords (space separated, optionally null) * @param version the web content article's version (optionally null) * @param title the title keywords (space separated, optionally null) * @param description the description keywords (space separated, optionally null) * @param content the content keywords (space separated, optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKey the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKey the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @param 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. * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List search( long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns an ordered range of all the web content articles matching the * parameters, including keyword parameters for article ID, title, * description, and content, a DDM structure keys (plural) parameter, a DDM * template keys (plural) parameter, and an AND operator switch. * *

* 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 {@link * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full * result set. *

* * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param articleId the article ID keywords (space separated, optionally null) * @param version the web content article's version (optionally null) * @param title the title keywords (space separated, optionally null) * @param description the description keywords (space separated, optionally null) * @param content the content keywords (space separated, optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKeys the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKeys the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @param 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. * @param start the lower bound of the range of web content articles to return * @param end the upper bound of the range of web content articles to return (not inclusive) * @param obc the comparator to order the web content articles * @return the range of matching web content articles ordered by the comparator * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public java.util.List search( long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the parameters, * including a keywords parameter for matching with the article's ID, title, * description, and content, a DDM structure key parameter, and a DDM * template key parameter. * * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param keywords the keywords (space separated), which may occur in the web content article ID, title, description, or content (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator. * @param version the web content article's version (optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKey the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKey the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int searchCount(long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String keywords, java.lang.Double version, java.lang.String type, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the parameters, * including keyword parameters for article ID, title, description, and * content, a DDM structure key parameter, a DDM template key parameter, and * an AND operator switch. * * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param articleId the article ID keywords (space separated, optionally null) * @param version the web content article's version (optionally null) * @param title the title keywords (space separated, optionally null) * @param description the description keywords (space separated, optionally null) * @param content the content keywords (space separated, optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKey the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKey the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @param 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. * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int searchCount(long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator) throws com.liferay.portal.kernel.exception.SystemException; /** * Returns the number of web content articles matching the parameters, * including keyword parameters for article ID, title, description, and * content, a DDM structure keys (plural) parameter, a DDM template keys * (plural) parameter, and an AND operator switch. * * @param companyId the primary key of the web content article's company * @param groupId the primary key of the group (optionally 0) * @param folderIds the primary keys of the web content article folders (optionally {@link java.util.Collections#EMPTY_LIST}) * @param 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 {@link JournalArticleConstants#CLASSNAME_ID_DEFAULT} otherwise * @param articleId the article ID keywords (space separated, optionally null) * @param version the web content article's version (optionally null) * @param title the title keywords (space separated, optionally null) * @param description the description keywords (space separated, optionally null) * @param content the content keywords (space separated, optionally null) * @param type the web content article's type (optionally null) * @param ddmStructureKeys the primary keys of the web content article's DDM structures, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKeys the primary keys of the web content article's DDM templates (originally null). If the articles are related to a DDM structure, the template's structure must match it. * @param displayDateGT the date after which a matching web content article's display date must be after (optionally null) * @param displayDateLT the date before which a matching web content article's display date must be before (optionally null) * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param reviewDate the web content article's scheduled review date (optionally null) * @param 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. * @return the number of matching web content articles * @throws SystemException if a system exception occurred */ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) public int searchCount(long companyId, long groupId, java.util.List folderIds, long classNameId, java.lang.String articleId, java.lang.Double version, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String type, java.lang.String[] ddmStructureKeys, java.lang.String[] ddmTemplateKeys, java.util.Date displayDateGT, java.util.Date displayDateLT, int status, java.util.Date reviewDate, boolean andOperator) throws com.liferay.portal.kernel.exception.SystemException; /** * Subscribes the user to notifications for the web content article matching * the group, notifying him the instant versions of the article are created, * deleted, or modified. * * @param groupId the primary key of the group * @throws PortalException if the user did not have permission to subscribe to the web content article or if a matching user or group could not be found * @throws SystemException if a system exception occurred */ public void subscribe(long groupId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Unsubscribes the user from notifications for the web content article * matching the group. * * @param groupId the primary key of the group * @throws PortalException if the user did not have permission to subscribe to the web content article or if a matching user or subscription could not be found * @throws SystemException if a system exception occurred */ public void unsubscribe(long groupId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the web content article matching the version, replacing its * folder, title, description, content, and layout UUID. * * @param userId the primary key of the user updating the web content article * @param groupId the primary key of the web content article's group * @param folderId the primary key of the web content article folder * @param articleId the primary key of the web content article * @param version the web content article's version * @param titleMap the web content article's locales and localized titles * @param descriptionMap the web content article's locales and localized descriptions * @param content the HTML content wrapped in XML. For more information, see the content example in the class description for {@link JournalArticleLocalServiceImpl}. * @param layoutUuid the unique string identifying the web content article's display page * @param serviceContext the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation is considered a web content update activity; otherwise it is considered a web content add activity. * @return the updated web content article * @throws PortalException if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateArticle( long userId, long groupId, long folderId, java.lang.String articleId, double version, java.util.Map titleMap, java.util.Map descriptionMap, java.lang.String content, java.lang.String layoutUuid, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the web content article with additional parameters. * * @param groupId the primary key of the web content article's group * @param folderId the primary key of the web content article folder * @param articleId the primary key of the web content article * @param version the web content article's version * @param titleMap the web content article's locales and localized titles * @param descriptionMap the web content article's locales and localized descriptions * @param content the HTML content wrapped in XML. For more information, see the content example in the class description for {@link JournalArticleLocalServiceImpl}. * @param type the structure's type, if the web content article is related to a DDM structure. For more information, see {@link com.liferay.portlet.dynamicdatamapping.model.DDMStructureConstants}. * @param ddmStructureKey the primary key of the web content article's DDM structure, if the article is related to a DDM structure, or null otherwise * @param ddmTemplateKey the primary key of the web content article's DDM template (optionally null). If the article is related to a DDM structure, the template's structure must match it. * @param layoutUuid the unique string identifying the web content article's display page * @param displayDateMonth the month the web content article is set to display * @param displayDateDay the calendar day the web content article is set to display * @param displayDateYear the year the web content article is set to display * @param displayDateHour the hour the web content article is set to display * @param displayDateMinute the minute the web content article is set to display * @param expirationDateMonth the month the web content article is set to expire * @param expirationDateDay the calendar day the web content article is set to expire * @param expirationDateYear the year the web content article is set to expire * @param expirationDateHour the hour the web content article is set to expire * @param expirationDateMinute the minute the web content article is set to expire * @param neverExpire whether the web content article is not set to auto expire * @param reviewDateMonth the month the web content article is set for review * @param reviewDateDay the calendar day the web content article is set for review * @param reviewDateYear the year the web content article is set for review * @param reviewDateHour the hour the web content article is set for review * @param reviewDateMinute the minute the web content article is set for review * @param neverReview whether the web content article is not set for review * @param indexable whether the web content is searchable * @param smallImage whether to update web content article's a small image. A file must be passed in as smallImageFile value, otherwise the current small image is deleted. * @param smallImageURL the web content article's small image URL (optionally null) * @param smallFile the web content article's new small image file (optionally null). Must pass in smallImage value of true to replace the article's small image file. * @param images the web content's images (optionally null) * @param articleURL the web content article's accessible URL (optionally null) * @param serviceContext the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation is considered a web content update activity; otherwise it is considered a web content add activity. * @return the updated web content article * @throws PortalException if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateArticle( long groupId, long folderId, java.lang.String articleId, double version, java.util.Map titleMap, java.util.Map descriptionMap, java.lang.String content, java.lang.String type, java.lang.String ddmStructureKey, java.lang.String ddmTemplateKey, java.lang.String layoutUuid, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean neverExpire, int reviewDateMonth, int reviewDateDay, int reviewDateYear, int reviewDateHour, int reviewDateMinute, boolean neverReview, boolean indexable, boolean smallImage, java.lang.String smallImageURL, java.io.File smallFile, java.util.Map images, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the web content article matching the version, replacing its * folder and content. * * @param groupId the primary key of the web content article's group * @param folderId the primary key of the web content article folder * @param articleId the primary key of the web content article * @param version the web content article's version * @param content the HTML content wrapped in XML. For more information, see the content example in the class description for {@link JournalArticleLocalServiceImpl}. * @param serviceContext the service context to be applied. Can set the modification date, expando bridge attributes, asset category IDs, asset tag names, asset link entry IDs, workflow actions, the "defaultLanguageId" and "urlTitle" attributes, and can set whether to add the default command update for the web content article. With respect to social activities, by setting the service context's command to {@link com.liferay.portal.kernel.util.Constants#UPDATE}, the invocation is considered a web content update activity; otherwise it is considered a web content add activity. * @return the updated web content article * @throws PortalException if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateArticle( long groupId, long folderId, java.lang.String articleId, double version, java.lang.String content, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * @deprecated As of 6.2.0, replaced by {@link #updateArticleTranslation(long, String, double, Locale, String, String, String, Map, ServiceContext)} */ public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( long groupId, java.lang.String articleId, double version, java.util.Locale locale, java.lang.String title, java.lang.String description, java.lang.String content, java.util.Map images) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the translation of the web content article. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param version the web content article's version * @param locale the locale of the web content article's display template * @param title the translated web content article title * @param description the translated web content article description * @param content the HTML content wrapped in XML. For more information, see the content example in the class description for {@link JournalArticleLocalServiceImpl}. * @param images the web content's images * @param serviceContext the service context to be applied. Can set the modification date and "urlTitle" attribute for the web content article. * @return the updated web content article * @throws PortalException if the user did not have permission to update the web content article, if a user with the primary key or a matching web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateArticleTranslation( long groupId, java.lang.String articleId, double version, java.util.Locale locale, java.lang.String title, java.lang.String description, java.lang.String content, java.util.Map images, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the web content article matching the group, article ID, and * version, replacing its content. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param version the web content article's version * @param content the HTML content wrapped in XML. For more information, see the content example in the class description for {@link JournalArticleLocalServiceImpl}. * @return the updated web content article * @throws PortalException if the user did not have permission to update the web content article or if a matching web content article could not be found * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateContent( long groupId, java.lang.String articleId, double version, java.lang.String content) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; /** * Updates the workflow status of the web content article matching the * group, article ID, and version. * * @param groupId the primary key of the web content article's group * @param articleId the primary key of the web content article * @param version the web content article's version * @param status the web content article's workflow status. For more information see {@link WorkflowConstants} for constants starting with the "STATUS_" prefix. * @param articleURL the web content article's accessible URL * @param serviceContext the service context to be applied. Can set the modification date, portlet preferences, and can set whether to add the default command update for the web content article. * @return the updated web content article * @throws PortalException if the user did not have permission to update the web content article, if a matching web content article could not be found, or if a portal exception occurred * @throws SystemException if a system exception occurred */ public com.liferay.portlet.journal.model.JournalArticle updateStatus( long groupId, java.lang.String articleId, double version, int status, java.lang.String articleURL, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy