Class NotificationTemplateLocalServiceUtil
com.liferay.notification.service.impl.NotificationTemplateLocalServiceImpl 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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic NotificationTemplateaddNotificationTemplate(NotificationContext notificationContext) static NotificationTemplateaddNotificationTemplate(NotificationTemplate notificationTemplate) Adds the notification template to the database.static NotificationTemplateaddNotificationTemplate(String externalReferenceCode, long userId, String type) static NotificationTemplateaddSubscriptionNotificationTemplate(String externalReferenceCode, long userId) static NotificationTemplatecreateNotificationTemplate(long notificationTemplateId) Creates a new notification template with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static voiddeleteCompanyNotificationTemplates(long companyId) static NotificationTemplatedeleteNotificationTemplate(long notificationTemplateId) Deletes the notification template with the primary key from the database.static NotificationTemplatedeleteNotificationTemplate(NotificationTemplate notificationTemplate) Deletes the notification template from the database.static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static NotificationTemplatefetchNotificationTemplate(long notificationTemplateId) static NotificationTemplatefetchNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) static NotificationTemplatefetchNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) Returns the notification template with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic NotificationTemplategetNotificationTemplate(long notificationTemplateId) Returns the notification template with the primary key.static NotificationTemplategetNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) static NotificationTemplategetNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) Returns the notification template with the matching UUID and company.static List<NotificationTemplate> getNotificationTemplates(int start, int end) Returns a range of all the notification templates.static intReturns the number of notification templates.static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static NotificationTemplateupdateNotificationTemplate(NotificationContext notificationContext) static NotificationTemplateupdateNotificationTemplate(NotificationTemplate notificationTemplate) Updates the notification template in the database or adds it if it does not yet exist.
-
Constructor Details
-
NotificationTemplateLocalServiceUtil
public NotificationTemplateLocalServiceUtil()
-
-
Method Details
-
addNotificationTemplate
public static NotificationTemplate addNotificationTemplate(NotificationContext notificationContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addNotificationTemplate
public static 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
public static NotificationTemplate addNotificationTemplate(String externalReferenceCode, long userId, String type) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSubscriptionNotificationTemplate
public static NotificationTemplate addSubscriptionNotificationTemplate(String externalReferenceCode, long userId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createNotificationTemplate
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
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
-
deleteCompanyNotificationTemplates
public static void deleteCompanyNotificationTemplates(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteNotificationTemplate
public static 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
public static 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
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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.notification.model.impl.NotificationTemplateModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.notification.model.impl.NotificationTemplateModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchNotificationTemplate
-
fetchNotificationTemplateByExternalReferenceCode
public static NotificationTemplate fetchNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchNotificationTemplateByUuidAndCompanyId
public static NotificationTemplate fetchNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) Returns the notification template with the matching UUID and company.- Parameters:
uuid- the notification template's UUIDcompanyId- the primary key of the company- Returns:
- the matching notification template, or
nullif a matching notification template 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() -
getNotificationTemplate
public static 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
public static NotificationTemplate getNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getNotificationTemplateByUuidAndCompanyId
public static 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 UUIDcompanyId- 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
Returns a range of all the notification templates.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.notification.model.impl.NotificationTemplateModelImpl.- Parameters:
start- the lower bound of the range of notification templatesend- the upper bound of the range of notification templates (not inclusive)- Returns:
- the range of notification templates
-
getNotificationTemplatesCount
public static int getNotificationTemplatesCount()Returns the number of notification templates.- Returns:
- the number of notification templates
-
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
-
updateNotificationTemplate
public static NotificationTemplate updateNotificationTemplate(NotificationContext notificationContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateNotificationTemplate
public static 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
-
getService
-