Interface UserNotificationDeliveryLocalService

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

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface UserNotificationDeliveryLocalService extends BaseLocalService, PersistedModelLocalService
Provides the local service interface for UserNotificationDelivery. 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

    • addUserNotificationDelivery

      UserNotificationDelivery addUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException
      Throws:
      PortalException
    • addUserNotificationDelivery

      @Indexable(type=REINDEX) UserNotificationDelivery addUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
      Adds the user notification delivery to the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationDeliveryLocalServiceImpl 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:
      userNotificationDelivery - the user notification delivery
      Returns:
      the user notification delivery that was added
    • createPersistedModel

      PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Specified by:
      createPersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • createUserNotificationDelivery

      @Transactional(enabled=false) UserNotificationDelivery createUserNotificationDelivery(long userNotificationDeliveryId)
      Creates a new user notification delivery with the primary key. Does not add the user notification delivery to the database.
      Parameters:
      userNotificationDeliveryId - the primary key for the new user notification delivery
      Returns:
      the new user notification delivery
    • deletePersistedModel

      PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Specified by:
      deletePersistedModel in interface PersistedModelLocalService
      Throws:
      PortalException
    • deleteUserNotificationDeliveries

      void deleteUserNotificationDeliveries(long userId)
    • deleteUserNotificationDelivery

      @Indexable(type=DELETE) UserNotificationDelivery deleteUserNotificationDelivery(long userNotificationDeliveryId) throws PortalException
      Deletes the user notification delivery with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationDeliveryLocalServiceImpl 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:
      userNotificationDeliveryId - the primary key of the user notification delivery
      Returns:
      the user notification delivery that was removed
      Throws:
      PortalException - if a user notification delivery with the primary key could not be found
    • deleteUserNotificationDelivery

      void deleteUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
    • deleteUserNotificationDelivery

      @Indexable(type=DELETE) UserNotificationDelivery deleteUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
      Deletes the user notification delivery from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationDeliveryLocalServiceImpl 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:
      userNotificationDelivery - the user notification delivery
      Returns:
      the user notification delivery 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.UserNotificationDeliveryModelImpl.

      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.UserNotificationDeliveryModelImpl.

      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
    • fetchUserNotificationDelivery

      @Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery fetchUserNotificationDelivery(long userNotificationDeliveryId)
    • fetchUserNotificationDelivery

      @Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery fetchUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType)
    • 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
    • getUserNotificationDeliveries

      @Transactional(propagation=SUPPORTS, readOnly=true) List<UserNotificationDelivery> getUserNotificationDeliveries(int start, int end)
      Returns a range of all the user notification deliveries.

      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.UserNotificationDeliveryModelImpl.

      Parameters:
      start - the lower bound of the range of user notification deliveries
      end - the upper bound of the range of user notification deliveries (not inclusive)
      Returns:
      the range of user notification deliveries
    • getUserNotificationDeliveriesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getUserNotificationDeliveriesCount()
      Returns the number of user notification deliveries.
      Returns:
      the number of user notification deliveries
    • getUserNotificationDelivery

      @Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery getUserNotificationDelivery(long userNotificationDeliveryId) throws PortalException
      Returns the user notification delivery with the primary key.
      Parameters:
      userNotificationDeliveryId - the primary key of the user notification delivery
      Returns:
      the user notification delivery
      Throws:
      PortalException - if a user notification delivery with the primary key could not be found
    • getUserNotificationDelivery

      @Transactional(propagation=SUPPORTS, readOnly=true) UserNotificationDelivery getUserNotificationDelivery(long userId, String portletId, long classNameId, int notificationType, int deliveryType, boolean deliver) throws PortalException
      Throws:
      PortalException
    • updateUserNotificationDelivery

      UserNotificationDelivery updateUserNotificationDelivery(long userNotificationDeliveryId, boolean deliver)
    • updateUserNotificationDelivery

      @Indexable(type=REINDEX) UserNotificationDelivery updateUserNotificationDelivery(UserNotificationDelivery userNotificationDelivery)
      Updates the user notification delivery in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationDeliveryLocalServiceImpl 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:
      userNotificationDelivery - the user notification delivery
      Returns:
      the user notification delivery that was updated