Package de.hybris.platform.acceleratorcms.model.components

Class SearchBoxComponentModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class SearchBoxComponentModel
extends SimpleCMSComponentModel
    Generated model class for type SearchBoxComponent first defined at extension acceleratorcms.

    Represents the search box component.

    See Also:
    Serialized Form

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • DISPLAYSUGGESTIONS

        public static final java.lang.String DISPLAYSUGGESTIONS
        Generated constant - Attribute key of SearchBoxComponent.displaySuggestions attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • DISPLAYPRODUCTS

        public static final java.lang.String DISPLAYPRODUCTS
        Generated constant - Attribute key of SearchBoxComponent.displayProducts attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • DISPLAYPRODUCTIMAGES

        public static final java.lang.String DISPLAYPRODUCTIMAGES
        Generated constant - Attribute key of SearchBoxComponent.displayProductImages attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • MAXSUGGESTIONS

        public static final java.lang.String MAXSUGGESTIONS
        Generated constant - Attribute key of SearchBoxComponent.maxSuggestions attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • MAXPRODUCTS

        public static final java.lang.String MAXPRODUCTS
        Generated constant - Attribute key of SearchBoxComponent.maxProducts attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • MINCHARACTERSBEFOREREQUEST

        public static final java.lang.String MINCHARACTERSBEFOREREQUEST
        Generated constant - Attribute key of SearchBoxComponent.minCharactersBeforeRequest attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

      • WAITTIMEBEFOREREQUEST

        public static final java.lang.String WAITTIMEBEFOREREQUEST
        Generated constant - Attribute key of SearchBoxComponent.waitTimeBeforeRequest attribute defined at extension acceleratorcms.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SearchBoxComponentModel

        public SearchBoxComponentModel()
        Generated constructor - Default constructor for generic creation.

      • SearchBoxComponentModel

        public SearchBoxComponentModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • SearchBoxComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public SearchBoxComponentModel​(CatalogVersionModel _catalogVersion,
                               java.lang.String _uid)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _catalogVersion - initial attribute declared by type CMSItem at extension cms2
        _uid - initial attribute declared by type CMSItem at extension cms2

      • SearchBoxComponentModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public SearchBoxComponentModel​(CatalogVersionModel _catalogVersion,
                               ItemModel _owner,
                               java.lang.String _uid)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _catalogVersion - initial attribute declared by type CMSItem at extension cms2
        _owner - initial attribute declared by type Item at extension core
        _uid - initial attribute declared by type CMSItem at extension cms2

    • Method Detail

      • getMaxProducts

        @Accessor(qualifier="maxProducts",
          type=GETTER)
public java.lang.Integer getMaxProducts()
        Generated method - Getter of the SearchBoxComponent.maxProducts attribute defined at extension acceleratorcms.
        Returns:
        the maxProducts - Determines the max number of products to display in the component.

      • getMaxSuggestions

        @Accessor(qualifier="maxSuggestions",
          type=GETTER)
public java.lang.Integer getMaxSuggestions()
        Generated method - Getter of the SearchBoxComponent.maxSuggestions attribute defined at extension acceleratorcms.
        Returns:
        the maxSuggestions - Determines the max number of suggestions to display in the component.

      • getMinCharactersBeforeRequest

        @Accessor(qualifier="minCharactersBeforeRequest",
          type=GETTER)
public java.lang.Integer getMinCharactersBeforeRequest()
        Generated method - Getter of the SearchBoxComponent.minCharactersBeforeRequest attribute defined at extension acceleratorcms.
        Returns:
        the minCharactersBeforeRequest - Determines the min number of characters to enter before submitting a search request.

      • getWaitTimeBeforeRequest

        @Accessor(qualifier="waitTimeBeforeRequest",
          type=GETTER)
public java.lang.Integer getWaitTimeBeforeRequest()
        Generated method - Getter of the SearchBoxComponent.waitTimeBeforeRequest attribute defined at extension acceleratorcms.
        Returns:
        the waitTimeBeforeRequest - Determines the wait time after the search term has been altered before resubmitting the search request.

      • isDisplayProductImages

        @Accessor(qualifier="displayProductImages",
          type=GETTER)
public boolean isDisplayProductImages()
        Generated method - Getter of the SearchBoxComponent.displayProductImages attribute defined at extension acceleratorcms.
        Returns:
        the displayProductImages - Determines if product images are shown.

      • isDisplayProducts

        @Accessor(qualifier="displayProducts",
          type=GETTER)
public boolean isDisplayProducts()
        Generated method - Getter of the SearchBoxComponent.displayProducts attribute defined at extension acceleratorcms.
        Returns:
        the displayProducts - Determines if product results are displayed in the component.

      • isDisplaySuggestions

        @Accessor(qualifier="displaySuggestions",
          type=GETTER)
public boolean isDisplaySuggestions()
        Generated method - Getter of the SearchBoxComponent.displaySuggestions attribute defined at extension acceleratorcms.
        Returns:
        the displaySuggestions - Determines if suggested terms are displayed in the component.

      • setDisplayProductImages

        @Accessor(qualifier="displayProductImages",
          type=SETTER)
public void setDisplayProductImages​(boolean value)
        Generated method - Setter of SearchBoxComponent.displayProductImages attribute defined at extension acceleratorcms.
        Parameters:
        value - the displayProductImages - Determines if product images are shown.

      • setDisplayProducts

        @Accessor(qualifier="displayProducts",
          type=SETTER)
public void setDisplayProducts​(boolean value)
        Generated method - Setter of SearchBoxComponent.displayProducts attribute defined at extension acceleratorcms.
        Parameters:
        value - the displayProducts - Determines if product results are displayed in the component.

      • setDisplaySuggestions

        @Accessor(qualifier="displaySuggestions",
          type=SETTER)
public void setDisplaySuggestions​(boolean value)
        Generated method - Setter of SearchBoxComponent.displaySuggestions attribute defined at extension acceleratorcms.
        Parameters:
        value - the displaySuggestions - Determines if suggested terms are displayed in the component.

      • setMaxProducts

        @Accessor(qualifier="maxProducts",
          type=SETTER)
public void setMaxProducts​(java.lang.Integer value)
        Generated method - Setter of SearchBoxComponent.maxProducts attribute defined at extension acceleratorcms.
        Parameters:
        value - the maxProducts - Determines the max number of products to display in the component.

      • setMaxSuggestions

        @Accessor(qualifier="maxSuggestions",
          type=SETTER)
public void setMaxSuggestions​(java.lang.Integer value)
        Generated method - Setter of SearchBoxComponent.maxSuggestions attribute defined at extension acceleratorcms.
        Parameters:
        value - the maxSuggestions - Determines the max number of suggestions to display in the component.

      • setMinCharactersBeforeRequest

        @Accessor(qualifier="minCharactersBeforeRequest",
          type=SETTER)
public void setMinCharactersBeforeRequest​(java.lang.Integer value)
        Generated method - Setter of SearchBoxComponent.minCharactersBeforeRequest attribute defined at extension acceleratorcms.
        Parameters:
        value - the minCharactersBeforeRequest - Determines the min number of characters to enter before submitting a search request.

      • setWaitTimeBeforeRequest

        @Accessor(qualifier="waitTimeBeforeRequest",
          type=SETTER)
public void setWaitTimeBeforeRequest​(java.lang.Integer value)
        Generated method - Setter of SearchBoxComponent.waitTimeBeforeRequest attribute defined at extension acceleratorcms.
        Parameters:
        value - the waitTimeBeforeRequest - Determines the wait time after the search term has been altered before resubmitting the search request.