com.liferay.journal.service.JournalContentSearchLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present 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.journal.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.journal.model.JournalContentSearch;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
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.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for JournalContentSearch. Methods of this
* service will not have security checks based on the propagated JAAS
* credentials because this service can only be accessed from within the same
* VM.
*
* @author Brian Wing Shun Chan
* @see JournalContentSearchLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface JournalContentSearchLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link JournalContentSearchLocalServiceUtil} to access the journal content search local service. Add custom service methods to com.liferay.journal.service.impl.JournalContentSearchLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the journal content search to the database. Also notifies the appropriate model listeners.
*
* @param journalContentSearch the journal content search
* @return the journal content search that was added
*/
@Indexable(type = IndexableType.REINDEX)
public JournalContentSearch addJournalContentSearch(
JournalContentSearch journalContentSearch);
public void checkContentSearches(long companyId) throws PortalException;
/**
* Creates a new journal content search with the primary key. Does not add the journal content search to the database.
*
* @param contentSearchId the primary key for the new journal content search
* @return the new journal content search
*/
@Transactional(enabled = false)
public JournalContentSearch createJournalContentSearch(
long contentSearchId);
public void deleteArticleContentSearch(
long groupId, boolean privateLayout, long layoutId, String portletId);
public void deleteArticleContentSearch(
long groupId, boolean privateLayout, long layoutId, String portletId,
String articleId);
public void deleteArticleContentSearches(long groupId, String articleId);
/**
* Deletes the journal content search from the database. Also notifies the appropriate model listeners.
*
* @param journalContentSearch the journal content search
* @return the journal content search that was removed
*/
@Indexable(type = IndexableType.DELETE)
public JournalContentSearch deleteJournalContentSearch(
JournalContentSearch journalContentSearch);
/**
* Deletes the journal content search with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param contentSearchId the primary key of the journal content search
* @return the journal content search that was removed
* @throws PortalException if a journal content search with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public JournalContentSearch deleteJournalContentSearch(long contentSearchId)
throws PortalException;
public void deleteLayoutContentSearches(
long groupId, boolean privateLayout, long layoutId);
public void deleteOwnerContentSearches(long groupId, boolean privateLayout);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* Performs a dynamic query on the database and returns a range of the matching rows.
*
*
* 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalContentSearchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* Performs a dynamic query on the database and returns an ordered range of the matching rows.
*
*
* 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalContentSearchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalContentSearch fetchJournalContentSearch(long contentSearchId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArticleContentSearches();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArticleContentSearches(
long groupId, String articleId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getArticleContentSearches(
String articleId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the journal content search with the primary key.
*
* @param contentSearchId the primary key of the journal content search
* @return the journal content search
* @throws PortalException if a journal content search with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalContentSearch getJournalContentSearch(long contentSearchId)
throws PortalException;
/**
* Returns a range of all the journal content searchs.
*
*
* 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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalContentSearchModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of journal content searchs
* @param end the upper bound of the range of journal content searchs (not inclusive)
* @return the range of journal content searchs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getJournalContentSearchs(
int start, int end);
/**
* Returns the number of journal content searchs.
*
* @return the number of journal content searchs
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getJournalContentSearchsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getLayoutIds(
long groupId, boolean privateLayout, String articleId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutIdsCount(
long groupId, boolean privateLayout, String articleId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getLayoutIdsCount(String articleId);
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getPortletContentSearches(
String portletId);
public JournalContentSearch updateContentSearch(
long groupId, boolean privateLayout, long layoutId,
String portletId, String articleId)
throws PortalException;
public JournalContentSearch updateContentSearch(
long groupId, boolean privateLayout, long layoutId,
String portletId, String articleId, boolean purge)
throws PortalException;
public List updateContentSearch(
long groupId, boolean privateLayout, long layoutId,
String portletId, String[] articleIds)
throws PortalException;
/**
* Updates the journal content search in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param journalContentSearch the journal content search
* @return the journal content search that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public JournalContentSearch updateJournalContentSearch(
JournalContentSearch journalContentSearch);
}