com.liferay.portlet.journal.service.JournalFeedLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* 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.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for JournalFeed. This utility wraps
* {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. 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 JournalFeedLocalService
* @see com.liferay.portlet.journal.service.base.JournalFeedLocalServiceBaseImpl
* @see com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl
* @generated
*/
@ProviderType
public class JournalFeedLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalFeedLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed addJournalFeed(
com.liferay.portlet.journal.model.JournalFeed journalFeed)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().addJournalFeed(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
*/
public static com.liferay.portlet.journal.model.JournalFeed createJournalFeed(
long id) {
return getService().createJournalFeed(id);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
long id)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().deleteJournalFeed(id);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed deleteJournalFeed(
com.liferay.portlet.journal.model.JournalFeed journalFeed)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().deleteJournalFeed(journalFeed);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQuery(dynamicQuery, start, 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.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
* @throws SystemException if a system exception occurred
*/
@SuppressWarnings("rawtypes")
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows that match the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows that match the dynamic query
* @throws SystemException if a system exception occurred
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeed(
long id) throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchJournalFeed(id);
}
/**
* Returns the journal feed with the matching UUID and company.
*
* @param uuid the journal feed's UUID
* @param companyId the primary key of the company
* @return the matching journal feed, or null if a matching journal feed could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchJournalFeedByUuidAndCompanyId(uuid, companyId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed fetchJournalFeedByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchJournalFeedByUuidAndGroupId(uuid, groupId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed getJournalFeed(
long id)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getJournalFeed(id);
}
public static com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Returns the journal feed with the matching UUID and company.
*
* @param uuid the journal feed's UUID
* @param companyId the primary key of the company
* @return the matching journal feed
* @throws PortalException if a matching journal feed could not be found
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getJournalFeedByUuidAndCompanyId(uuid, companyId);
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed getJournalFeedByUuidAndGroupId(
java.lang.String uuid, long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getJournalFeedByUuidAndGroupId(uuid, groupId);
}
/**
* 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.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
* @throws SystemException if a system exception occurred
*/
public static java.util.List getJournalFeeds(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getJournalFeeds(start, end);
}
/**
* Returns the number of journal feeds.
*
* @return the number of journal feeds
* @throws SystemException if a system exception occurred
*/
public static int getJournalFeedsCount()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getJournalFeedsCount();
}
/**
* 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
* @throws SystemException if a system exception occurred
*/
public static com.liferay.portlet.journal.model.JournalFeed updateJournalFeed(
com.liferay.portlet.journal.model.JournalFeed journalFeed)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().updateJournalFeed(journalFeed);
}
/**
* Returns the Spring bean ID for this bean.
*
* @return the Spring bean ID for this bean
*/
public static java.lang.String getBeanIdentifier() {
return getService().getBeanIdentifier();
}
/**
* Sets the Spring bean ID for this bean.
*
* @param beanIdentifier the Spring bean ID for this bean
*/
public static void setBeanIdentifier(java.lang.String beanIdentifier) {
getService().setBeanIdentifier(beanIdentifier);
}
public static com.liferay.portlet.journal.model.JournalFeed addFeed(
long userId, long groupId, java.lang.String feedId, boolean autoFeedId,
java.lang.String name, java.lang.String description,
java.lang.String type, java.lang.String structureId,
java.lang.String templateId, java.lang.String rendererTemplateId,
int delta, java.lang.String orderByCol, java.lang.String orderByType,
java.lang.String targetLayoutFriendlyUrl,
java.lang.String targetPortletId, java.lang.String contentField,
java.lang.String feedFormat, double feedVersion,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.addFeed(userId, groupId, feedId, autoFeedId, name,
description, type, structureId, templateId, rendererTemplateId,
delta, orderByCol, orderByType, targetLayoutFriendlyUrl,
targetPortletId, contentField, feedFormat, feedVersion,
serviceContext);
}
public static void addFeedResources(
com.liferay.portlet.journal.model.JournalFeed feed,
boolean addGroupPermissions, boolean addGuestPermissions)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService()
.addFeedResources(feed, addGroupPermissions, addGuestPermissions);
}
public static void addFeedResources(
com.liferay.portlet.journal.model.JournalFeed feed,
java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().addFeedResources(feed, groupPermissions, guestPermissions);
}
public static void addFeedResources(long feedId,
boolean addGroupPermissions, boolean addGuestPermissions)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService()
.addFeedResources(feedId, addGroupPermissions, addGuestPermissions);
}
public static void addFeedResources(long feedId,
java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().addFeedResources(feedId, groupPermissions, guestPermissions);
}
public static void deleteFeed(
com.liferay.portlet.journal.model.JournalFeed feed)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteFeed(feed);
}
public static void deleteFeed(long feedId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteFeed(feedId);
}
public static void deleteFeed(long groupId, java.lang.String feedId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
getService().deleteFeed(groupId, feedId);
}
public static com.liferay.portlet.journal.model.JournalFeed fetchFeed(
long groupId, java.lang.String feedId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().fetchFeed(groupId, feedId);
}
public static com.liferay.portlet.journal.model.JournalFeed getFeed(
long feedId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getFeed(feedId);
}
public static com.liferay.portlet.journal.model.JournalFeed getFeed(
long groupId, java.lang.String feedId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService().getFeed(groupId, feedId);
}
public static java.util.List getFeeds()
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFeeds();
}
public static java.util.List getFeeds(
long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFeeds(groupId);
}
public static java.util.List getFeeds(
long groupId, int start, int end)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFeeds(groupId, start, end);
}
public static int getFeedsCount(long groupId)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().getFeedsCount(groupId);
}
public static java.util.List search(
long companyId, long groupId, java.lang.String keywords, int start,
int end, com.liferay.portal.kernel.util.OrderByComparator obc)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().search(companyId, groupId, keywords, start, end, obc);
}
public static java.util.List search(
long companyId, long groupId, java.lang.String feedId,
java.lang.String name, java.lang.String description,
boolean andOperator, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator obc)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.search(companyId, groupId, feedId, name, description,
andOperator, start, end, obc);
}
public static int searchCount(long companyId, long groupId,
java.lang.String keywords)
throws com.liferay.portal.kernel.exception.SystemException {
return getService().searchCount(companyId, groupId, keywords);
}
public static int searchCount(long companyId, long groupId,
java.lang.String feedId, java.lang.String name,
java.lang.String description, boolean andOperator)
throws com.liferay.portal.kernel.exception.SystemException {
return getService()
.searchCount(companyId, groupId, feedId, name, description,
andOperator);
}
public static com.liferay.portlet.journal.model.JournalFeed updateFeed(
long groupId, java.lang.String feedId, java.lang.String name,
java.lang.String description, java.lang.String type,
java.lang.String structureId, java.lang.String templateId,
java.lang.String rendererTemplateId, int delta,
java.lang.String orderByCol, java.lang.String orderByType,
java.lang.String targetLayoutFriendlyUrl,
java.lang.String targetPortletId, java.lang.String contentField,
java.lang.String feedFormat, double feedVersion,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException {
return getService()
.updateFeed(groupId, feedId, name, description, type,
structureId, templateId, rendererTemplateId, delta, orderByCol,
orderByType, targetLayoutFriendlyUrl, targetPortletId,
contentField, feedFormat, feedVersion, serviceContext);
}
public static JournalFeedLocalService getService() {
if (_service == null) {
_service = (JournalFeedLocalService)PortalBeanLocatorUtil.locate(JournalFeedLocalService.class.getName());
ReferenceRegistry.registerReference(JournalFeedLocalServiceUtil.class,
"_service");
}
return _service;
}
/**
* @deprecated As of 6.2.0
*/
public void setService(JournalFeedLocalService service) {
}
private static JournalFeedLocalService _service;
}