com.liferay.portal.service.PortletPreferencesLocalService 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 PortletPreferences. 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 PortletPreferencesLocalServiceUtil
* @see com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl
* @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface PortletPreferencesLocalService extends BaseLocalService,
PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link PortletPreferencesLocalServiceUtil} to access the portlet preferences local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the portlet preferences to the database. Also notifies the appropriate model listeners.
*
* @param portletPreferences the portlet preferences
* @return the portlet preferences that was added
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.PortletPreferences addPortletPreferences(
com.liferay.portal.model.PortletPreferences portletPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.
*
* @param portletPreferencesId the primary key for the new portlet preferences
* @return the new portlet preferences
*/
public com.liferay.portal.model.PortletPreferences createPortletPreferences(
long portletPreferencesId);
/**
* Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param portletPreferencesId the primary key of the portlet preferences
* @return the portlet preferences that was removed
* @throws PortalException if a portlet preferences with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
long portletPreferencesId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
*
* @param portletPreferences the portlet preferences
* @return the portlet preferences that was removed
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
com.liferay.portal.model.PortletPreferences portletPreferences)
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.PortletPreferencesModelImpl}. 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.PortletPreferencesModelImpl}. 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.PortletPreferences fetchPortletPreferences(
long portletPreferencesId)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the portlet preferences with the primary key.
*
* @param portletPreferencesId the primary key of the portlet preferences
* @return the portlet preferences
* @throws PortalException if a portlet preferences 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.PortletPreferences getPortletPreferences(
long portletPreferencesId)
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 portlet preferenceses.
*
*
* 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.PortletPreferencesModelImpl}. 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 portlet preferenceses
* @param end the upper bound of the range of portlet preferenceses (not inclusive)
* @return the range of portlet preferenceses
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferenceses(
int start, int end)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Returns the number of portlet preferenceses.
*
* @return the number of portlet preferenceses
* @throws SystemException if a system exception occurred
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getPortletPreferencesesCount()
throws com.liferay.portal.kernel.exception.SystemException;
/**
* Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param portletPreferences the portlet preferences
* @return the portlet preferences that was updated
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
com.liferay.portal.model.PortletPreferences portletPreferences)
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 com.liferay.portal.model.PortletPreferences addPortletPreferences(
long companyId, long ownerId, int ownerType, long plid,
java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
public void deletePortletPreferences(long ownerId, int ownerType, long plid)
throws com.liferay.portal.kernel.exception.SystemException;
public void deletePortletPreferences(long ownerId, int ownerType,
long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deletePortletPreferencesByPlid(long plid)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences fetchPreferences(long companyId,
long ownerId, int ownerType, long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences fetchPreferences(
com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getDefaultPreferences(
long companyId, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferences()
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferences(
int ownerType, long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferences(
long ownerId, int ownerType, long plid)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public com.liferay.portal.model.PortletPreferences getPortletPreferences(
long ownerId, int ownerType, long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferences(
long companyId, long groupId, long ownerId, int ownerType,
java.lang.String portletId, boolean privateLayout)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferences(
long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getPortletPreferencesByPlid(
long plid) throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getPortletPreferencesCount(int ownerType, long plid,
java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getPortletPreferencesCount(int ownerType,
java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getPortletPreferencesCount(long ownerId, int ownerType,
long plid, com.liferay.portal.model.Portlet portlet,
boolean excludeDefaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long getPortletPreferencesCount(long ownerId, int ownerType,
java.lang.String portletId, boolean excludeDefaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getPreferences(long companyId,
long ownerId, int ownerType, long plid, java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getPreferences(long companyId,
long ownerId, int ownerType, long plid, java.lang.String portletId,
java.lang.String defaultPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getPreferences(
com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getStrictPreferences(
long companyId, long ownerId, int ownerType, long plid,
java.lang.String portletId)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public javax.portlet.PortletPreferences getStrictPreferences(
com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.PortletPreferences updatePreferences(
long ownerId, int ownerType, long plid, java.lang.String portletId,
javax.portlet.PortletPreferences portletPreferences)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.model.PortletPreferences updatePreferences(
long ownerId, int ownerType, long plid, java.lang.String portletId,
java.lang.String xml)
throws com.liferay.portal.kernel.exception.SystemException;
}