Class UrlAdvert

  • All Implemented Interfaces:
    Exhibit

    public class UrlAdvert
    extends 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 Detail

      • titleHtml

        private String titleHtml
        The title (in HTML) of the advert.
      • displayUrl

        private String displayUrl
        The URL to be displayed for the advert.
      • linkUrl

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

        private String descriptionHtml
        The description (in HTML) body of the advert.
      • additionalProperties

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

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

      • canEqual

        protected boolean canEqual​(Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getTitleHtml

        public String getTitleHtml()
        The title (in HTML) of the advert.
      • setTitleHtml

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

        public String getDisplayUrl()
        The URL to be displayed for the advert.
      • setDisplayUrl

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

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

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

        public String getDescriptionHtml()
        The description (in HTML) body of the advert.
      • setDescriptionHtml

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

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

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

        public 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​(String category)
        A category for the advert which may be used by an ftl file to display different types of adverts in different ways.