Package de.hybris.platform.solrfacetsearch.model

Class SolrSortModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.solrfacetsearch.model.SolrSortModel

All Implemented Interfaces:

Serializable

public class SolrSortModel
extends ItemModel

Generated model class for type SolrSort first defined at extension solrfacetsearch.

Extending SolrSort type with additional attributes.

See Also:

• Serialized Form

Nested Class Summary

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

de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	_SOLRINDEXEDTYPE2SOLRSORTREL	Generated relation code constant for relation SolrIndexedType2SolrSortRel defining source attribute indexedType in extension solrfacetsearch.
static final String	_TYPECODE	Generated model type code constant.
static final String	CODE	Generated constant - Attribute key of SolrSort.code attribute defined at extension solrfacetsearch.
static final String	FIELDS	Generated constant - Attribute key of SolrSort.fields attribute defined at extension solrfacetsearch.
static final String	INDEXEDTYPE	Generated constant - Attribute key of SolrSort.indexedType attribute defined at extension solrfacetsearch.
static final String	INDEXEDTYPEPOS	Generated constant - Attribute key of SolrSort.indexedTypePOS attribute defined at extension solrfacetsearch.
static final String	NAME	Generated constant - Attribute key of SolrSort.name attribute defined at extension solrfacetsearch.
static final String	USEBOOST	Generated constant - Attribute key of SolrSort.useBoost attribute defined at extension solrfacetsearch.

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	Description
SolrSortModel()	Generated constructor - Default constructor for generic creation.
SolrSortModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx)	Generated constructor - Default constructor for creation with existing context
SolrSortModel(String _code, SolrIndexedTypeModel _indexedType)	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
SolrSortModel(String _code, SolrIndexedTypeModel _indexedType, ItemModel _owner)	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

Method Summary

Modifier and Type	Method	Description
String	getCode()	Generated method - Getter of the SolrSort.code attribute defined at extension solrfacetsearch.
List<SolrSortFieldModel>	getFields()	Generated method - Getter of the SolrSort.fields attribute defined at extension solrfacetsearch.
SolrIndexedTypeModel	getIndexedType()	Generated method - Getter of the SolrSort.indexedType attribute defined at extension solrfacetsearch.
String	getName()	Generated method - Getter of the SolrSort.name attribute defined at extension solrfacetsearch.
String	getName(Locale loc)	Generated method - Getter of the SolrSort.name attribute defined at extension solrfacetsearch.
boolean	isUseBoost()	Generated method - Getter of the SolrSort.useBoost attribute defined at extension solrfacetsearch.
void	setCode(String value)	Generated method - Setter of SolrSort.code attribute defined at extension solrfacetsearch.
void	setFields(List<SolrSortFieldModel> value)	Generated method - Setter of SolrSort.fields attribute defined at extension solrfacetsearch.
void	setIndexedType(SolrIndexedTypeModel value)	Generated method - Setter of SolrSort.indexedType attribute defined at extension solrfacetsearch.
void	setName(String value)	Generated method - Setter of SolrSort.name attribute defined at extension solrfacetsearch.
void	setName(String value, Locale loc)	Generated method - Setter of SolrSort.name attribute defined at extension solrfacetsearch.
void	setUseBoost(boolean value)	Generated method - Setter of SolrSort.useBoost attribute defined at extension solrfacetsearch.

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 Details

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

• Constant Field Values

_SOLRINDEXEDTYPE2SOLRSORTREL

public static final String _SOLRINDEXEDTYPE2SOLRSORTREL

Generated relation code constant for relation SolrIndexedType2SolrSortRel defining source attribute indexedType in extension solrfacetsearch.

See Also:

• Constant Field Values

CODE

public static final String CODE

Generated constant - Attribute key of SolrSort.code attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

NAME

public static final String NAME

Generated constant - Attribute key of SolrSort.name attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

USEBOOST

public static final String USEBOOST

Generated constant - Attribute key of SolrSort.useBoost attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

INDEXEDTYPEPOS

public static final String INDEXEDTYPEPOS

Generated constant - Attribute key of SolrSort.indexedTypePOS attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

INDEXEDTYPE

public static final String INDEXEDTYPE

Generated constant - Attribute key of SolrSort.indexedType attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

FIELDS

public static final String FIELDS

Generated constant - Attribute key of SolrSort.fields attribute defined at extension solrfacetsearch.

See Also:

• Constant Field Values

Constructor Details

SolrSortModel

public SolrSortModel()

Generated constructor - Default constructor for generic creation.

SolrSortModel

public SolrSortModel(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

SolrSortModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public SolrSortModel(String _code,
 SolrIndexedTypeModel _indexedType)

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:

_code - initial attribute declared by type SolrSort at extension solrfacetsearch

_indexedType - initial attribute declared by type SolrSort at extension solrfacetsearch

SolrSortModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public SolrSortModel(String _code,
 SolrIndexedTypeModel _indexedType,
 ItemModel _owner)

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:

_code - initial attribute declared by type SolrSort at extension solrfacetsearch

_indexedType - initial attribute declared by type SolrSort at extension solrfacetsearch

_owner - initial attribute declared by type Item at extension core

Method Details

getCode

@Accessor(qualifier="code",
          type=GETTER)
public String getCode()

Generated method - Getter of the SolrSort.code attribute defined at extension solrfacetsearch.

Returns:

the code - The unique code used to identify the solr sort.

getFields

@Accessor(qualifier="fields",
          type=GETTER)
public List<SolrSortFieldModel> getFields()

Generated method - Getter of the SolrSort.fields attribute defined at extension solrfacetsearch. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the fields

getIndexedType

@Accessor(qualifier="indexedType",
          type=GETTER)
public SolrIndexedTypeModel getIndexedType()

Generated method - Getter of the SolrSort.indexedType attribute defined at extension solrfacetsearch.

Returns:

the indexedType

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName()

Generated method - Getter of the SolrSort.name attribute defined at extension solrfacetsearch.

Returns:

the name - The display name for this sort.

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName(Locale loc)

Generated method - Getter of the SolrSort.name attribute defined at extension solrfacetsearch.

Parameters:

loc - the value localization key

Returns:

the name - The display name for this sort.

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

isUseBoost

@Accessor(qualifier="useBoost",
          type=GETTER)
public boolean isUseBoost()

Generated method - Getter of the SolrSort.useBoost attribute defined at extension solrfacetsearch.

Returns:

the useBoost - The property specifies whether a sort should apply SOLR boost rules.

setCode

@Accessor(qualifier="code",
          type=SETTER)
public void setCode(String value)

Generated method - Setter of SolrSort.code attribute defined at extension solrfacetsearch.

Parameters:

value - the code - The unique code used to identify the solr sort.

setFields

@Accessor(qualifier="fields",
          type=SETTER)
public void setFields(List<SolrSortFieldModel> value)

Generated method - Setter of SolrSort.fields attribute defined at extension solrfacetsearch.

Parameters:

value - the fields

setIndexedType

@Accessor(qualifier="indexedType",
          type=SETTER)
public void setIndexedType(SolrIndexedTypeModel value)

Generated method - Setter of SolrSort.indexedType attribute defined at extension solrfacetsearch.

Parameters:

value - the indexedType

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(String value)

Generated method - Setter of SolrSort.name attribute defined at extension solrfacetsearch.

Parameters:

value - the name - The display name for this sort.

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(String value,
 Locale loc)

Generated method - Setter of SolrSort.name attribute defined at extension solrfacetsearch.

Parameters:

value - the name - The display name for this sort.

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setUseBoost

@Accessor(qualifier="useBoost",
          type=SETTER)
public void setUseBoost(boolean value)

Generated method - Setter of SolrSort.useBoost attribute defined at extension solrfacetsearch.

Parameters:

value - the useBoost - The property specifies whether a sort should apply SOLR boost rules.