com.liferay.portal.kernel.service

Class PortletPreferencesLocalServiceWrapper

Object

com.liferay.portal.kernel.service.PortletPreferencesLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, PortletPreferencesLocalService, ServiceWrapper<PortletPreferencesLocalService>

@ProviderType
public class PortletPreferencesLocalServiceWrapper
extends Object
implements PortletPreferencesLocalService, ServiceWrapper<PortletPreferencesLocalService>

Provides a wrapper for PortletPreferencesLocalService.

Author:

Brian Wing Shun Chan

See Also:

PortletPreferencesLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PortletPreferencesLocalServiceWrapper(PortletPreferencesLocalService portletPreferencesLocalService)

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)
PortletPreferencesLocalService	getWrappedService()
void	setWrappedService(PortletPreferencesLocalService portletPreferencesLocalService)
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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletPreferencesLocalServiceWrapper

public PortletPreferencesLocalServiceWrapper(PortletPreferencesLocalService portletPreferencesLocalService)

Method Detail

addPortletPreferences

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

Specified by:

addPortletPreferences in interface PortletPreferencesLocalService

addPortletPreferences

public PortletPreferences addPortletPreferences(PortletPreferences portletPreferences)

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

Specified by:

addPortletPreferences in interface PortletPreferencesLocalService

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was added

createPortletPreferences

public PortletPreferences createPortletPreferences(long portletPreferencesId)

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

Specified by:

createPortletPreferences in interface PortletPreferencesLocalService

Parameters:

portletPreferencesId - the primary key for the new portlet preferences

Returns:

the new portlet preferences

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Specified by:

deletePersistedModel in interface PortletPreferencesLocalService

Throws:

PortalException

deletePortletPreferences

public PortletPreferences deletePortletPreferences(long portletPreferencesId)
                                            throws PortalException

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

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

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

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

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

deletePortletPreferences

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

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

Throws:

PortalException

deletePortletPreferences

public PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)

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

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was removed

deletePortletPreferencesByPlid

public void deletePortletPreferencesByPlid(long plid)

Specified by:

deletePortletPreferencesByPlid in interface PortletPreferencesLocalService

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface PortletPreferencesLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Specified by:

dynamicQuery in interface PortletPreferencesLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

Specified by:

dynamicQuery in interface PortletPreferencesLocalService

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

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

Specified by:

dynamicQuery in interface PortletPreferencesLocalService

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

public long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface PortletPreferencesLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface PortletPreferencesLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortletPreferences

public PortletPreferences fetchPortletPreferences(long portletPreferencesId)

Specified by:

fetchPortletPreferences in interface PortletPreferencesLocalService

fetchPreferences

public PortletPreferences fetchPreferences(long companyId,
                                           long ownerId,
                                           int ownerType,
                                           long plid,
                                           String portletId)

Specified by:

fetchPreferences in interface PortletPreferencesLocalService

fetchPreferences

public PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)

Specified by:

fetchPreferences in interface PortletPreferencesLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface PortletPreferencesLocalService

getDefaultPreferences

public PortletPreferences getDefaultPreferences(long companyId,
                                                String portletId)

Specified by:

getDefaultPreferences in interface PortletPreferencesLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface PortletPreferencesLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface PortletPreferencesLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface PortletPreferencesLocalService

Throws:

PortalException

getPortletPreferences

public List<PortletPreferences> getPortletPreferences()

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

getPortletPreferences

public List<PortletPreferences> getPortletPreferences(int ownerType,
                                                      long plid,
                                                      String portletId)

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

getPortletPreferences

public PortletPreferences getPortletPreferences(long portletPreferencesId)
                                         throws PortalException

Returns the portlet preferences with the primary key.

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

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

public List<PortletPreferences> getPortletPreferences(long ownerId,
                                                      int ownerType,
                                                      long plid)

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

getPortletPreferences

public PortletPreferences getPortletPreferences(long ownerId,
                                                int ownerType,
                                                long plid,
                                                String portletId)
                                         throws PortalException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

PortalException

getPortletPreferences

public List<PortletPreferences> getPortletPreferences(long companyId,
                                                      long ownerId,
                                                      int ownerType,
                                                      String portletId)
                                               throws PortalException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

PortalException

getPortletPreferences

public List<PortletPreferences> getPortletPreferences(long companyId,
                                                      long groupId,
                                                      long ownerId,
                                                      int ownerType,
                                                      String portletId,
                                                      boolean privateLayout)

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

getPortletPreferences

public List<PortletPreferences> getPortletPreferences(long plid,
                                                      String portletId)

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

getPortletPreferencesByPlid

public List<PortletPreferences> getPortletPreferencesByPlid(long plid)

Specified by:

getPortletPreferencesByPlid in interface PortletPreferencesLocalService

getPortletPreferencesCount

public long getPortletPreferencesCount(int ownerType,
                                       long plid,
                                       String portletId)

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

getPortletPreferencesCount

public long getPortletPreferencesCount(int ownerType,
                                       String portletId)

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

getPortletPreferencesCount

public long getPortletPreferencesCount(long ownerId,
                                       int ownerType,
                                       long plid,
                                       Portlet portlet,
                                       boolean excludeDefaultPreferences)

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

getPortletPreferencesCount

public long getPortletPreferencesCount(long ownerId,
                                       int ownerType,
                                       String portletId,
                                       boolean excludeDefaultPreferences)

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

getPortletPreferenceses

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

Specified by:

getPortletPreferenceses in interface PortletPreferencesLocalService

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

public int getPortletPreferencesesCount()

Returns the number of portlet preferenceses.

Specified by:

getPortletPreferencesesCount in interface PortletPreferencesLocalService

Returns:

the number of portlet preferenceses

getPreferences

public PortletPreferences getPreferences(long companyId,
                                         long ownerId,
                                         int ownerType,
                                         long plid,
                                         String portletId)

Specified by:

getPreferences in interface PortletPreferencesLocalService

getPreferences

public PortletPreferences getPreferences(long companyId,
                                         long ownerId,
                                         int ownerType,
                                         long plid,
                                         String portletId,
                                         String defaultPreferences)

Specified by:

getPreferences in interface PortletPreferencesLocalService

getPreferences

public PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)

Specified by:

getPreferences in interface PortletPreferencesLocalService

getStrictPreferences

public Map<String,PortletPreferences> getStrictPreferences(Layout layout,
                                                           List<Portlet> portlets)

Specified by:

getStrictPreferences in interface PortletPreferencesLocalService

getStrictPreferences

public PortletPreferences getStrictPreferences(long companyId,
                                               long ownerId,
                                               int ownerType,
                                               long plid,
                                               String portletId)

Specified by:

getStrictPreferences in interface PortletPreferencesLocalService

getStrictPreferences

public PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)

Specified by:

getStrictPreferences in interface PortletPreferencesLocalService

updatePortletPreferences

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

Specified by:

updatePortletPreferences in interface PortletPreferencesLocalService

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was updated

updatePreferences

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

Specified by:

updatePreferences in interface PortletPreferencesLocalService

updatePreferences

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

Specified by:

updatePreferences in interface PortletPreferencesLocalService

getWrappedService

public PortletPreferencesLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<PortletPreferencesLocalService>

setWrappedService

public void setWrappedService(PortletPreferencesLocalService portletPreferencesLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<PortletPreferencesLocalService>