Interface PortletPreferenceValueLocalService
- All Superinterfaces:
BaseLocalService
,CTService<PortletPreferenceValue>
,PersistedModelLocalService
- All Known Implementing Classes:
PortletPreferenceValueLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPortletPreferenceValue
(PortletPreferenceValue portletPreferenceValue) Adds the portlet preference value to the database.createPersistedModel
(Serializable primaryKeyObj) createPortletPreferenceValue
(long portletPreferenceValueId) Creates a new portlet preference value with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortletPreferenceValue
(long portletPreferenceValueId) Deletes the portlet preference value with the primary key from the database.deletePortletPreferenceValue
(PortletPreferenceValue portletPreferenceValue) Deletes the portlet preference value from the database.<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.fetchPortletPreferenceValue
(long portletPreferenceValueId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortletPreferenceValue
(long portletPreferenceValueId) Returns the portlet preference value with the primary key.getPortletPreferenceValues
(int start, int end) Returns a range of all the portlet preference values.int
Returns the number of portlet preference values.int
getPortletPreferenceValuesCount
(long companyId, String name, String smallValue) getPreferences
(PortletPreferences portletPreferences) updatePortletPreferenceValue
(PortletPreferenceValue portletPreferenceValue) Updates the portlet preference value in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<PortletPreferenceValue>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPortletPreferenceValue
@Indexable(type=REINDEX) PortletPreferenceValue addPortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Adds the portlet preference value to the database. Also notifies the appropriate model listeners.Important: Inspect PortletPreferenceValueLocalServiceImpl 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.
- Parameters:
portletPreferenceValue
- the portlet preference value- Returns:
- the portlet preference value that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createPortletPreferenceValue
@Transactional(enabled=false) PortletPreferenceValue createPortletPreferenceValue(long portletPreferenceValueId) Creates a new portlet preference value with the primary key. Does not add the portlet preference value to the database.- Parameters:
portletPreferenceValueId
- the primary key for the new portlet preference value- Returns:
- the new portlet preference value
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deletePortletPreferenceValue
@Indexable(type=DELETE) PortletPreferenceValue deletePortletPreferenceValue(long portletPreferenceValueId) throws PortalException Deletes the portlet preference value with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortletPreferenceValueLocalServiceImpl 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.
- Parameters:
portletPreferenceValueId
- the primary key of the portlet preference value- Returns:
- the portlet preference value that was removed
- Throws:
PortalException
- if a portlet preference value with the primary key could not be found
-
deletePortletPreferenceValue
@Indexable(type=DELETE) PortletPreferenceValue deletePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Deletes the portlet preference value from the database. Also notifies the appropriate model listeners.Important: Inspect PortletPreferenceValueLocalServiceImpl 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.
- Parameters:
portletPreferenceValue
- the portlet preference value- Returns:
- the portlet preference value that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
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.PortletPreferenceValueModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
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.PortletPreferenceValueModelImpl
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortletPreferenceValue
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferenceValue fetchPortletPreferenceValue(long portletPreferenceValueId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getPortletPreferenceValue
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferenceValue getPortletPreferenceValue(long portletPreferenceValueId) throws PortalException Returns the portlet preference value with the primary key.- Parameters:
portletPreferenceValueId
- the primary key of the portlet preference value- Returns:
- the portlet preference value
- Throws:
PortalException
- if a portlet preference value with the primary key could not be found
-
getPortletPreferenceValues
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletPreferenceValue> getPortletPreferenceValues(int start, int end) Returns a range of all the portlet preference values.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.PortletPreferenceValueModelImpl
.- Parameters:
start
- the lower bound of the range of portlet preference valuesend
- the upper bound of the range of portlet preference values (not inclusive)- Returns:
- the range of portlet preference values
-
getPortletPreferenceValuesCount
Returns the number of portlet preference values.- Returns:
- the number of portlet preference values
-
getPortletPreferenceValuesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getPortletPreferenceValuesCount(long companyId, String name, String smallValue) -
getPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) PortletPreferences getPreferences(PortletPreferences portletPreferences) -
updatePortletPreferenceValue
@Indexable(type=REINDEX) PortletPreferenceValue updatePortletPreferenceValue(PortletPreferenceValue portletPreferenceValue) Updates the portlet preference value in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortletPreferenceValueLocalServiceImpl 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.
- Parameters:
portletPreferenceValue
- the portlet preference value- Returns:
- the portlet preference value that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<PortletPreferenceValue>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<PortletPreferenceValue>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<PortletPreferenceValue>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<PortletPreferenceValue>
- Throws:
E extends Throwable
-