Package de.hybris.platform.commerceservices.model

Class CustomerListModel

java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.core.model.security.PrincipalModel
de.hybris.platform.core.model.security.PrincipalGroupModel
de.hybris.platform.core.model.user.UserGroupModel
de.hybris.platform.commerceservices.model.CustomerListModel
All Implemented Interfaces:
Serializable
public class CustomerListModel extends UserGroupModel
Generated model class for type CustomerList first defined at extension commerceservices.

A CustomerList are visible to certain Employees and represents an implementation specific search query to find customer based on different criteria.

See Also:

  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:

    • IMPLEMENTATIONTYPE

      public static final String IMPLEMENTATIONTYPE
      Generated constant - Attribute key of CustomerList.implementationType attribute defined at extension commerceservices.
      See Also:

    • PRIORITY

      public static final String PRIORITY
      Generated constant - Attribute key of CustomerList.priority attribute defined at extension commerceservices.
      See Also:

    • ADDITIONALCOLUMNSKEYS

      public static final String ADDITIONALCOLUMNSKEYS
      Generated constant - Attribute key of CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.
      See Also:

    • SEARCHBOXENABLED

      public static final String SEARCHBOXENABLED
      Generated constant - Attribute key of CustomerList.searchBoxEnabled attribute defined at extension commerceservices.
      See Also:

  • Constructor Details

    • CustomerListModel

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

    • CustomerListModel

      public CustomerListModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null

    • CustomerListModel

      @Deprecated(since="4.1.1", forRemoval=true) public CustomerListModel(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:
      _uid - initial attribute declared by type Principal at extension core

    • CustomerListModel

      @Deprecated(since="4.1.1", forRemoval=true) public CustomerListModel(ItemModel _owner, 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:
      _owner - initial attribute declared by type Item at extension core
      _uid - initial attribute declared by type Principal at extension core

  • Method Details

    • getAdditionalColumnsKeys

      @Accessor(qualifier="additionalColumnsKeys", type=GETTER) public Collection<String> getAdditionalColumnsKeys()
      Generated method - Getter of the CustomerList.additionalColumnsKeys attribute defined at extension commerceservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the additionalColumnsKeys - Additional columns keys to add columns dynamically. Header localization will be done via properties and EL syntax can be added in facade layer via spring bean customerListAdditionalColumnsMap.

    • getImplementationType

      @Accessor(qualifier="implementationType", type=GETTER) public String getImplementationType()
      Generated method - Getter of the CustomerList.implementationType attribute defined at extension commerceservices.
      Returns:
      the implementationType - The implementation type for this customer list

    • getPriority

      @Accessor(qualifier="priority", type=GETTER) public Integer getPriority()
      Generated method - Getter of the CustomerList.priority attribute defined at extension commerceservices.
      Returns:
      the priority - Priority for the customer list and zero by default, this will affect the position of the list when getting list of customer lists,higher values are displayed first

    • isSearchBoxEnabled

      @Accessor(qualifier="searchBoxEnabled", type=GETTER) public boolean isSearchBoxEnabled()
      Generated method - Getter of the CustomerList.searchBoxEnabled attribute defined at extension commerceservices.
      Returns:
      the searchBoxEnabled - Determines if the customer list UI should display a search box or not. False by default

    • setAdditionalColumnsKeys

      @Accessor(qualifier="additionalColumnsKeys", type=SETTER) public void setAdditionalColumnsKeys(Collection<String> value)
      Generated method - Setter of CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.
      Parameters:
      value - the additionalColumnsKeys - Additional columns keys to add columns dynamically. Header localization will be done via properties and EL syntax can be added in facade layer via spring bean customerListAdditionalColumnsMap.

    • setImplementationType

      @Accessor(qualifier="implementationType", type=SETTER) public void setImplementationType(String value)
      Generated method - Setter of CustomerList.implementationType attribute defined at extension commerceservices.
      Parameters:
      value - the implementationType - The implementation type for this customer list

    • setPriority

      @Accessor(qualifier="priority", type=SETTER) public void setPriority(Integer value)
      Generated method - Setter of CustomerList.priority attribute defined at extension commerceservices.
      Parameters:
      value - the priority - Priority for the customer list and zero by default, this will affect the position of the list when getting list of customer lists,higher values are displayed first

    • setSearchBoxEnabled

      @Accessor(qualifier="searchBoxEnabled", type=SETTER) public void setSearchBoxEnabled(boolean value)
      Generated method - Setter of CustomerList.searchBoxEnabled attribute defined at extension commerceservices.
      Parameters:
      value - the searchBoxEnabled - Determines if the customer list UI should display a search box or not. False by default