Interface SiteMessageService
-
- All Known Implementing Classes:
DefaultSiteMessageService
public interface SiteMessageService
Service to provide methods for site message
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description SiteMessageModel
createMessage(java.lang.String subject, java.lang.String body, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)
Creates a site message by given subject, link, body, message type, notification type and localeSiteMessageModel
createMessage(java.lang.String title, java.lang.String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType, java.util.Locale locale)
Deprecated.since 1905, replace with createMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)SearchPageData<SiteMessageForCustomerModel>
getPaginatedMessagesForCustomer(CustomerModel customer, SearchPageData searchPageData)
Gets all paginated site messagesSearchPageData<SiteMessageForCustomerModel>
getPaginatedMessagesForType(CustomerModel customer, SiteMessageType type, SearchPageData searchPageData)
Gets paginated site messages for the given typejava.util.List<SiteMessageForCustomerModel>
getSiteMessagesForCustomer(CustomerModel customer)
Gets all site message of the customer
-
-
-
Method Detail
-
getPaginatedMessagesForType
SearchPageData<SiteMessageForCustomerModel> getPaginatedMessagesForType(CustomerModel customer, SiteMessageType type, SearchPageData searchPageData)
Gets paginated site messages for the given type- Parameters:
customer
- the specific customertype
- the given message typesearchPageData
- pagination parameters- Returns:
- paginated result
-
getPaginatedMessagesForCustomer
SearchPageData<SiteMessageForCustomerModel> getPaginatedMessagesForCustomer(CustomerModel customer, SearchPageData searchPageData)
Gets all paginated site messages- Parameters:
customer
- the specific customersearchPageData
- pagination parameters- Returns:
- paginated result
-
createMessage
@Deprecated SiteMessageModel createMessage(java.lang.String title, java.lang.String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType, java.util.Locale locale)
Deprecated.since 1905, replace with createMessage(String title, String content, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)Creates a site message by given title, link, content, message type, notification type and locale- Parameters:
title
- the message titlecontent
- the message contenttype
- the message typeexternalItem
- the related item modelnotificationType
- the notification typelocale
- the locale, if null, default current locale- Returns:
- the created message model
-
createMessage
SiteMessageModel createMessage(java.lang.String subject, java.lang.String body, SiteMessageType type, ItemModel externalItem, NotificationType notificationType)
Creates a site message by given subject, link, body, message type, notification type and locale- Parameters:
subject
- the message subjectbody
- the message bodytype
- the message typeexternalItem
- the related item modelnotificationType
- the notification type- Returns:
- the created message model
-
getSiteMessagesForCustomer
java.util.List<SiteMessageForCustomerModel> getSiteMessagesForCustomer(CustomerModel customer)
Gets all site message of the customer- Parameters:
customer
- the specific customer- Returns:
- list of site message for customer
-
-