Class NotificationRecipientLocalServiceUtil

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

public class NotificationRecipientLocalServiceUtil extends Object
Provides the local service utility for NotificationRecipient. This utility wraps com.liferay.notification.service.impl.NotificationRecipientLocalServiceImpl 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

    • NotificationRecipientLocalServiceUtil

      public NotificationRecipientLocalServiceUtil()
  • Method Details

    • addNotificationRecipient

      public static NotificationRecipient addNotificationRecipient(NotificationRecipient notificationRecipient)
      Adds the notification recipient to the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationRecipientLocalServiceImpl 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:
      notificationRecipient - the notification recipient
      Returns:
      the notification recipient that was added
    • createNotificationRecipient

      public static NotificationRecipient createNotificationRecipient(long notificationRecipientId)
      Creates a new notification recipient with the primary key. Does not add the notification recipient to the database.
      Parameters:
      notificationRecipientId - the primary key for the new notification recipient
      Returns:
      the new notification recipient
    • 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
    • deleteNotificationRecipient

      public static NotificationRecipient deleteNotificationRecipient(long notificationRecipientId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification recipient with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static NotificationRecipient deleteNotificationRecipient(NotificationRecipient notificationRecipient)
      Deletes the notification recipient from the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationRecipientLocalServiceImpl 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:
      notificationRecipient - the notification recipient
      Returns:
      the notification recipient that was removed
    • 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.NotificationRecipientModelImpl.

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

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

      public static NotificationRecipient fetchNotificationRecipient(long notificationRecipientId)
    • fetchNotificationRecipientByUuidAndCompanyId

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

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

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

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

      public static NotificationRecipient getNotificationRecipient(long notificationRecipientId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification recipient with the primary key.
      Parameters:
      notificationRecipientId - the primary key of the notification recipient
      Returns:
      the notification recipient
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a notification recipient with the primary key could not be found
    • getNotificationRecipientByClassPK

      public static NotificationRecipient getNotificationRecipientByClassPK(long classPK)
    • getNotificationRecipientByUuidAndCompanyId

      public static NotificationRecipient getNotificationRecipientByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification recipient with the matching UUID and company.
      Parameters:
      uuid - the notification recipient's UUID
      companyId - the primary key of the company
      Returns:
      the matching notification recipient
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching notification recipient could not be found
    • getNotificationRecipients

      public static List<NotificationRecipient> getNotificationRecipients(int start, int end)
      Returns a range of all the notification recipients.

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

      Parameters:
      start - the lower bound of the range of notification recipients
      end - the upper bound of the range of notification recipients (not inclusive)
      Returns:
      the range of notification recipients
    • getNotificationRecipientsCount

      public static int getNotificationRecipientsCount()
      Returns the number of notification recipients.
      Returns:
      the number of notification recipients
    • 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
    • updateNotificationRecipient

      public static NotificationRecipient updateNotificationRecipient(NotificationRecipient notificationRecipient)
      Updates the notification recipient in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect NotificationRecipientLocalServiceImpl 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:
      notificationRecipient - the notification recipient
      Returns:
      the notification recipient that was updated
    • getService

      public static NotificationRecipientLocalService getService()