Package com.broadleafcommerce.catalogbrowse.domain.marketing

Class MarketingMessage

java.lang.Object
com.broadleafcommerce.catalogbrowse.domain.marketing.MarketingMessage
All Implemented Interfaces:
Serializable
public class MarketingMessage extends Object implements Serializable
Represents a marketing message to be displayed to the customer.
Author:
Jon Fleschler (jfleschler)
See Also:

  • Constructor Details

    • MarketingMessage

      public MarketingMessage()

  • Method Details

    • getId

      public String getId()

    • getText

      public String getText()
      The message's text to display to the customer
      Returns:
      the message text

    • getPriority

      public Integer getPriority()
      The message's priority
      Returns:
      the message priority

    • getDisplayHint

      public String getDisplayHint()
      Any display hint needed by the front-end
      Returns:
      the display hint for the front-end

    • getMessageType

      public String getMessageType()
      Determines the type of message to display, this can be HTML or CONTENT. If HTML, then the text will be displayed. If CONTENT, then the contentItemId will be used to hydrate the selected ContentItem.
      Returns:
      the type of message to display

    • getContentItemId

      public String getContentItemId()
      The ID of the ContentItem to display. This is required for messages with CONTENT messageType.
      Returns:
      the ID of the content item to display

    • setId

      public void setId(String id)

    • setText

      public void setText(String text)
      The message's text to display to the customer

    • setPriority

      public void setPriority(Integer priority)
      The message's priority

    • setDisplayHint

      public void setDisplayHint(String displayHint)
      Any display hint needed by the front-end

    • setMessageType

      public void setMessageType(String messageType)
      Determines the type of message to display, this can be HTML or CONTENT. If HTML, then the text will be displayed. If CONTENT, then the contentItemId will be used to hydrate the selected ContentItem.
      Parameters:
      messageType - the type of message to display

    • setContentItemId

      public void setContentItemId(String contentItemId)
      The ID of the ContentItem to display. This is required for messages with CONTENT messageType.
      Parameters:
      contentItemId - the ID of the content item to display

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object