Class NotificationRecipientSettingLocalServiceUtil

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

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

    • NotificationRecipientSettingLocalServiceUtil

      public NotificationRecipientSettingLocalServiceUtil()
  • Method Details

    • addNotificationRecipientSetting

      public static NotificationRecipientSetting addNotificationRecipientSetting(long userId, long notificationRecipientId, String name, Object value) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addNotificationRecipientSetting

      public static NotificationRecipientSetting addNotificationRecipientSetting(NotificationRecipientSetting notificationRecipientSetting)
      Adds the notification recipient setting to the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationRecipientSettingLocalServiceImpl 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:
      notificationRecipientSetting - the notification recipient setting
      Returns:
      the notification recipient setting that was added
    • createNotificationRecipientSetting

      public static NotificationRecipientSetting createNotificationRecipientSetting(long notificationRecipientSettingId)
      Creates a new notification recipient setting with the primary key. Does not add the notification recipient setting to the database.
      Parameters:
      notificationRecipientSettingId - the primary key for the new notification recipient setting
      Returns:
      the new notification recipient setting
    • 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
    • deleteNotificationRecipientSetting

      public static NotificationRecipientSetting deleteNotificationRecipientSetting(long notificationRecipientSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification recipient setting with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static NotificationRecipientSetting deleteNotificationRecipientSetting(NotificationRecipientSetting notificationRecipientSetting)
      Deletes the notification recipient setting from the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationRecipientSettingLocalServiceImpl 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:
      notificationRecipientSetting - the notification recipient setting
      Returns:
      the notification recipient setting 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.NotificationRecipientSettingModelImpl.

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

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

      public static NotificationRecipientSetting fetchNotificationRecipientSetting(long notificationRecipientSettingId)
    • fetchNotificationRecipientSetting

      public static NotificationRecipientSetting fetchNotificationRecipientSetting(long notificationRecipientId, String name)
    • fetchNotificationRecipientSettingByUuidAndCompanyId

      public static NotificationRecipientSetting fetchNotificationRecipientSettingByUuidAndCompanyId(String uuid, long companyId)
      Returns the notification recipient setting with the matching UUID and company.
      Parameters:
      uuid - the notification recipient setting's UUID
      companyId - the primary key of the company
      Returns:
      the matching notification recipient setting, or null if a matching notification recipient setting 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()
    • getNotificationRecipientSetting

      public static NotificationRecipientSetting getNotificationRecipientSetting(long notificationRecipientSettingId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification recipient setting with the primary key.
      Parameters:
      notificationRecipientSettingId - the primary key of the notification recipient setting
      Returns:
      the notification recipient setting
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a notification recipient setting with the primary key could not be found
    • getNotificationRecipientSettingByUuidAndCompanyId

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

      public static List<NotificationRecipientSetting> getNotificationRecipientSettings(int start, int end)
      Returns a range of all the notification recipient settings.

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

      Parameters:
      start - the lower bound of the range of notification recipient settings
      end - the upper bound of the range of notification recipient settings (not inclusive)
      Returns:
      the range of notification recipient settings
    • getNotificationRecipientSettings

      public static List<NotificationRecipientSetting> getNotificationRecipientSettings(long notificationRecipientId)
    • getNotificationRecipientSettingsCount

      public static int getNotificationRecipientSettingsCount()
      Returns the number of notification recipient settings.
      Returns:
      the number of notification recipient settings
    • 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
    • updateNotificationRecipientSetting

      public static NotificationRecipientSetting updateNotificationRecipientSetting(long notificationRecipientId, String name, Object value)
    • updateNotificationRecipientSetting

      public static NotificationRecipientSetting updateNotificationRecipientSetting(NotificationRecipientSetting notificationRecipientSetting)
      Updates the notification recipient setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

      public static NotificationRecipientSettingLocalService getService()