Class NotificationQueueEntryLocalServiceUtil

java.lang.Object
com.liferay.notification.service.NotificationQueueEntryLocalServiceUtil

public class NotificationQueueEntryLocalServiceUtil extends Object
Provides the local service utility for NotificationQueueEntry. This utility wraps com.liferay.notification.service.impl.NotificationQueueEntryLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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.
See Also:
Generated:
  • Constructor Details

    • NotificationQueueEntryLocalServiceUtil

      public NotificationQueueEntryLocalServiceUtil()
  • Method Details

    • addNotificationQueueEntry

      public static NotificationQueueEntry addNotificationQueueEntry(NotificationContext notificationContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addNotificationQueueEntry

      public static NotificationQueueEntry addNotificationQueueEntry(NotificationQueueEntry notificationQueueEntry)
      Adds the notification queue entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationQueueEntryLocalServiceImpl 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:
      notificationQueueEntry - the notification queue entry
      Returns:
      the notification queue entry that was added
    • createNotificationQueueEntry

      public static NotificationQueueEntry createNotificationQueueEntry(long notificationQueueEntryId)
      Creates a new notification queue entry with the primary key. Does not add the notification queue entry to the database.
      Parameters:
      notificationQueueEntryId - the primary key for the new notification queue entry
      Returns:
      the new notification queue entry
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCompanyNotificationQueueEntries

      public static void deleteCompanyNotificationQueueEntries(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteNotificationQueueEntries

      public static void deleteNotificationQueueEntries(Date sentDate) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteNotificationQueueEntry

      public static NotificationQueueEntry deleteNotificationQueueEntry(long notificationQueueEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification queue entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationQueueEntryLocalServiceImpl 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:
      notificationQueueEntryId - the primary key of the notification queue entry
      Returns:
      the notification queue entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a notification queue entry with the primary key could not be found
    • deleteNotificationQueueEntry

      public static NotificationQueueEntry deleteNotificationQueueEntry(NotificationQueueEntry notificationQueueEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification queue entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationQueueEntryLocalServiceImpl 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:
      notificationQueueEntry - the notification queue entry
      Returns:
      the notification queue entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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.notification.model.impl.NotificationQueueEntryModelImpl.

      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

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.notification.model.impl.NotificationQueueEntryModelImpl.

      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

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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

      public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • fetchNotificationQueueEntry

      public static NotificationQueueEntry fetchNotificationQueueEntry(long notificationQueueEntryId)
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getNotificationEntries

      public static List<NotificationQueueEntry> getNotificationEntries(String type, int status)
    • getNotificationQueueEntries

      public static List<NotificationQueueEntry> getNotificationQueueEntries(int start, int end)
      Returns a range of all the notification queue entries.

      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.notification.model.impl.NotificationQueueEntryModelImpl.

      Parameters:
      start - the lower bound of the range of notification queue entries
      end - the upper bound of the range of notification queue entries (not inclusive)
      Returns:
      the range of notification queue entries
    • getNotificationQueueEntriesCount

      public static int getNotificationQueueEntriesCount()
      Returns the number of notification queue entries.
      Returns:
      the number of notification queue entries
    • getNotificationQueueEntry

      public static NotificationQueueEntry getNotificationQueueEntry(long notificationQueueEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification queue entry with the primary key.
      Parameters:
      notificationQueueEntryId - the primary key of the notification queue entry
      Returns:
      the notification queue entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a notification queue entry with the primary key could not be found
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • resendNotificationQueueEntry

      public static NotificationQueueEntry resendNotificationQueueEntry(long notificationQueueEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateNotificationQueueEntry

      public static NotificationQueueEntry updateNotificationQueueEntry(NotificationQueueEntry notificationQueueEntry)
      Updates the notification queue entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect NotificationQueueEntryLocalServiceImpl 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:
      notificationQueueEntry - the notification queue entry
      Returns:
      the notification queue entry that was updated
    • updateStatus

      public static NotificationQueueEntry updateStatus(long notificationQueueEntryId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static NotificationQueueEntryLocalService getService()