Interface PortalPreferenceValueLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
PortalPreferenceValueLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPortalPreferenceValue
(PortalPreferenceValue portalPreferenceValue) Adds the portal preference value to the database.createPersistedModel
(Serializable primaryKeyObj) createPortalPreferenceValue
(long portalPreferenceValueId) Creates a new portal preference value with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortalPreferenceValue
(long portalPreferenceValueId) Deletes the portal preference value with the primary key from the database.deletePortalPreferenceValue
(PortalPreferenceValue portalPreferenceValue) Deletes the portal 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.fetchPortalPreferenceValue
(long portalPreferenceValueId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortalPreferences
(PortalPreferences portalPreferences, boolean signedIn) getPortalPreferenceValue
(long portalPreferenceValueId) Returns the portal preference value with the primary key.getPortalPreferenceValues
(int start, int end) Returns a range of all the portal preference values.int
Returns the number of portal preference values.updatePortalPreferenceValue
(PortalPreferenceValue portalPreferenceValue) Updates the portal preference value in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPortalPreferenceValue
@Indexable(type=REINDEX) PortalPreferenceValue addPortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Adds the portal preference value to the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferenceValueLocalServiceImpl 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:
portalPreferenceValue
- the portal preference value- Returns:
- the portal preference value that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createPortalPreferenceValue
@Transactional(enabled=false) PortalPreferenceValue createPortalPreferenceValue(long portalPreferenceValueId) Creates a new portal preference value with the primary key. Does not add the portal preference value to the database.- Parameters:
portalPreferenceValueId
- the primary key for the new portal preference value- Returns:
- the new portal preference value
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deletePortalPreferenceValue
@Indexable(type=DELETE) PortalPreferenceValue deletePortalPreferenceValue(long portalPreferenceValueId) throws PortalException Deletes the portal preference value with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferenceValueLocalServiceImpl 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:
portalPreferenceValueId
- the primary key of the portal preference value- Returns:
- the portal preference value that was removed
- Throws:
PortalException
- if a portal preference value with the primary key could not be found
-
deletePortalPreferenceValue
@Indexable(type=DELETE) PortalPreferenceValue deletePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Deletes the portal preference value from the database. Also notifies the appropriate model listeners.Important: Inspect PortalPreferenceValueLocalServiceImpl 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:
portalPreferenceValue
- the portal preference value- Returns:
- the portal 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.PortalPreferenceValueModelImpl
.- 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.PortalPreferenceValueModelImpl
.- 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
-
fetchPortalPreferenceValue
@Transactional(propagation=SUPPORTS, readOnly=true) PortalPreferenceValue fetchPortalPreferenceValue(long portalPreferenceValueId) -
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
-
getPortalPreferences
@Transactional(propagation=SUPPORTS, readOnly=true) PortalPreferences getPortalPreferences(PortalPreferences portalPreferences, boolean signedIn) -
getPortalPreferenceValue
@Transactional(propagation=SUPPORTS, readOnly=true) PortalPreferenceValue getPortalPreferenceValue(long portalPreferenceValueId) throws PortalException Returns the portal preference value with the primary key.- Parameters:
portalPreferenceValueId
- the primary key of the portal preference value- Returns:
- the portal preference value
- Throws:
PortalException
- if a portal preference value with the primary key could not be found
-
getPortalPreferenceValues
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortalPreferenceValue> getPortalPreferenceValues(int start, int end) Returns a range of all the portal 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.PortalPreferenceValueModelImpl
.- Parameters:
start
- the lower bound of the range of portal preference valuesend
- the upper bound of the range of portal preference values (not inclusive)- Returns:
- the range of portal preference values
-
getPortalPreferenceValuesCount
Returns the number of portal preference values.- Returns:
- the number of portal preference values
-
updatePortalPreferenceValue
@Indexable(type=REINDEX) PortalPreferenceValue updatePortalPreferenceValue(PortalPreferenceValue portalPreferenceValue) Updates the portal preference value in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortalPreferenceValueLocalServiceImpl 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:
portalPreferenceValue
- the portal preference value- Returns:
- the portal preference value that was updated
-