Interface NotificationTemplateLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
NotificationTemplateLocalServiceWrapper

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface NotificationTemplateLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for NotificationTemplate. 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:
  • Method Details

    • addNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate addNotificationTemplate(NotificationContext notificationContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate addNotificationTemplate(NotificationTemplate notificationTemplate)
      Adds the notification template to the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationTemplateLocalServiceImpl 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:
      notificationTemplate - the notification template
      Returns:
      the notification template that was added
    • addNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate addNotificationTemplate(String externalReferenceCode, long userId, String type) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSubscriptionNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate addSubscriptionNotificationTemplate(String externalReferenceCode, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createNotificationTemplate

      @Transactional(enabled=false) NotificationTemplate createNotificationTemplate(long notificationTemplateId)
      Creates a new notification template with the primary key. Does not add the notification template to the database.
      Parameters:
      notificationTemplateId - the primary key for the new notification template
      Returns:
      the new notification template
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCompanyNotificationTemplates

      void deleteCompanyNotificationTemplates(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteNotificationTemplate

      @Indexable(type=DELETE) NotificationTemplate deleteNotificationTemplate(long notificationTemplateId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification template with the primary key from the database. Also notifies the appropriate model listeners.

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

      @Indexable(type=DELETE) @SystemEvent(type=1) NotificationTemplate deleteNotificationTemplate(NotificationTemplate notificationTemplate) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the notification template from the database. Also notifies the appropriate model listeners.

      Important: Inspect NotificationTemplateLocalServiceImpl 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:
      notificationTemplate - the notification template
      Returns:
      the notification template that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.NotificationTemplateModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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
    • fetchNotificationTemplate

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate fetchNotificationTemplate(long notificationTemplateId)
    • fetchNotificationTemplateByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate fetchNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchNotificationTemplateByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate fetchNotificationTemplateByUuidAndCompanyId(String uuid, long companyId)
      Returns the notification template with the matching UUID and company.
      Parameters:
      uuid - the notification template's UUID
      companyId - the primary key of the company
      Returns:
      the matching notification template, or null if a matching notification template could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getNotificationTemplate

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate getNotificationTemplate(long notificationTemplateId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification template with the primary key.
      Parameters:
      notificationTemplateId - the primary key of the notification template
      Returns:
      the notification template
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a notification template with the primary key could not be found
    • getNotificationTemplateByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate getNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getNotificationTemplateByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) NotificationTemplate getNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the notification template with the matching UUID and company.
      Parameters:
      uuid - the notification template's UUID
      companyId - the primary key of the company
      Returns:
      the matching notification template
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching notification template could not be found
    • getNotificationTemplates

      @Transactional(propagation=SUPPORTS, readOnly=true) List<NotificationTemplate> getNotificationTemplates(int start, int end)
      Returns a range of all the notification templates.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getNotificationTemplatesCount()
      Returns the number of notification templates.
      Returns:
      the number of notification templates
    • getOSGiServiceIdentifier

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate updateNotificationTemplate(NotificationContext notificationContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateNotificationTemplate

      @Indexable(type=REINDEX) NotificationTemplate updateNotificationTemplate(NotificationTemplate notificationTemplate)
      Updates the notification template in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect NotificationTemplateLocalServiceImpl 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:
      notificationTemplate - the notification template
      Returns:
      the notification template that was updated