com.liferay.journal.service.JournalFeedLocalService 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.exportimport.kernel.lar.PortletDataContext;
import com.liferay.journal.model.JournalFeed;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
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.model.SystemEventConstants;
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.service.ServiceContext;
import com.liferay.portal.kernel.systemevent.SystemEvent;
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 JournalFeed. 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 JournalFeedLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface JournalFeedLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link JournalFeedLocalServiceUtil} to access the journal feed local service. Add custom service methods to com.liferay.journal.service.impl.JournalFeedLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public JournalFeed addFeed(
long userId, long groupId, String feedId, boolean autoFeedId,
String name, String description, String ddmStructureKey,
String ddmTemplateKey, String ddmRendererTemplateKey, int delta,
String orderByCol, String orderByType,
String targetLayoutFriendlyUrl, String targetPortletId,
String contentField, String feedFormat, double feedVersion,
ServiceContext serviceContext)
throws PortalException;
public void addFeedResources(
JournalFeed feed, boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException;
public void addFeedResources(
JournalFeed feed, String[] groupPermissions,
String[] guestPermissions)
throws PortalException;
public void addFeedResources(
long feedId, boolean addGroupPermissions,
boolean addGuestPermissions)
throws PortalException;
public void addFeedResources(
long feedId, String[] groupPermissions, String[] guestPermissions)
throws PortalException;
/**
* Adds the journal feed to the database. Also notifies the appropriate model listeners.
*
* @param journalFeed the journal feed
* @return the journal feed that was added
*/
@Indexable(type = IndexableType.REINDEX)
public JournalFeed addJournalFeed(JournalFeed journalFeed);
/**
* Creates a new journal feed with the primary key. Does not add the journal feed to the database.
*
* @param id the primary key for the new journal feed
* @return the new journal feed
*/
@Transactional(enabled = false)
public JournalFeed createJournalFeed(long id);
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public void deleteFeed(JournalFeed feed) throws PortalException;
public void deleteFeed(long feedId) throws PortalException;
public void deleteFeed(long groupId, String feedId) throws PortalException;
/**
* Deletes the journal feed from the database. Also notifies the appropriate model listeners.
*
* @param journalFeed the journal feed
* @return the journal feed that was removed
*/
@Indexable(type = IndexableType.DELETE)
public JournalFeed deleteJournalFeed(JournalFeed journalFeed);
/**
* Deletes the journal feed with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param id the primary key of the journal feed
* @return the journal feed that was removed
* @throws PortalException if a journal feed with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public JournalFeed deleteJournalFeed(long id) throws PortalException;
/**
* @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.JournalFeedModelImpl. 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.JournalFeedModelImpl. 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 JournalFeed fetchFeed(long groupId, String feedId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed fetchJournalFeed(long id);
/**
* Returns the journal feed matching the UUID and group.
*
* @param uuid the journal feed's UUID
* @param groupId the primary key of the group
* @return the matching journal feed, or null if a matching journal feed could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed fetchJournalFeedByUuidAndGroupId(
String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed getFeed(long feedId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed getFeed(long groupId, String feedId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFeeds();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFeeds(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getFeeds(long groupId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getFeedsCount(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the journal feed with the primary key.
*
* @param id the primary key of the journal feed
* @return the journal feed
* @throws PortalException if a journal feed with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed getJournalFeed(long id) throws PortalException;
/**
* Returns the journal feed matching the UUID and group.
*
* @param uuid the journal feed's UUID
* @param groupId the primary key of the group
* @return the matching journal feed
* @throws PortalException if a matching journal feed could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public JournalFeed getJournalFeedByUuidAndGroupId(String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the journal feeds.
*
*
* 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.JournalFeedModelImpl. 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 feeds
* @param end the upper bound of the range of journal feeds (not inclusive)
* @return the range of journal feeds
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getJournalFeeds(int start, int end);
/**
* Returns all the journal feeds matching the UUID and company.
*
* @param uuid the UUID of the journal feeds
* @param companyId the primary key of the company
* @return the matching journal feeds, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getJournalFeedsByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of journal feeds matching the UUID and company.
*
* @param uuid the UUID of the journal feeds
* @param companyId the primary key of the company
* @param start the lower bound of the range of journal feeds
* @param end the upper bound of the range of journal feeds (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching journal feeds, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getJournalFeedsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of journal feeds.
*
* @return the number of journal feeds
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getJournalFeedsCount();
/**
* 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 search(
long companyId, long groupId, String keywords, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List search(
long companyId, long groupId, String feedId, String name,
String description, boolean andOperator, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(long companyId, long groupId, String keywords);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int searchCount(
long companyId, long groupId, String feedId, String name,
String description, boolean andOperator);
public JournalFeed updateFeed(
long groupId, String feedId, String name, String description,
String ddmStructureKey, String ddmTemplateKey,
String ddmRendererTemplateKey, int delta, String orderByCol,
String orderByType, String targetLayoutFriendlyUrl,
String targetPortletId, String contentField, String feedFormat,
double feedVersion, ServiceContext serviceContext)
throws PortalException;
/**
* Updates the journal feed in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param journalFeed the journal feed
* @return the journal feed that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public JournalFeed updateJournalFeed(JournalFeed journalFeed);
}