com.liferay.portal.service
Interface PortletPreferencesLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PortletPreferencesLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletPreferencesLocalService
extends BaseLocalService, PersistedModelLocalService

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.

See Also:

PortletPreferencesLocalServiceUtil, PortletPreferencesLocalServiceBaseImpl, com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl

Method Summary

PortletPreferences	addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences)
PortletPreferences	addPortletPreferences(PortletPreferences portletPreferences) Adds the portlet preferences to the database.
PortletPreferences	createPortletPreferences(long portletPreferencesId) Creates a new portlet preferences with the primary key.
PortletPreferences	deletePortletPreferences(long portletPreferencesId) Deletes the portlet preferences with the primary key from the database.
void	deletePortletPreferences(long ownerId, int ownerType, long plid)
void	deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	deletePortletPreferences(PortletPreferences portletPreferences) Deletes the portlet preferences from the database.
void	deletePortletPreferencesByPlid(long plid)
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
PortletPreferences	fetchPortletPreferences(long portletPreferencesId)
PortletPreferences	fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	fetchPreferences(PortletPreferencesIds portletPreferencesIds)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PortletPreferences	getDefaultPreferences(long companyId, String portletId)
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<PortletPreferences>	getPortletPreferences()
List<PortletPreferences>	getPortletPreferences(int ownerType, long plid, String portletId)
PortletPreferences	getPortletPreferences(long portletPreferencesId) Returns the portlet preferences with the primary key.
List<PortletPreferences>	getPortletPreferences(long ownerId, int ownerType, long plid)
PortletPreferences	getPortletPreferences(long ownerId, int ownerType, long plid, String portletId)
List<PortletPreferences>	getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout)
List<PortletPreferences>	getPortletPreferences(long plid, String portletId)
List<PortletPreferences>	getPortletPreferencesByPlid(long plid)
long	getPortletPreferencesCount(int ownerType, long plid, String portletId)
long	getPortletPreferencesCount(int ownerType, String portletId)
long	getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences)
long	getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences)
List<PortletPreferences>	getPortletPreferenceses(int start, int end) Returns a range of all the portlet preferenceses.
int	getPortletPreferencesesCount() Returns the number of portlet preferenceses.
PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences)
PortletPreferences	getPreferences(PortletPreferencesIds portletPreferencesIds)
PortletPreferences	getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
PortletPreferences	updatePortletPreferences(PortletPreferences portletPreferences) Updates the portlet preferences in the database or adds it if it does not yet exist.
PortletPreferences	updatePreferences(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences)
PortletPreferences	updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml)

Method Detail

addPortletPreferences

@Indexable(type=REINDEX)
PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)
                                         throws SystemException

Adds the portlet preferences to the database. Also notifies the appropriate model listeners.

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was added

Throws:

SystemException - if a system exception occurred

createPortletPreferences

PortletPreferences createPortletPreferences(long portletPreferencesId)

Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.

Parameters:

portletPreferencesId - the primary key for the new portlet preferences

Returns:

the new portlet preferences

deletePortletPreferences

@Indexable(type=DELETE)
PortletPreferences deletePortletPreferences(long portletPreferencesId)
                                            throws PortalException,
                                                   SystemException

Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

portletPreferencesId - the primary key of the portlet preferences

Returns:

the portlet preferences that was removed

Throws:

PortalException - if a portlet preferences with the primary key could not be found

SystemException - if a system exception occurred

deletePortletPreferences

@Indexable(type=DELETE)
PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)
                                            throws SystemException

Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences fetchPortletPreferences(long portletPreferencesId)
                                           throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPortletPreferences(long portletPreferencesId)
                                         throws PortalException,
                                                SystemException

Returns the portlet preferences with the primary key.

Parameters:

portletPreferencesId - the primary key of the portlet preferences

Returns:

the portlet preferences

Throws:

PortalException - if a portlet preferences with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getPortletPreferenceses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferenceses(int start,
                                                                                          int end)
                                                 throws 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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:

start - the lower bound of the range of portlet preferenceses

end - the upper bound of the range of portlet preferenceses (not inclusive)

Returns:

the range of portlet preferenceses

Throws:

SystemException - if a system exception occurred

getPortletPreferencesesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletPreferencesesCount()
                                 throws SystemException

Returns the number of portlet preferenceses.

Returns:

the number of portlet preferenceses

Throws:

SystemException - if a system exception occurred

updatePortletPreferences

@Indexable(type=REINDEX)
PortletPreferences updatePortletPreferences(PortletPreferences portletPreferences)
                                            throws SystemException

Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortletPreferences

PortletPreferences addPortletPreferences(long companyId,
                                         long ownerId,
                                         int ownerType,
                                         long plid,
                                         String portletId,
                                         Portlet portlet,
                                         String defaultPreferences)
                                         throws SystemException

Throws:

SystemException

deletePortletPreferences

void deletePortletPreferences(long ownerId,
                              int ownerType,
                              long plid)
                              throws SystemException

Throws:

SystemException

deletePortletPreferences

void deletePortletPreferences(long ownerId,
                              int ownerType,
                              long plid,
                              String portletId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

deletePortletPreferencesByPlid

void deletePortletPreferencesByPlid(long plid)
                                    throws SystemException

Throws:

SystemException

fetchPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences fetchPreferences(long companyId,
                                                                             long ownerId,
                                                                             int ownerType,
                                                                             long plid,
                                                                             String portletId)
                                    throws SystemException

Throws:

SystemException

fetchPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)
                                    throws SystemException

Throws:

SystemException

getDefaultPreferences

@Skip
@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getDefaultPreferences(long companyId,
                                                                                       String portletId)
                                         throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences()
                                               throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(int ownerType,
                                                                                        long plid,
                                                                                        String portletId)
                                               throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(long ownerId,
                                                                                        int ownerType,
                                                                                        long plid)
                                               throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPortletPreferences(long ownerId,
                                                                                  int ownerType,
                                                                                  long plid,
                                                                                  String portletId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(long companyId,
                                                                                        long groupId,
                                                                                        long ownerId,
                                                                                        int ownerType,
                                                                                        String portletId,
                                                                                        boolean privateLayout)
                                               throws SystemException

Throws:

SystemException

getPortletPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferences(long plid,
                                                                                        String portletId)
                                               throws SystemException

Throws:

SystemException

getPortletPreferencesByPlid

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletPreferences> getPortletPreferencesByPlid(long plid)
                                                     throws SystemException

Throws:

SystemException

getPortletPreferencesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPortletPreferencesCount(int ownerType,
                                                                         long plid,
                                                                         String portletId)
                                throws SystemException

Throws:

SystemException

getPortletPreferencesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPortletPreferencesCount(int ownerType,
                                                                         String portletId)
                                throws SystemException

Throws:

SystemException

getPortletPreferencesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPortletPreferencesCount(long ownerId,
                                                                         int ownerType,
                                                                         long plid,
                                                                         Portlet portlet,
                                                                         boolean excludeDefaultPreferences)
                                throws SystemException

Throws:

SystemException

getPortletPreferencesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getPortletPreferencesCount(long ownerId,
                                                                         int ownerType,
                                                                         String portletId,
                                                                         boolean excludeDefaultPreferences)
                                throws SystemException

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                           long ownerId,
                                                                           int ownerType,
                                                                           long plid,
                                                                           String portletId)
                                  throws SystemException

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                           long ownerId,
                                                                           int ownerType,
                                                                           long plid,
                                                                           String portletId,
                                                                           String defaultPreferences)
                                  throws SystemException

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
                                  throws SystemException

Throws:

SystemException

getStrictPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getStrictPreferences(long companyId,
                                                                                 long ownerId,
                                                                                 int ownerType,
                                                                                 long plid,
                                                                                 String portletId)
                                        throws SystemException

Throws:

SystemException

getStrictPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
                                        throws SystemException

Throws:

SystemException

updatePreferences

PortletPreferences updatePreferences(long ownerId,
                                     int ownerType,
                                     long plid,
                                     String portletId,
                                     PortletPreferences portletPreferences)
                                     throws SystemException

Throws:

SystemException

updatePreferences

PortletPreferences updatePreferences(long ownerId,
                                     int ownerType,
                                     long plid,
                                     String portletId,
                                     String xml)
                                     throws SystemException

Throws:

SystemException