com.liferay.portal.service

Class PortletPreferencesLocalServiceWrapper

java.lang.Object

com.liferay.portal.service.PortletPreferencesLocalServiceWrapper

All Implemented Interfaces:

BaseLocalService, PersistedModelLocalService, PortletPreferencesLocalService, ServiceWrapper<PortletPreferencesLocalService>

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

Provides a wrapper for PortletPreferencesLocalService.

Author:

Brian Wing Shun Chan

See Also:

PortletPreferencesLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
PortletPreferencesLocalServiceWrapper(PortletPreferencesLocalService portletPreferencesLocalService)

Method Summary

Methods

Modifier and Type	Method and Description
PortletPreferences	addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, Portlet portlet, java.lang.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, java.lang.String portletId)
PortletPreferences	deletePortletPreferences(PortletPreferences portletPreferences) Deletes the portlet preferences from the database.
void	deletePortletPreferencesByPlid(long plid)
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.
PortletPreferences	fetchPortletPreferences(long portletPreferencesId)
javax.portlet.PortletPreferences	fetchPreferences(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId)
javax.portlet.PortletPreferences	fetchPreferences(PortletPreferencesIds portletPreferencesIds)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
javax.portlet.PortletPreferences	getDefaultPreferences(long companyId, java.lang.String portletId)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<PortletPreferences>	getPortletPreferences()
java.util.List<PortletPreferences>	getPortletPreferences(int ownerType, long plid, java.lang.String portletId)
PortletPreferences	getPortletPreferences(long portletPreferencesId) Returns the portlet preferences with the primary key.
java.util.List<PortletPreferences>	getPortletPreferences(long ownerId, int ownerType, long plid)
PortletPreferences	getPortletPreferences(long ownerId, int ownerType, long plid, java.lang.String portletId)
java.util.List<PortletPreferences>	getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, java.lang.String portletId, boolean privateLayout)
java.util.List<PortletPreferences>	getPortletPreferences(long plid, java.lang.String portletId)
java.util.List<PortletPreferences>	getPortletPreferencesByPlid(long plid)
long	getPortletPreferencesCount(int ownerType, long plid, java.lang.String portletId)
long	getPortletPreferencesCount(int ownerType, java.lang.String portletId)
long	getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences)
long	getPortletPreferencesCount(long ownerId, int ownerType, java.lang.String portletId, boolean excludeDefaultPreferences)
java.util.List<PortletPreferences>	getPortletPreferenceses(int start, int end) Returns a range of all the portlet preferenceses.
int	getPortletPreferencesesCount() Returns the number of portlet preferenceses.
javax.portlet.PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId)
javax.portlet.PortletPreferences	getPreferences(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String defaultPreferences)
javax.portlet.PortletPreferences	getPreferences(PortletPreferencesIds portletPreferencesIds)
javax.portlet.PortletPreferences	getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, java.lang.String portletId)
javax.portlet.PortletPreferences	getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
PortletPreferencesLocalService	getWrappedPortletPreferencesLocalService() Deprecated. As of 6.1.0, replaced by getWrappedService()
PortletPreferencesLocalService	getWrappedService()
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedPortletPreferencesLocalService(PortletPreferencesLocalService portletPreferencesLocalService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.PortletPreferencesLocalService)
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, java.lang.String portletId, javax.portlet.PortletPreferences portletPreferences)
PortletPreferences	updatePreferences(long ownerId, int ownerType, long plid, java.lang.String portletId, java.lang.String xml)

Methods inherited from class java.lang.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(PortletPreferences portletPreferences)
                                         throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deletePortletPreferences

public PortletPreferences deletePortletPreferences(long portletPreferencesId)
                                            throws PortalException,
                                                   SystemException

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

SystemException - if a system exception occurred

deletePortletPreferences

public PortletPreferences deletePortletPreferences(PortletPreferences portletPreferences)
                                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface PortletPreferencesLocalService

dynamicQuery

public java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Specified by:

dynamicQueryCount in interface PortletPreferencesLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match 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 that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortletPreferences

public PortletPreferences fetchPortletPreferences(long portletPreferencesId)
                                           throws SystemException

Specified by:

fetchPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public PortletPreferences getPortletPreferences(long portletPreferencesId)
                                         throws PortalException,
                                                SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Specified by:

getPersistedModel in interface PortletPreferencesLocalService

Throws:

PortalException

SystemException

getPortletPreferenceses

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

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

Throws:

SystemException - if a system exception occurred

getPortletPreferencesesCount

public int getPortletPreferencesesCount()
                                 throws SystemException

Returns the number of portlet preferenceses.

Specified by:

getPortletPreferencesesCount in interface PortletPreferencesLocalService

Returns:

the number of portlet preferenceses

Throws:

SystemException - if a system exception occurred

updatePortletPreferences

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

Specified by:

updatePortletPreferences in interface PortletPreferencesLocalService

Parameters:

portletPreferences - the portlet preferences

Returns:

the portlet preferences that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface PortletPreferencesLocalService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface PortletPreferencesLocalService

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortletPreferences

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

Specified by:

addPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

deletePortletPreferences

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

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

deletePortletPreferences

public void deletePortletPreferences(long ownerId,
                            int ownerType,
                            long plid,
                            java.lang.String portletId)
                              throws PortalException,
                                     SystemException

Specified by:

deletePortletPreferences in interface PortletPreferencesLocalService

Throws:

PortalException

SystemException

deletePortletPreferencesByPlid

public void deletePortletPreferencesByPlid(long plid)
                                    throws SystemException

Specified by:

deletePortletPreferencesByPlid in interface PortletPreferencesLocalService

Throws:

SystemException

fetchPreferences

public javax.portlet.PortletPreferences fetchPreferences(long companyId,
                                                long ownerId,
                                                int ownerType,
                                                long plid,
                                                java.lang.String portletId)
                                                  throws SystemException

Specified by:

fetchPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

fetchPreferences

public javax.portlet.PortletPreferences fetchPreferences(PortletPreferencesIds portletPreferencesIds)
                                                  throws SystemException

Specified by:

fetchPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getDefaultPreferences

public javax.portlet.PortletPreferences getDefaultPreferences(long companyId,
                                                     java.lang.String portletId)
                                                       throws SystemException

Specified by:

getDefaultPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public java.util.List<PortletPreferences> getPortletPreferences()
                                                         throws SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public java.util.List<PortletPreferences> getPortletPreferences(int ownerType,
                                                       long plid,
                                                       java.lang.String portletId)
                                                         throws SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public java.util.List<PortletPreferences> getPortletPreferences(long ownerId,
                                                       int ownerType,
                                                       long plid)
                                                         throws SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public PortletPreferences getPortletPreferences(long ownerId,
                                       int ownerType,
                                       long plid,
                                       java.lang.String portletId)
                                         throws PortalException,
                                                SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

PortalException

SystemException

getPortletPreferences

public java.util.List<PortletPreferences> getPortletPreferences(long companyId,
                                                       long groupId,
                                                       long ownerId,
                                                       int ownerType,
                                                       java.lang.String portletId,
                                                       boolean privateLayout)
                                                         throws SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferences

public java.util.List<PortletPreferences> getPortletPreferences(long plid,
                                                       java.lang.String portletId)
                                                         throws SystemException

Specified by:

getPortletPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferencesByPlid

public java.util.List<PortletPreferences> getPortletPreferencesByPlid(long plid)
                                                               throws SystemException

Specified by:

getPortletPreferencesByPlid in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferencesCount

public long getPortletPreferencesCount(int ownerType,
                              long plid,
                              java.lang.String portletId)
                                throws SystemException

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferencesCount

public long getPortletPreferencesCount(int ownerType,
                              java.lang.String portletId)
                                throws SystemException

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferencesCount

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

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

Throws:

SystemException

getPortletPreferencesCount

public long getPortletPreferencesCount(long ownerId,
                              int ownerType,
                              java.lang.String portletId,
                              boolean excludeDefaultPreferences)
                                throws SystemException

Specified by:

getPortletPreferencesCount in interface PortletPreferencesLocalService

Throws:

SystemException

getPreferences

public javax.portlet.PortletPreferences getPreferences(long companyId,
                                              long ownerId,
                                              int ownerType,
                                              long plid,
                                              java.lang.String portletId)
                                                throws SystemException

Specified by:

getPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPreferences

public javax.portlet.PortletPreferences getPreferences(long companyId,
                                              long ownerId,
                                              int ownerType,
                                              long plid,
                                              java.lang.String portletId,
                                              java.lang.String defaultPreferences)
                                                throws SystemException

Specified by:

getPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getPreferences

public javax.portlet.PortletPreferences getPreferences(PortletPreferencesIds portletPreferencesIds)
                                                throws SystemException

Specified by:

getPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getStrictPreferences

public javax.portlet.PortletPreferences getStrictPreferences(long companyId,
                                                    long ownerId,
                                                    int ownerType,
                                                    long plid,
                                                    java.lang.String portletId)
                                                      throws SystemException

Specified by:

getStrictPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getStrictPreferences

public javax.portlet.PortletPreferences getStrictPreferences(PortletPreferencesIds portletPreferencesIds)
                                                      throws SystemException

Specified by:

getStrictPreferences in interface PortletPreferencesLocalService

Throws:

SystemException

updatePreferences

public PortletPreferences updatePreferences(long ownerId,
                                   int ownerType,
                                   long plid,
                                   java.lang.String portletId,
                                   javax.portlet.PortletPreferences portletPreferences)
                                     throws SystemException

Specified by:

updatePreferences in interface PortletPreferencesLocalService

Throws:

SystemException

updatePreferences

public PortletPreferences updatePreferences(long ownerId,
                                   int ownerType,
                                   long plid,
                                   java.lang.String portletId,
                                   java.lang.String xml)
                                     throws SystemException

Specified by:

updatePreferences in interface PortletPreferencesLocalService

Throws:

SystemException

getWrappedPortletPreferencesLocalService

public PortletPreferencesLocalService getWrappedPortletPreferencesLocalService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedPortletPreferencesLocalService

public void setWrappedPortletPreferencesLocalService(PortletPreferencesLocalService portletPreferencesLocalService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portal.service.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>