Package com.broadleafcommerce.search.api.domain

Class SearchRedirect

java.lang.Object
com.broadleafcommerce.search.api.domain.SearchRedirect
All Implemented Interfaces:
Serializable
public class SearchRedirect extends Object implements Serializable
This represents a redirect which should be performed based on a search query.
See Also:

  • Constructor Details

    • SearchRedirect

      public SearchRedirect()

  • Method Details

    • getId

      public String getId()
      The context ID of this search redirect.
      Returns:
      the context ID of this search redirect

    • getName

      public String getName()
      A name to describe the purpose of this search redirect.

      Non-functional, only used as a description for administration.

      Returns:
      a description of this search redirect

    • getQueryMatch

      public String getQueryMatch()
      The value that a query must match to activate the redirect.

      If isRegex, the match will be applied as a Regex. Otherwise, an exact match is required.

      Returns:
      value for query to match for redirect

    • isRegex

      public boolean isRegex()
      Whether or not the queryMatch should be applied as a Regex.
      Returns:
      should match as Regex

    • getRedirectUri

      public String getRedirectUri()
      The URI which the client should be redirected to if the search query matches.
      Returns:
      the URI to redirect to on a match

    • getRedirectType

      public RedirectType getRedirectType()
      The type of redirect which should be performed.
      Returns:
      type of redirect to perform

    • setId

      public void setId(String id)
      The context ID of this search redirect.
      Parameters:
      id - the context ID of this search redirect

    • setName

      public void setName(String name)
      A name to describe the purpose of this search redirect.

      Non-functional, only used as a description for administration.

      Parameters:
      name - a description of this search redirect

    • setQueryMatch

      public void setQueryMatch(String queryMatch)
      The value that a query must match to activate the redirect.

      If isRegex, the match will be applied as a Regex. Otherwise, an exact match is required.

      Parameters:
      queryMatch - value for query to match for redirect

    • setRegex

      public void setRegex(boolean isRegex)
      Whether or not the queryMatch should be applied as a Regex.
      Parameters:
      isRegex - should match as Regex

    • setRedirectUri

      public void setRedirectUri(String redirectUri)
      The URI which the client should be redirected to if the search query matches.
      Parameters:
      redirectUri - the URI to redirect to on a match

    • setRedirectType

      public void setRedirectType(RedirectType redirectType)
      The type of redirect which should be performed.
      Parameters:
      redirectType - type of redirect to perform

    • 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