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

Author:

Brian Wing Shun Chan

See Also:

PortletPreferencesLocalServiceUtil, PortletPreferencesLocalServiceBaseImpl, PortletPreferencesLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
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()
<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.
PortletPreferences	fetchPortletPreferences(long portletPreferencesId)
PortletPreferences	fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	fetchPreferences(PortletPreferencesIds portletPreferencesIds)
ActionableDynamicQuery	getActionableDynamicQuery()
PortletPreferences	getDefaultPreferences(long companyId, String portletId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
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 ownerId, int ownerType, 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)
Map<String,PortletPreferences>	getStrictPreferences(Layout layout, List<Portlet> portlets)
PortletPreferences	getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId)
PortletPreferences	getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
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

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

addPortletPreferences

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

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

createPortletPreferences

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deletePortletPreferences

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

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

deletePortletPreferences

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

deletePortletPreferences

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

Throws:

PortalException

deletePortletPreferences

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

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

deletePortletPreferencesByPlid

void deletePortletPreferencesByPlid(long plid)

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 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

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 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

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

fetchPortletPreferences

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

fetchPreferences

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

fetchPreferences

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

getActionableDynamicQuery

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

getDefaultPreferences

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

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

getPortletPreferences

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

getPortletPreferences

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

getPortletPreferences

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

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

getPortletPreferences

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

getPortletPreferences

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

Throws:

PortalException

getPortletPreferences

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

Throws:

PortalException

getPortletPreferences

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

getPortletPreferences

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

getPortletPreferencesByPlid

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

getPortletPreferencesCount

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

getPortletPreferencesCount

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

getPortletPreferencesCount

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

getPortletPreferencesCount

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

getPortletPreferenceses

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

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

getPortletPreferencesesCount

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

Returns the number of portlet preferenceses.

Returns:

the number of portlet preferenceses

getPreferences

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                                                                                                                                                                                                                        long ownerId,
                                                                                                                                                                                                                                                                        int ownerType,
                                                                                                                                                                                                                                                                        long plid,
                                                                                                                                                                                                                                                                        String portletId)

getPreferences

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(long companyId,
                                                                                                                                                                                                                                                                        long ownerId,
                                                                                                                                                                                                                                                                        int ownerType,
                                                                                                                                                                                                                                                                        long plid,
                                                                                                                                                                                                                                                                        String portletId,
                                                                                                                                                                                                                                                                        String defaultPreferences)

getPreferences

@Retry(acceptor=ExceptionRetryAcceptor.class,
       properties=@Property(name="EXCEPTION_NAME",value="org.springframework.dao.DataIntegrityViolationException"))
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)

getStrictPreferences

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<String,PortletPreferences> getStrictPreferences(Layout layout,
                                                                                                                       List<Portlet> portlets)

getStrictPreferences

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

getStrictPreferences

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

updatePortletPreferences

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

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

updatePreferences

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

updatePreferences

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