Package com.funnelback.publicui.search.model.curator.data

Class UrlAdvert

  • All Implemented Interfaces:
    Exhibit
    public class UrlAdvert
extends java.lang.Object
implements Exhibit

    An 'advert' for a URL to be displayed within search results.

    It is normally expected that this should be displayed differently to normal search results (otherwise PromoteUrl may be more appropriate).

    The URL to be advertised need not exist in the current collection.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Map<java.lang.String,​java.lang.Object> additionalProperties
      Any additional properties associated with the advert (for example CSS styling related information).
      private java.lang.String category
      A category for the advert which may be used by an ftl file to display different types of adverts in different ways.
      private java.lang.String descriptionHtml
      The description (in HTML) body of the advert.
      private java.lang.String displayUrl
      The URL to be displayed for the advert.
      private java.lang.String linkUrl
      The URL to which the user should be taken if the advert is clicked.
      private java.lang.String titleHtml
      The title (in HTML) of the advert.

    • Constructor Summary

      Constructors 
      Constructor Description
      UrlAdvert()  
      UrlAdvert​(java.lang.String titleHtml, java.lang.String displayUrl, java.lang.String linkUrl, java.lang.String descriptionHtml, java.util.Map<java.lang.String,​java.lang.Object> additionalProperties, java.lang.String category)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
      Any additional properties associated with the advert (for example CSS styling related information).
      java.lang.String getCategory()
      A category for the advert which may be used by an ftl file to display different types of adverts in different ways.
      java.lang.String getDescriptionHtml()
      The description (in HTML) body of the advert.
      java.lang.String getDisplayUrl()
      The URL to be displayed for the advert.
      java.lang.String getLinkUrl()
      The URL to which the user should be taken if the advert is clicked.
      java.lang.String getTitleHtml()
      The title (in HTML) of the advert.
      int hashCode()  
      void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.Object> additionalProperties)
      Any additional properties associated with the advert (for example CSS styling related information).
      void setCategory​(java.lang.String category)
      A category for the advert which may be used by an ftl file to display different types of adverts in different ways.
      void setDescriptionHtml​(java.lang.String descriptionHtml)
      The description (in HTML) body of the advert.
      void setDisplayUrl​(java.lang.String displayUrl)
      The URL to be displayed for the advert.
      void setLinkUrl​(java.lang.String linkUrl)
      The URL to which the user should be taken if the advert is clicked.
      void setTitleHtml​(java.lang.String titleHtml)
      The title (in HTML) of the advert.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • titleHtml

        private java.lang.String titleHtml
        The title (in HTML) of the advert.

      • displayUrl

        private java.lang.String displayUrl
        The URL to be displayed for the advert.

      • linkUrl

        private java.lang.String linkUrl
        The URL to which the user should be taken if the advert is clicked.

      • descriptionHtml

        private java.lang.String descriptionHtml
        The description (in HTML) body of the advert.

      • additionalProperties

        private java.util.Map<java.lang.String,​java.lang.Object> additionalProperties
        Any additional properties associated with the advert (for example CSS styling related information).

      • category

        private java.lang.String category
        A category for the advert which may be used by an ftl file to display different types of adverts in different ways.

    • Constructor Detail

      • UrlAdvert

        public UrlAdvert​(java.lang.String titleHtml,
                 java.lang.String displayUrl,
                 java.lang.String linkUrl,
                 java.lang.String descriptionHtml,
                 java.util.Map<java.lang.String,​java.lang.Object> additionalProperties,
                 java.lang.String category)

      • UrlAdvert

        public UrlAdvert()

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getTitleHtml

        public java.lang.String getTitleHtml()
        The title (in HTML) of the advert.

      • setTitleHtml

        public void setTitleHtml​(java.lang.String titleHtml)
        The title (in HTML) of the advert.

      • getDisplayUrl

        public java.lang.String getDisplayUrl()
        The URL to be displayed for the advert.

      • setDisplayUrl

        public void setDisplayUrl​(java.lang.String displayUrl)
        The URL to be displayed for the advert.

      • getLinkUrl

        public java.lang.String getLinkUrl()
        The URL to which the user should be taken if the advert is clicked.

      • setLinkUrl

        public void setLinkUrl​(java.lang.String linkUrl)
        The URL to which the user should be taken if the advert is clicked.

      • getDescriptionHtml

        public java.lang.String getDescriptionHtml()
        The description (in HTML) body of the advert.

      • setDescriptionHtml

        public void setDescriptionHtml​(java.lang.String descriptionHtml)
        The description (in HTML) body of the advert.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Any additional properties associated with the advert (for example CSS styling related information).

      • setAdditionalProperties

        public void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.Object> additionalProperties)
        Any additional properties associated with the advert (for example CSS styling related information).

      • getCategory

        public java.lang.String getCategory()
        A category for the advert which may be used by an ftl file to display different types of adverts in different ways.

      • setCategory

        public void setCategory​(java.lang.String category)
        A category for the advert which may be used by an ftl file to display different types of adverts in different ways.