com.liferay.portal.service.PortletLocalService 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.portal.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.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
/**
* Provides the local service interface for Portlet. 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 PortletLocalServiceUtil
* @see com.liferay.portal.service.base.PortletLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.PortletLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface PortletLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link PortletLocalServiceUtil} to access the portlet local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the portlet to the database. Also notifies the appropriate model listeners.
*
* @param portlet the portlet
* @return the portlet that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Portlet addPortlet(
com.liferay.portal.model.Portlet portlet)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new portlet with the primary key. Does not add the portlet to the database.
*
* @param id the primary key for the new portlet
* @return the new portlet
*/
public com.liferay.portal.model.Portlet createPortlet(long id);
/**
* Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param id the primary key of the portlet
* @return the portlet that was removed
* @throws PortalException if a portlet with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Portlet deletePortlet(long id)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the portlet from the database. Also notifies the appropriate model listeners.
*
* @param portlet the portlet
* @return the portlet that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Portlet deletePortlet(
com.liferay.portal.model.Portlet portlet)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.dao.orm.DynamicQuery 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 java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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.portal.model.impl.PortletModelImpl}. 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 java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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.portal.model.impl.PortletModelImpl}. 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 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;
/**
* 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 long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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 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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Portlet fetchPortlet(long id)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the portlet with the primary key.
*
* @param id the primary key of the portlet
* @return the portlet
* @throws PortalException if a portlet with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Portlet getPortlet(long id)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Returns a range of all the portlets.
*
*
* 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.portal.model.impl.PortletModelImpl}. 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 portlets
* @param end the upper bound of the range of portlets (not inclusive)
* @return the range of portlets
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortlets(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of portlets.
*
* @return the number of portlets
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getPortletsCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param portlet the portlet
* @return the portlet that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.Portlet updatePortlet(
com.liferay.portal.model.Portlet portlet)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* 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);
public void addPortletCategory(long companyId, java.lang.String categoryName);
public void checkPortlet(com.liferay.portal.model.Portlet portlet)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void checkPortlets(long companyId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void clearCache();
public void clearCompanyPortletsPool();
/**
* @deprecated As of 6.1.0, replaced by {@link #clonePortlet(String)}
*/
public com.liferay.portal.model.Portlet clonePortlet(long companyId,
java.lang.String portletId);
public com.liferay.portal.model.Portlet clonePortlet(
java.lang.String portletId);
public void deletePortlet(long companyId, java.lang.String portletId,
long plid)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deletePortlets(long companyId, java.lang.String[] portletIds,
long plid)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Portlet deployRemotePortlet(
com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.Portlet deployRemotePortlet(
com.liferay.portal.model.Portlet portlet,
java.lang.String[] categoryNames)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getCustomAttributesDisplays();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PortletCategory getEARDisplay(
java.lang.String xml)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getFriendlyURLMapperPortlets();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getFriendlyURLMappers();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PortletApp getPortletApp(
java.lang.String servletContextName);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Portlet getPortletById(long companyId,
java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Portlet getPortletById(
java.lang.String portletId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.Portlet getPortletByStrutsPath(
long companyId, java.lang.String strutsPath)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortlets();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortlets(
long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortlets(
long companyId, boolean showSystem, boolean showPortal)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getScopablePortlets();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PortletCategory getWARDisplay(
java.lang.String servletContextName, java.lang.String xml)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasPortlet(long companyId, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
public void initEAR(javax.servlet.ServletContext servletContext,
java.lang.String[] xmls,
com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
public java.util.List initWAR(
java.lang.String servletContextName,
javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.Map loadGetPortletsPool(
long companyId)
throws com.liferay.portal.kernel.exception.SystemException;
public void removeCompanyPortletsPool(long companyId);
public com.liferay.portal.model.Portlet updatePortlet(long companyId,
java.lang.String portletId, java.lang.String roles, boolean active)
throws com.liferay.portal.kernel.exception.SystemException;
}