com.liferay.portal.kernel.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, PortalPreferencesLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
PortalPreferences	addPortalPreferences(long ownerId, int ownerType, String defaultPreferences)
PortalPreferences	addPortalPreferences(PortalPreferences portalPreferences) Adds the portal preferences to the database.
PortalPreferences	createPortalPreferences(long portalPreferencesId) Creates a new portal preferences with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
PortalPreferences	fetchPortalPreferences(long portalPreferencesId)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
PortalPreferences	getPortalPreferences(long portalPreferencesId) Returns the portal preferences with the primary key.
List<PortalPreferences>	getPortalPreferenceses(int start, int end) Returns a range of all the portal preferenceses.
int	getPortalPreferencesesCount() Returns the number of portal preferenceses.
PortletPreferences	getPreferences(long ownerId, int ownerType)
PortletPreferences	getPreferences(long ownerId, int ownerType, String defaultPreferences)
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, String xml)

Method Detail

addPortalPreferences

PortalPreferences addPortalPreferences(long ownerId,
                                       int ownerType,
                                       String defaultPreferences)

addPortalPreferences

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

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

createPortalPreferences

@Transactional(enabled=false)
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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deletePortalPreferences

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

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

deletePortalPreferences

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

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortalPreferences

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getPortalPreferences

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

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

getPortalPreferenceses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortalPreferences> getPortalPreferenceses(int start,
                                                                                                                  int end)

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

getPortalPreferencesesCount

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

Returns the number of portal preferenceses.

Returns:

the number of portal preferenceses

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long ownerId,
                                                                                                     int ownerType)

getPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long ownerId,
                                                                                                     int ownerType,
                                                                                                     String defaultPreferences)

updatePortalPreferences

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

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

updatePreferences

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

updatePreferences

PortalPreferences updatePreferences(long ownerId,
                                    int ownerType,
                                    String xml)