Class PortletPreferencesLocalServiceWrapper
- All Implemented Interfaces:
BaseLocalService
,CTService<PortletPreferences>
,PersistedModelLocalService
,PortletPreferencesLocalService
,ServiceWrapper<PortletPreferencesLocalService>
PortletPreferencesLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
ConstructorsConstructorDescriptionPortletPreferencesLocalServiceWrapper
(PortletPreferencesLocalService portletPreferencesLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddPortletPreferences
(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences) addPortletPreferences
(PortletPreferences portletPreferences) Adds the portlet preferences to the database.createPersistedModel
(Serializable primaryKeyObj) createPortletPreferences
(long portletPreferencesId) Creates a new portlet preferences with the primary key.deletePersistedModel
(PersistedModel persistedModel) 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) deletePortletPreferences
(PortletPreferences portletPreferences) Deletes the portlet preferences from the database.void
deletePortletPreferencesByOwnerId
(long ownerId) void
deletePortletPreferencesByPlid
(long plid) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchPortletPreferences
(long portletPreferencesId) fetchPortletPreferences
(long ownerId, int ownerType, long plid, String portletId) fetchPreferences
(long companyId, long ownerId, int ownerType, long plid, String portletId) fetchPreferences
(PortletPreferencesIds portletPreferencesIds) getDefaultPreferences
(long companyId, String portletId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortletInstanceSettings
(long companyId, long groupId, String portletId, PortletInstanceSettingsLocator portletInstanceSettingsLocator, Settings portalPreferencesSettings) getPortletPreferences
(int ownerType, long plid, String portletId) getPortletPreferences
(long portletPreferencesId) Returns the portlet preferences with the primary key.getPortletPreferences
(long ownerId, int ownerType, long plid) getPortletPreferences
(long ownerId, int ownerType, long plid, String portletId) getPortletPreferences
(long companyId, long ownerId, int ownerType, String portletId) getPortletPreferences
(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) getPortletPreferences
(long plid, String portletId) getPortletPreferencesByOwnerId
(long ownerId) getPortletPreferencesByPlid
(long plid) getPortletPreferencesByPortletId
(String portletId) 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) int
getPortletPreferencesCount
(long companyId, long ownerId, int ownerType, String portletId) getPortletPreferenceses
(int start, int end) Returns a range of all the portlet preferenceses.int
Returns the number of portlet preferenceses.getPreferences
(long companyId, long ownerId, int ownerType, long plid, String portletId) getPreferences
(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) getPreferences
(PortletPreferencesIds portletPreferencesIds) getStrictPreferences
(long companyId, long ownerId, int ownerType, long plid, String portletId) getStrictPreferences
(Layout layout, List<Portlet> portlets) getStrictPreferences
(PortletPreferencesIds portletPreferencesIds) void
setWrappedService
(PortletPreferencesLocalService portletPreferencesLocalService) updatePortletPreferences
(PortletPreferences portletPreferences) Updates the portlet preferences in the database or adds it if it does not yet exist.updatePreferences
(long ownerId, int ownerType, long plid, String portletId, String xml) updatePreferences
(long ownerId, int ownerType, long plid, String portletId, PortletPreferences portletPreferences) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<PortletPreferences>, R, E> updateUnsafeFunction) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
PortletPreferencesLocalServiceWrapper
public PortletPreferencesLocalServiceWrapper() -
PortletPreferencesLocalServiceWrapper
public PortletPreferencesLocalServiceWrapper(PortletPreferencesLocalService portletPreferencesLocalService)
-
-
Method Details
-
addPortletPreferences
public PortletPreferences addPortletPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, Portlet portlet, String defaultPreferences) - Specified by:
addPortletPreferences
in interfacePortletPreferencesLocalService
-
addPortletPreferences
Adds the portlet preferences to the database. Also notifies the appropriate model listeners.Important: Inspect PortletPreferencesLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
addPortletPreferences
in interfacePortletPreferencesLocalService
- Parameters:
portletPreferences
- the portlet preferences- Returns:
- the portlet preferences that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Specified by:
createPersistedModel
in interfacePortletPreferencesLocalService
- Throws:
PortalException
PortalException
-
createPortletPreferences
Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.- Specified by:
createPortletPreferences
in interfacePortletPreferencesLocalService
- Parameters:
portletPreferencesId
- the primary key for the new portlet preferences- Returns:
- the new portlet preferences
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Specified by:
deletePersistedModel
in interfacePortletPreferencesLocalService
- Throws:
PortalException
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.Important: Inspect PortletPreferencesLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deletePortletPreferences
in interfacePortletPreferencesLocalService
- 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 foundPortalException
-
deletePortletPreferences
public void deletePortletPreferences(long ownerId, int ownerType, long plid) - Specified by:
deletePortletPreferences
in interfacePortletPreferencesLocalService
-
deletePortletPreferences
public void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException - Specified by:
deletePortletPreferences
in interfacePortletPreferencesLocalService
- Throws:
PortalException
-
deletePortletPreferences
Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.Important: Inspect PortletPreferencesLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
deletePortletPreferences
in interfacePortletPreferencesLocalService
- Parameters:
portletPreferences
- the portlet preferences- Returns:
- the portlet preferences that was removed
-
deletePortletPreferencesByOwnerId
public void deletePortletPreferencesByOwnerId(long ownerId) - Specified by:
deletePortletPreferencesByOwnerId
in interfacePortletPreferencesLocalService
-
deletePortletPreferencesByPlid
public void deletePortletPreferencesByPlid(long plid) - Specified by:
deletePortletPreferencesByPlid
in interfacePortletPreferencesLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
- Specified by:
dslQuery
in interfacePortletPreferencesLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
- Specified by:
dslQueryCount
in interfacePortletPreferencesLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfacePortletPreferencesLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfacePortletPreferencesLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl
.- Specified by:
dynamicQuery
in interfacePortletPreferencesLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl
.- Specified by:
dynamicQuery
in interfacePortletPreferencesLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfacePortletPreferencesLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfacePortletPreferencesLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortletPreferences
- Specified by:
fetchPortletPreferences
in interfacePortletPreferencesLocalService
-
fetchPortletPreferences
public PortletPreferences fetchPortletPreferences(long ownerId, int ownerType, long plid, String portletId) - Specified by:
fetchPortletPreferences
in interfacePortletPreferencesLocalService
-
fetchPreferences
public PortletPreferences fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
fetchPreferences
in interfacePortletPreferencesLocalService
-
fetchPreferences
- Specified by:
fetchPreferences
in interfacePortletPreferencesLocalService
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQuery
in interfacePortletPreferencesLocalService
-
getDefaultPreferences
- Specified by:
getDefaultPreferences
in interfacePortletPreferencesLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfacePortletPreferencesLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfacePortletPreferencesLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Specified by:
getPersistedModel
in interfacePortletPreferencesLocalService
- Throws:
PortalException
PortalException
-
getPortletInstanceSettings
public Settings getPortletInstanceSettings(long companyId, long groupId, String portletId, PortletInstanceSettingsLocator portletInstanceSettingsLocator, Settings portalPreferencesSettings) - Specified by:
getPortletInstanceSettings
in interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
-
getPortletPreferences
Returns the portlet preferences with the primary key.- Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
- 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 foundPortalException
-
getPortletPreferences
- Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
-
getPortletPreferences
public PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException - Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
- Throws:
PortalException
-
getPortletPreferences
public List<PortletPreferences> getPortletPreferences(long companyId, long ownerId, int ownerType, String portletId) throws PortalException - Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
- Throws:
PortalException
-
getPortletPreferences
public List<PortletPreferences> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) - Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferences
in interfacePortletPreferencesLocalService
-
getPortletPreferencesByOwnerId
- Specified by:
getPortletPreferencesByOwnerId
in interfacePortletPreferencesLocalService
-
getPortletPreferencesByPlid
- Specified by:
getPortletPreferencesByPlid
in interfacePortletPreferencesLocalService
-
getPortletPreferencesByPortletId
- Specified by:
getPortletPreferencesByPortletId
in interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
- Specified by:
getPortletPreferencesCount
in interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
- Specified by:
getPortletPreferencesCount
in interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public long getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences) - Specified by:
getPortletPreferencesCount
in interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public long getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences) - Specified by:
getPortletPreferencesCount
in interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public int getPortletPreferencesCount(long companyId, long ownerId, int ownerType, String portletId) - Specified by:
getPortletPreferencesCount
in interfacePortletPreferencesLocalService
-
getPortletPreferenceses
Returns a range of all the portlet preferenceses.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl
.- Specified by:
getPortletPreferenceses
in interfacePortletPreferencesLocalService
- Parameters:
start
- the lower bound of the range of portlet preferencesesend
- 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 interfacePortletPreferencesLocalService
- Returns:
- the number of portlet preferenceses
-
getPreferences
public PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
getPreferences
in interfacePortletPreferencesLocalService
-
getPreferences
public PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) - Specified by:
getPreferences
in interfacePortletPreferencesLocalService
-
getPreferences
- Specified by:
getPreferences
in interfacePortletPreferencesLocalService
-
getStrictPreferences
- Specified by:
getStrictPreferences
in interfacePortletPreferencesLocalService
-
getStrictPreferences
public PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
getStrictPreferences
in interfacePortletPreferencesLocalService
-
getStrictPreferences
- Specified by:
getStrictPreferences
in interfacePortletPreferencesLocalService
-
updatePortletPreferences
Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortletPreferencesLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Specified by:
updatePortletPreferences
in interfacePortletPreferencesLocalService
- 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 interfacePortletPreferencesLocalService
-
updatePreferences
public PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml) - Specified by:
updatePreferences
in interfacePortletPreferencesLocalService
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<PortletPreferences>
- Specified by:
getCTPersistence
in interfacePortletPreferencesLocalService
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<PortletPreferences>
- Specified by:
getModelClass
in interfacePortletPreferencesLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<PortletPreferences>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<PortletPreferences>
- Specified by:
updateWithUnsafeFunction
in interfacePortletPreferencesLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<PortletPreferencesLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<PortletPreferencesLocalService>
-