Interface NotificationTemplateLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
NotificationTemplateLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddNotificationTemplate(NotificationContext notificationContext) addNotificationTemplate(NotificationTemplate notificationTemplate) Adds the notification template to the database.addNotificationTemplate(String externalReferenceCode, long userId, String type) addSubscriptionNotificationTemplate(String externalReferenceCode, long userId) createNotificationTemplate(long notificationTemplateId) Creates a new notification template with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) voiddeleteCompanyNotificationTemplates(long companyId) deleteNotificationTemplate(long notificationTemplateId) Deletes the notification template with the primary key from the database.deleteNotificationTemplate(NotificationTemplate notificationTemplate) Deletes the notification template from the database.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchNotificationTemplate(long notificationTemplateId) fetchNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) fetchNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) Returns the notification template with the matching UUID and company.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetNotificationTemplate(long notificationTemplateId) Returns the notification template with the primary key.getNotificationTemplateByExternalReferenceCode(String externalReferenceCode, long companyId) getNotificationTemplateByUuidAndCompanyId(String uuid, long companyId) Returns the notification template with the matching UUID and company.getNotificationTemplates(int start, int end) Returns a range of all the notification templates.intReturns the number of notification templates.Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) updateNotificationTemplate(NotificationContext notificationContext) updateNotificationTemplate(NotificationTemplate notificationTemplate) Updates the notification template in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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:
createPersistedModelin interfacecom.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:
deletePersistedModelin interfacecom.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:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.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 - 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
@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 - 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
@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 queryprojection- 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 UUIDcompanyId- the primary key of the company- Returns:
- the matching notification template, or
nullif 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 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
@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 - 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
@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:
getPersistedModelin interfacecom.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
-