Interface PortalPreferenceValueLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PortalPreferenceValueLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface PortalPreferenceValueLocalService extends BaseLocalService, PersistedModelLocalService
Provides the local service interface for PortalPreferenceValue. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • 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

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      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

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      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 interface PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface PersistedModelLocalService
    • 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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortalPreferenceValueModelImpl.

      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
    • 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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortalPreferenceValueModelImpl.

      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
    • 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 query
      projection - 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

    • 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 interface PersistedModelLocalService
      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 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portal.model.impl.PortalPreferenceValueModelImpl.

      Parameters:
      start - the lower bound of the range of portal preference values
      end - the upper bound of the range of portal preference values (not inclusive)
      Returns:
      the range of portal preference values
    • getPortalPreferenceValuesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int 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