com.liferay.portal.service

Interface PortalPreferencesLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PortalPreferencesLocalServiceWrapper

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

Provides the local service interface for PortalPreferences. 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 Also:

PortalPreferencesLocalServiceUtil, PortalPreferencesLocalServiceBaseImpl, com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
PortalPreferences	addPortalPreferences(long ownerId, int ownerType, java.lang.String defaultPreferences)
PortalPreferences	addPortalPreferences(long companyId, long ownerId, int ownerType, java.lang.String defaultPreferences) Deprecated. As of 6.2.0, replaced by addPortalPreferences(long, int, String)
PortalPreferences	addPortalPreferences(PortalPreferences portalPreferences) Adds the portal preferences to the database.
PortalPreferences	createPortalPreferences(long portalPreferencesId) Creates a new portal preferences with the primary key.
PortalPreferences	deletePortalPreferences(long portalPreferencesId) Deletes the portal preferences with the primary key from the database.
PortalPreferences	deletePortalPreferences(PortalPreferences portalPreferences) Deletes the portal preferences from the database.
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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.
PortalPreferences	fetchPortalPreferences(long portalPreferencesId)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
PortalPreferences	getPortalPreferences(long portalPreferencesId) Returns the portal preferences with the primary key.
java.util.List<PortalPreferences>	getPortalPreferenceses(int start, int end) Returns a range of all the portal preferenceses.
int	getPortalPreferencesesCount() Returns the number of portal preferenceses.
javax.portlet.PortletPreferences	getPreferences(long ownerId, int ownerType)
javax.portlet.PortletPreferences	getPreferences(long ownerId, int ownerType, java.lang.String defaultPreferences)
javax.portlet.PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType) Deprecated. As of 6.2.0, replaced by getPreferences(long, int)
javax.portlet.PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, java.lang.String defaultPreferences) Deprecated. As of 6.2.0, replaced by getPreferences(long, int, String)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
PortalPreferences	updatePortalPreferences(PortalPreferences portalPreferences) Updates the portal preferences in the database or adds it if it does not yet exist.
PortalPreferences	updatePreferences(long ownerId, int ownerType, PortalPreferences portalPreferences)
PortalPreferences	updatePreferences(long ownerId, int ownerType, java.lang.String xml)

Method Detail

addPortalPreferences

@Indexable(type=REINDEX)
PortalPreferences addPortalPreferences(PortalPreferences portalPreferences)
                                       throws SystemException

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

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was added

Throws:

SystemException - if a system exception occurred

createPortalPreferences

PortalPreferences createPortalPreferences(long portalPreferencesId)

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

Parameters:

portalPreferencesId - the primary key for the new portal preferences

Returns:

the new portal preferences

deletePortalPreferences

@Indexable(type=DELETE)
PortalPreferences deletePortalPreferences(long portalPreferencesId)
                                          throws PortalException,
                                                 SystemException

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

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences that was removed

Throws:

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

SystemException - if a system exception occurred

deletePortalPreferences

@Indexable(type=DELETE)
PortalPreferences deletePortalPreferences(PortalPreferences portalPreferences)
                                          throws SystemException

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

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.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

java.util.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 PortalPreferencesModelImpl. 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

java.util.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 PortalPreferencesModelImpl. 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

fetchPortalPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortalPreferences fetchPortalPreferences(long portalPreferencesId)
                                         throws SystemException

Throws:

SystemException

getPortalPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortalPreferences getPortalPreferences(long portalPreferencesId)
                                       throws PortalException,
                                              SystemException

Returns the portal preferences with the primary key.

Parameters:

portalPreferencesId - the primary key of the portal preferences

Returns:

the portal preferences

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getPortalPreferenceses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<PortalPreferences> getPortalPreferenceses(int start,
                                                                                                int end)
                                                         throws SystemException

Returns a range of all the portal 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 PortalPreferencesModelImpl. 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 portal preferenceses

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

Returns:

the range of portal preferenceses

Throws:

SystemException - if a system exception occurred

getPortalPreferencesesCount

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

Returns the number of portal preferenceses.

Returns:

the number of portal preferenceses

Throws:

SystemException - if a system exception occurred

updatePortalPreferences

@Indexable(type=REINDEX)
PortalPreferences updatePortalPreferences(PortalPreferences portalPreferences)
                                          throws SystemException

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

Parameters:

portalPreferences - the portal preferences

Returns:

the portal preferences that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortalPreferences

PortalPreferences addPortalPreferences(long ownerId,
                                     int ownerType,
                                     java.lang.String defaultPreferences)
                                       throws SystemException

Throws:

SystemException

addPortalPreferences

PortalPreferences addPortalPreferences(long companyId,
                                     long ownerId,
                                     int ownerType,
                                     java.lang.String defaultPreferences)
                                       throws SystemException

Deprecated. As of 6.2.0, replaced by addPortalPreferences(long, int, String)

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
javax.portlet.PortletPreferences getPreferences(long ownerId,
                                                                                       int ownerType)
                                                throws SystemException

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
javax.portlet.PortletPreferences getPreferences(long ownerId,
                                                                                       int ownerType,
                                                                                       java.lang.String defaultPreferences)
                                                throws SystemException

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
javax.portlet.PortletPreferences getPreferences(long companyId,
                                                                                       long ownerId,
                                                                                       int ownerType)
                                                throws SystemException

Deprecated. As of 6.2.0, replaced by getPreferences(long, int)

Throws:

SystemException

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
javax.portlet.PortletPreferences getPreferences(long companyId,
                                                                                       long ownerId,
                                                                                       int ownerType,
                                                                                       java.lang.String defaultPreferences)
                                                throws SystemException

Deprecated. As of 6.2.0, replaced by getPreferences(long, int, String)

Throws:

SystemException

updatePreferences

PortalPreferences updatePreferences(long ownerId,
                                  int ownerType,
                                  PortalPreferences portalPreferences)
                                    throws SystemException

Throws:

SystemException

updatePreferences

PortalPreferences updatePreferences(long ownerId,
                                  int ownerType,
                                  java.lang.String xml)
                                    throws SystemException

Throws:

SystemException