Class UserNotificationEventLocalServiceUtil

Object
com.liferay.portal.kernel.service.UserNotificationEventLocalServiceUtil

public class UserNotificationEventLocalServiceUtil extends Object
Provides the local service utility for UserNotificationEvent. This utility wraps com.liferay.portal.service.impl.UserNotificationEventLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • UserNotificationEventLocalServiceUtil

      public UserNotificationEventLocalServiceUtil()
  • Method Details

    • addUserNotificationEvent

      public static UserNotificationEvent addUserNotificationEvent(long userId, boolean delivered, boolean actionRequired, NotificationEvent notificationEvent) throws PortalException
      Throws:
      PortalException
    • addUserNotificationEvent

      public static UserNotificationEvent addUserNotificationEvent(long userId, NotificationEvent notificationEvent) throws PortalException
      Throws:
      PortalException
    • addUserNotificationEvent

      public static UserNotificationEvent addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, boolean delivered, String payload, boolean actionRequired, boolean archived, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addUserNotificationEvent

      public static UserNotificationEvent addUserNotificationEvent(long userId, String type, long timestamp, int deliveryType, long deliverBy, String payload, boolean archived, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addUserNotificationEvent

      public static UserNotificationEvent addUserNotificationEvent(UserNotificationEvent userNotificationEvent)
      Adds the user notification event to the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationEventLocalServiceImpl 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:
      userNotificationEvent - the user notification event
      Returns:
      the user notification event that was added
    • addUserNotificationEvents

      public static List<UserNotificationEvent> addUserNotificationEvents(long userId, Collection<NotificationEvent> notificationEvents) throws PortalException
      Throws:
      PortalException
    • archiveUserNotificationEvents

      public static void archiveUserNotificationEvents(long userId, int deliveryType, boolean actionRequired) throws PortalException
      Throws:
      PortalException
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createUserNotificationEvent

      public static UserNotificationEvent createUserNotificationEvent(long userNotificationEventId)
      Creates a new user notification event with the primary key. Does not add the user notification event to the database.
      Parameters:
      userNotificationEventId - the primary key for the new user notification event
      Returns:
      the new user notification event
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteUserNotificationEvent

      public static UserNotificationEvent deleteUserNotificationEvent(long userNotificationEventId) throws PortalException
      Deletes the user notification event with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationEventLocalServiceImpl 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:
      userNotificationEventId - the primary key of the user notification event
      Returns:
      the user notification event that was removed
      Throws:
      PortalException - if a user notification event with the primary key could not be found
    • deleteUserNotificationEvent

      public static void deleteUserNotificationEvent(String uuid, long companyId) throws PortalException
      Throws:
      PortalException
    • deleteUserNotificationEvent

      public static UserNotificationEvent deleteUserNotificationEvent(UserNotificationEvent userNotificationEvent)
      Deletes the user notification event from the database. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationEventLocalServiceImpl 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:
      userNotificationEvent - the user notification event
      Returns:
      the user notification event that was removed
    • deleteUserNotificationEvents

      public static void deleteUserNotificationEvents(Collection<String> uuids, long companyId) throws PortalException
      Throws:
      PortalException
    • deleteUserNotificationEvents

      public static void deleteUserNotificationEvents(long userId) throws PortalException
      Throws:
      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 DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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.UserNotificationEventModelImpl.

      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(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.UserNotificationEventModelImpl.

      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(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(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
    • fetchUserNotificationEvent

      public static UserNotificationEvent fetchUserNotificationEvent(long userNotificationEventId)
    • fetchUserNotificationEventByUuidAndCompanyId

      public static UserNotificationEvent fetchUserNotificationEventByUuidAndCompanyId(String uuid, long companyId)
      Returns the user notification event with the matching UUID and company.
      Parameters:
      uuid - the user notification event's UUID
      companyId - the primary key of the company
      Returns:
      the matching user notification event, or null if a matching user notification event could not be found
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean actionRequired, boolean archived, int start, int end)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, boolean archived, int start, int end)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, boolean archived, int start, int end)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, boolean archived, int start, int end, OrderByComparator<UserNotificationEvent> orderByComparator)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean actionRequired, boolean archived, int start, int end, OrderByComparator<UserNotificationEvent> orderByComparator)
    • getArchivedUserNotificationEvents

      public static List<UserNotificationEvent> getArchivedUserNotificationEvents(long userId, int deliveryType, boolean archived, int start, int end)
    • getArchivedUserNotificationEventsCount

      public static int getArchivedUserNotificationEventsCount(long userId, boolean archived)
    • getArchivedUserNotificationEventsCount

      public static int getArchivedUserNotificationEventsCount(long userId, boolean actionRequired, boolean archived)
    • getArchivedUserNotificationEventsCount

      public static int getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean archived)
    • getArchivedUserNotificationEventsCount

      public static int getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean actionRequired, boolean archived)
    • getArchivedUserNotificationEventsCount

      public static int getArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean actionRequired, boolean archived)
    • getDeliveredArchivedUserNotificationEventsCount

      public static int getDeliveredArchivedUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean archived)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, boolean actionRequired, int start, int end)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, boolean delivered, int start, int end)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, boolean actionRequired, int start, int end, OrderByComparator<UserNotificationEvent> orderByComparator)
    • getDeliveredUserNotificationEvents

      public static List<UserNotificationEvent> getDeliveredUserNotificationEvents(long userId, int deliveryType, boolean delivered, int start, int end)
    • getDeliveredUserNotificationEventsCount

      public static int getDeliveredUserNotificationEventsCount(long userId, boolean delivered)
    • getDeliveredUserNotificationEventsCount

      public static int getDeliveredUserNotificationEventsCount(long userId, boolean delivered, boolean actionRequired)
    • getDeliveredUserNotificationEventsCount

      public static int getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered)
    • getDeliveredUserNotificationEventsCount

      public static int getDeliveredUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean actionRequired)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getTypeNotificationEvents

      public static List<UserNotificationEvent> getTypeNotificationEvents(String type)
    • getUserNotificationEvent

      public static UserNotificationEvent getUserNotificationEvent(long userNotificationEventId) throws PortalException
      Returns the user notification event with the primary key.
      Parameters:
      userNotificationEventId - the primary key of the user notification event
      Returns:
      the user notification event
      Throws:
      PortalException - if a user notification event with the primary key could not be found
    • getUserNotificationEventByUuidAndCompanyId

      public static UserNotificationEvent getUserNotificationEventByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the user notification event with the matching UUID and company.
      Parameters:
      uuid - the user notification event's UUID
      companyId - the primary key of the company
      Returns:
      the matching user notification event
      Throws:
      PortalException - if a matching user notification event could not be found
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(int start, int end)
      Returns a range of all the user notification events.

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

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

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId)
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType)
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId, int start, int end)
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId, int deliveryType, int start, int end)
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId, int start, int end, OrderByComparator<UserNotificationEvent> orderByComparator)
    • getUserNotificationEvents

      public static List<UserNotificationEvent> getUserNotificationEvents(long userId, String type, long timestamp, boolean delivered)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount()
      Returns the number of user notification events.
      Returns:
      the number of user notification events
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId, int deliveryType)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId, int deliveryType, boolean delivered, boolean archived)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId, String type, int deliveryType, boolean delivered)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId, String type, int deliveryType, boolean delivered, boolean archived)
    • getUserNotificationEventsCount

      public static int getUserNotificationEventsCount(long userId, String type, Map<String,String> payloadParameters)
    • sendUserNotificationEvents

      public static UserNotificationEvent sendUserNotificationEvents(long userId, String portletId, int deliveryType, boolean delivered, boolean actionRequired, JSONObject notificationEventJSONObject) throws PortalException
      Throws:
      PortalException
    • sendUserNotificationEvents

      public static UserNotificationEvent sendUserNotificationEvents(long userId, String portletId, int deliveryType, boolean actionRequired, JSONObject notificationEventJSONObject) throws PortalException
      Throws:
      PortalException
    • sendUserNotificationEvents

      public static UserNotificationEvent sendUserNotificationEvents(long userId, String portletId, int deliveryType, JSONObject notificationEventJSONObject) throws PortalException
      Throws:
      PortalException
    • updateUserNotificationEvent

      public static UserNotificationEvent updateUserNotificationEvent(String uuid, long companyId, boolean archive)
    • updateUserNotificationEvent

      public static UserNotificationEvent updateUserNotificationEvent(UserNotificationEvent userNotificationEvent)
      Updates the user notification event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect UserNotificationEventLocalServiceImpl 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:
      userNotificationEvent - the user notification event
      Returns:
      the user notification event that was updated
    • updateUserNotificationEvents

      public static List<UserNotificationEvent> updateUserNotificationEvents(Collection<String> uuids, long companyId, boolean archive)
    • getService

      public static UserNotificationEventLocalService getService()
    • setService

      public static void setService(UserNotificationEventLocalService service)