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:

java.io.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:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_TYPECODE Generated model type code constant.
static java.lang.String	ADDITIONALCOLUMNSKEYS Generated constant - Attribute key of CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.
static java.lang.String	IMPLEMENTATIONTYPE Generated constant - Attribute key of CustomerList.implementationType attribute defined at extension commerceservices.
static java.lang.String	PRIORITY Generated constant - Attribute key of CustomerList.priority attribute defined at extension commerceservices.
static java.lang.String	SEARCHBOXENABLED Generated constant - Attribute key of CustomerList.searchBoxEnabled attribute defined at extension commerceservices.

Fields inherited from class de.hybris.platform.core.model.user.UserGroupModel

_BACKOFFICESAVEDQUERY2USERGROUPRELATION, _SAMLUSERGROUPTOUSERGROUPRELATION, _SCIMUSERGROUPTOUSERGROUPRELATION, _USERGROUPSFORRESTRICTION, _VENDOR2USERGROUPRELATION, HMCXML, READABLELANGUAGES, RESTRICTIONS, SAMLUSERGROUPS, SAVEDQUERIES, SCIMUSERGROUPS, USERDISCOUNTGROUP, USERPRICEGROUP, USERTAXGROUP, VENDOR, WRITEABLELANGUAGES

Fields inherited from class de.hybris.platform.core.model.security.PrincipalGroupModel

_PRINCIPALGROUPRELATION, LOCNAME, MAXBRUTEFORCELOGINATTEMPTS, MEMBERS

Fields inherited from class de.hybris.platform.core.model.security.PrincipalModel

_CATEGORY2PRINCIPALRELATION, _COMMENTWATCHERRELATION, _PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION, _PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION, _SYNCITEMJOB2PRINCIPAL, _WORKFLOWTEMPLATE2PRINCIPALRELATION, ACCESSIBLECATEGORIES, ALLGROUPS, ALLSEARCHRESTRICTIONS, BACKOFFICELOGINDISABLED, CN, COCKPITUICONFIGURATIONS, DESCRIPTION, DISPLAYNAME, DN, GROUPS, LDAPSEARCHBASE, NAME, PROFILEPICTURE, READABLECATALOGVERSIONS, READABLECOCKPITUICOMPONENTS, READABSTRACTLINKENTRY, READCOLLECTIONS, READSAVEDQUERIES, SEARCHRESTRICTIONS, SYNCJOBS, UID, VISIBLETEMPLATES, WATCHEDCOMMENTS, WRITABLECATALOGVERSIONS, WRITABLECOCKPITUICOMPONENTS, WRITECOLLECTIONS

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor and Description
CustomerListModel() Generated constructor - Default constructor for generic creation.
CustomerListModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context
CustomerListModel(ItemModel _owner, java.lang.String _uid) Deprecated. since 4.1.1 Please use the default constructor without parameters
CustomerListModel(java.lang.String _uid) Deprecated. since 4.1.1 Please use the default constructor without parameters

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getAdditionalColumnsKeys() Generated method - Getter of the CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.
java.lang.String	getImplementationType() Generated method - Getter of the CustomerList.implementationType attribute defined at extension commerceservices.
java.lang.Integer	getPriority() Generated method - Getter of the CustomerList.priority attribute defined at extension commerceservices.
boolean	isSearchBoxEnabled() Generated method - Getter of the CustomerList.searchBoxEnabled attribute defined at extension commerceservices.
void	setAdditionalColumnsKeys(java.util.Collection<java.lang.String> value) Generated method - Setter of CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.
void	setImplementationType(java.lang.String value) Generated method - Setter of CustomerList.implementationType attribute defined at extension commerceservices.
void	setPriority(java.lang.Integer value) Generated method - Setter of CustomerList.priority attribute defined at extension commerceservices.
void	setSearchBoxEnabled(boolean value) Generated method - Setter of CustomerList.searchBoxEnabled attribute defined at extension commerceservices.

Methods inherited from class de.hybris.platform.core.model.user.UserGroupModel

getHmcXML, getReadableLanguages, getRestrictions, getSavedQueries, getScimUserGroups, getUserDiscountGroup, getUserPriceGroup, getUserTaxGroup, getVendor, getWriteableLanguages, setHmcXML, setReadableLanguages, setRestrictions, setSavedQueries, setScimUserGroups, setUserDiscountGroup, setUserPriceGroup, setUserTaxGroup, setVendor, setWriteableLanguages

Methods inherited from class de.hybris.platform.core.model.security.PrincipalGroupModel

getLocname, getLocName, getLocname, getLocName, getMaxBruteForceLoginAttempts, getMembers, setLocname, setLocName, setLocname, setLocName, setMaxBruteForceLoginAttempts, setMembers

Methods inherited from class de.hybris.platform.core.model.security.PrincipalModel

getAccessibleCategories, getAllgroups, getAllGroups, getAllsearchrestrictions, getAllSearchRestrictions, getBackOfficeLoginDisabled, getCN, getCockpitUIConfigurations, getDescription, getDisplayName, getDisplayName, getDN, getGroups, getLdapsearchbase, getName, getProfilePicture, getReadableCatalogVersions, getReadableCockpitUIComponents, getReadAbstractLinkEntry, getReadCollections, getReadSavedQueries, getSearchrestrictions, getSearchRestrictions, getSyncJobs, getUid, getVisibleTemplates, getWatchedComments, getWritableCatalogVersions, getWritableCockpitUIComponents, getWriteCollections, setBackOfficeLoginDisabled, setCN, setCockpitUIConfigurations, setDescription, setDN, setGroups, setLdapsearchbase, setName, setProfilePicture, setReadableCatalogVersions, setReadableCockpitUIComponents, setReadAbstractLinkEntry, setReadCollections, setReadSavedQueries, setSyncJobs, setUid, setVisibleTemplates, setWatchedComments, setWritableCatalogVersions, setWritableCockpitUIComponents, setWriteCollections

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwner

Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

Methods inherited from class java.lang.Object

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

Field Detail

_TYPECODE

public static final java.lang.String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

IMPLEMENTATIONTYPE

public static final java.lang.String IMPLEMENTATIONTYPE

Generated constant - Attribute key of CustomerList.implementationType attribute defined at extension commerceservices.

See Also:

Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY

Generated constant - Attribute key of CustomerList.priority attribute defined at extension commerceservices.

See Also:

Constant Field Values

ADDITIONALCOLUMNSKEYS

public static final java.lang.String ADDITIONALCOLUMNSKEYS

Generated constant - Attribute key of CustomerList.additionalColumnsKeys attribute defined at extension commerceservices.

See Also:

Constant Field Values

SEARCHBOXENABLED

public static final java.lang.String SEARCHBOXENABLED

Generated constant - Attribute key of CustomerList.searchBoxEnabled attribute defined at extension commerceservices.

See Also:

Constant Field Values

Constructor Detail

CustomerListModel

public CustomerListModel()

Generated constructor - Default constructor for generic creation.

CustomerListModel

public CustomerListModel(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
public CustomerListModel(java.lang.String _uid)

Deprecated. 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
public CustomerListModel(ItemModel _owner,
                                     java.lang.String _uid)

Deprecated. 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 Detail

getAdditionalColumnsKeys

@Accessor(qualifier="additionalColumnsKeys",
          type=GETTER)
public java.util.Collection<java.lang.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 java.lang.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 java.lang.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(java.util.Collection<java.lang.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(java.lang.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(java.lang.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