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.voiddeletePortletPreferences(long ownerId, int ownerType, long plid) voiddeletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) deletePortletPreferences(PortletPreferences portletPreferences) Deletes the portlet preferences from the database.voiddeletePortletPreferencesByOwnerId(long ownerId) voiddeletePortletPreferencesByPlid(long plid) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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) longgetPortletPreferencesCount(int ownerType, long plid, String portletId) longgetPortletPreferencesCount(int ownerType, String portletId) longgetPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences) longgetPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences) intgetPortletPreferencesCount(long companyId, long ownerId, int ownerType, String portletId) getPortletPreferenceses(int start, int end) Returns a range of all the portlet preferenceses.intReturns 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) voidsetWrappedService(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, waitMethods 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:
addPortletPreferencesin 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:
addPortletPreferencesin interfacePortletPreferencesLocalService- Parameters:
portletPreferences- the portlet preferences- Returns:
- the portlet preferences that was added
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Specified by:
createPersistedModelin interfacePortletPreferencesLocalService- Throws:
PortalExceptionPortalException
-
createPortletPreferences
Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.- Specified by:
createPortletPreferencesin interfacePortletPreferencesLocalService- Parameters:
portletPreferencesId- the primary key for the new portlet preferences- Returns:
- the new portlet preferences
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Specified by:
deletePersistedModelin interfacePortletPreferencesLocalService- Throws:
PortalExceptionPortalException
-
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:
deletePortletPreferencesin 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:
deletePortletPreferencesin interfacePortletPreferencesLocalService
-
deletePortletPreferences
public void deletePortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException - Specified by:
deletePortletPreferencesin 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:
deletePortletPreferencesin interfacePortletPreferencesLocalService- Parameters:
portletPreferences- the portlet preferences- Returns:
- the portlet preferences that was removed
-
deletePortletPreferencesByOwnerId
public void deletePortletPreferencesByOwnerId(long ownerId) - Specified by:
deletePortletPreferencesByOwnerIdin interfacePortletPreferencesLocalService
-
deletePortletPreferencesByPlid
public void deletePortletPreferencesByPlid(long plid) - Specified by:
deletePortletPreferencesByPlidin interfacePortletPreferencesLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService- Specified by:
dslQueryin interfacePortletPreferencesLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacePersistedModelLocalService- Specified by:
dslQueryCountin interfacePortletPreferencesLocalService
-
dynamicQuery
- Specified by:
dynamicQueryin interfacePortletPreferencesLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl.- Specified by:
dynamicQueryin 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:
dynamicQueryCountin 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:
dynamicQueryCountin 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:
fetchPortletPreferencesin interfacePortletPreferencesLocalService
-
fetchPortletPreferences
public PortletPreferences fetchPortletPreferences(long ownerId, int ownerType, long plid, String portletId) - Specified by:
fetchPortletPreferencesin interfacePortletPreferencesLocalService
-
fetchPreferences
public PortletPreferences fetchPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
fetchPreferencesin interfacePortletPreferencesLocalService
-
fetchPreferences
- Specified by:
fetchPreferencesin interfacePortletPreferencesLocalService
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQueryin interfacePortletPreferencesLocalService
-
getDefaultPreferences
- Specified by:
getDefaultPreferencesin interfacePortletPreferencesLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQueryin interfacePortletPreferencesLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfacePortletPreferencesLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModelin interfacePersistedModelLocalService- Specified by:
getPersistedModelin interfacePortletPreferencesLocalService- Throws:
PortalExceptionPortalException
-
getPortletInstanceSettings
public Settings getPortletInstanceSettings(long companyId, long groupId, String portletId, PortletInstanceSettingsLocator portletInstanceSettingsLocator, Settings portalPreferencesSettings) - Specified by:
getPortletInstanceSettingsin interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService
-
getPortletPreferences
Returns the portlet preferences with the primary key.- Specified by:
getPortletPreferencesin 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:
getPortletPreferencesin interfacePortletPreferencesLocalService
-
getPortletPreferences
public PortletPreferences getPortletPreferences(long ownerId, int ownerType, long plid, String portletId) throws PortalException - Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService- Throws:
PortalException
-
getPortletPreferences
public List<PortletPreferences> getPortletPreferences(long companyId, long ownerId, int ownerType, String portletId) throws PortalException - Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService- Throws:
PortalException
-
getPortletPreferences
public List<PortletPreferences> getPortletPreferences(long companyId, long groupId, long ownerId, int ownerType, String portletId, boolean privateLayout) - Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService
-
getPortletPreferences
- Specified by:
getPortletPreferencesin interfacePortletPreferencesLocalService
-
getPortletPreferencesByOwnerId
- Specified by:
getPortletPreferencesByOwnerIdin interfacePortletPreferencesLocalService
-
getPortletPreferencesByPlid
- Specified by:
getPortletPreferencesByPlidin interfacePortletPreferencesLocalService
-
getPortletPreferencesByPortletId
- Specified by:
getPortletPreferencesByPortletIdin interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
- Specified by:
getPortletPreferencesCountin interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
- Specified by:
getPortletPreferencesCountin interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public long getPortletPreferencesCount(long ownerId, int ownerType, long plid, Portlet portlet, boolean excludeDefaultPreferences) - Specified by:
getPortletPreferencesCountin interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public long getPortletPreferencesCount(long ownerId, int ownerType, String portletId, boolean excludeDefaultPreferences) - Specified by:
getPortletPreferencesCountin interfacePortletPreferencesLocalService
-
getPortletPreferencesCount
public int getPortletPreferencesCount(long companyId, long ownerId, int ownerType, String portletId) - Specified by:
getPortletPreferencesCountin interfacePortletPreferencesLocalService
-
getPortletPreferenceses
Returns a range of all the portlet preferenceses.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletPreferencesModelImpl.- Specified by:
getPortletPreferencesesin 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:
getPortletPreferencesesCountin interfacePortletPreferencesLocalService- Returns:
- the number of portlet preferenceses
-
getPreferences
public PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
getPreferencesin interfacePortletPreferencesLocalService
-
getPreferences
public PortletPreferences getPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId, String defaultPreferences) - Specified by:
getPreferencesin interfacePortletPreferencesLocalService
-
getPreferences
- Specified by:
getPreferencesin interfacePortletPreferencesLocalService
-
getStrictPreferences
- Specified by:
getStrictPreferencesin interfacePortletPreferencesLocalService
-
getStrictPreferences
public PortletPreferences getStrictPreferences(long companyId, long ownerId, int ownerType, long plid, String portletId) - Specified by:
getStrictPreferencesin interfacePortletPreferencesLocalService
-
getStrictPreferences
- Specified by:
getStrictPreferencesin 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:
updatePortletPreferencesin 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:
updatePreferencesin interfacePortletPreferencesLocalService
-
updatePreferences
public PortletPreferences updatePreferences(long ownerId, int ownerType, long plid, String portletId, String xml) - Specified by:
updatePreferencesin interfacePortletPreferencesLocalService
-
getBasePersistence
- Specified by:
getBasePersistencein interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistencein interfaceCTService<PortletPreferences>- Specified by:
getCTPersistencein interfacePortletPreferencesLocalService
-
getModelClass
- Specified by:
getModelClassin interfaceCTService<PortletPreferences>- Specified by:
getModelClassin interfacePortletPreferencesLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<PortletPreferences>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfaceCTService<PortletPreferences>- Specified by:
updateWithUnsafeFunctionin interfacePortletPreferencesLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfaceServiceWrapper<PortletPreferencesLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfaceServiceWrapper<PortletPreferencesLocalService>
-