Package de.hybris.platform.searchservices.model

Class SnFieldModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class SnFieldModel
extends ItemModel
    Generated model class for type SnField first defined at extension searchservices.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _SNINDEXTYPE2FIELD
      Generated relation code constant for relation SnIndexType2Field defining source attribute indexType in extension searchservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String FIELDTYPE
      Generated constant - Attribute key of SnField.fieldType attribute defined at extension searchservices.
      static java.lang.String ID
      Generated constant - Attribute key of SnField.id attribute defined at extension searchservices.
      static java.lang.String INDEXTYPE
      Generated constant - Attribute key of SnField.indexType attribute defined at extension searchservices.
      static java.lang.String INDEXTYPEPOS
      Generated constant - Attribute key of SnField.indexTypePOS attribute defined at extension searchservices.
      static java.lang.String LOCALIZED
      Generated constant - Attribute key of SnField.localized attribute defined at extension searchservices.
      static java.lang.String MULTIVALUED
      Generated constant - Attribute key of SnField.multiValued attribute defined at extension searchservices.
      static java.lang.String NAME
      Generated constant - Attribute key of SnField.name attribute defined at extension searchservices.
      static java.lang.String QUALIFIERTYPEID
      Generated constant - Attribute key of SnField.qualifierTypeId attribute defined at extension searchservices.
      static java.lang.String RETRIEVABLE
      Generated constant - Attribute key of SnField.retrievable attribute defined at extension searchservices.
      static java.lang.String SEARCHABLE
      Generated constant - Attribute key of SnField.searchable attribute defined at extension searchservices.
      static java.lang.String USEFORSPELLCHECKING
      Generated constant - Attribute key of SnField.useForSpellchecking attribute defined at extension searchservices.
      static java.lang.String USEFORSUGGESTING
      Generated constant - Attribute key of SnField.useForSuggesting attribute defined at extension searchservices.
      static java.lang.String VALUEPROVIDER
      Generated constant - Attribute key of SnField.valueProvider attribute defined at extension searchservices.
      static java.lang.String VALUEPROVIDERPARAMETERS
      Generated constant - Attribute key of SnField.valueProviderParameters attribute defined at extension searchservices.
      static java.lang.String WEIGHT
      Generated constant - Attribute key of SnField.weight attribute defined at extension searchservices.

    • Constructor Summary

      Constructors 
      Constructor Description
      SnFieldModel()
      Generated constructor - Default constructor for generic creation.
      SnFieldModel​(SnFieldType _fieldType, java.lang.String _id, SnIndexTypeModel _indexType)
      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
      SnFieldModel​(SnFieldType _fieldType, java.lang.String _id, SnIndexTypeModel _indexType, 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
      SnFieldModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SnFieldType getFieldType()
      Generated method - Getter of the SnField.fieldType attribute defined at extension searchservices.
      java.lang.String getId()
      Generated method - Getter of the SnField.id attribute defined at extension searchservices.
      SnIndexTypeModel getIndexType()
      Generated method - Getter of the SnField.indexType attribute defined at extension searchservices.
      java.lang.String getName()
      Generated method - Getter of the SnField.name attribute defined at extension searchservices.
      java.lang.String getQualifierTypeId()
      Generated method - Getter of the SnField.qualifierTypeId attribute defined at extension searchservices.
      java.lang.String getValueProvider()
      Generated method - Getter of the SnField.valueProvider attribute defined at extension searchservices.
      java.util.Map<java.lang.String,​java.lang.String> getValueProviderParameters()
      Generated method - Getter of the SnField.valueProviderParameters attribute defined at extension searchservices.
      java.lang.Float getWeight()
      Generated method - Getter of the SnField.weight attribute defined at extension searchservices.
      boolean isLocalized()
      Generated method - Getter of the SnField.localized attribute defined at extension searchservices.
      boolean isMultiValued()
      Generated method - Getter of the SnField.multiValued attribute defined at extension searchservices.
      boolean isRetrievable()
      Generated method - Getter of the SnField.retrievable attribute defined at extension searchservices.
      boolean isSearchable()
      Generated method - Getter of the SnField.searchable attribute defined at extension searchservices.
      boolean isUseForSpellchecking()
      Generated method - Getter of the SnField.useForSpellchecking attribute defined at extension searchservices.
      boolean isUseForSuggesting()
      Generated method - Getter of the SnField.useForSuggesting attribute defined at extension searchservices.
      void setFieldType​(SnFieldType value)
      Generated method - Setter of SnField.fieldType attribute defined at extension searchservices.
      void setId​(java.lang.String value)
      Generated method - Setter of SnField.id attribute defined at extension searchservices.
      void setIndexType​(SnIndexTypeModel value)
      Generated method - Initial setter of SnField.indexType attribute defined at extension searchservices.
      void setLocalized​(boolean value)
      Generated method - Setter of SnField.localized attribute defined at extension searchservices.
      void setMultiValued​(boolean value)
      Generated method - Setter of SnField.multiValued attribute defined at extension searchservices.
      void setName​(java.lang.String value)
      Generated method - Setter of SnField.name attribute defined at extension searchservices.
      void setQualifierTypeId​(java.lang.String value)
      Generated method - Setter of SnField.qualifierTypeId attribute defined at extension searchservices.
      void setRetrievable​(boolean value)
      Generated method - Setter of SnField.retrievable attribute defined at extension searchservices.
      void setSearchable​(boolean value)
      Generated method - Setter of SnField.searchable attribute defined at extension searchservices.
      void setUseForSpellchecking​(boolean value)
      Generated method - Setter of SnField.useForSpellchecking attribute defined at extension searchservices.
      void setUseForSuggesting​(boolean value)
      Generated method - Setter of SnField.useForSuggesting attribute defined at extension searchservices.
      void setValueProvider​(java.lang.String value)
      Generated method - Setter of SnField.valueProvider attribute defined at extension searchservices.
      void setValueProviderParameters​(java.util.Map<java.lang.String,​java.lang.String> value)
      Generated method - Setter of SnField.valueProviderParameters attribute defined at extension searchservices.
      void setWeight​(java.lang.Float value)
      Generated method - Setter of SnField.weight attribute defined at extension searchservices.

      • 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

      • _SNINDEXTYPE2FIELD

        public static final java.lang.String _SNINDEXTYPE2FIELD
        Generated relation code constant for relation SnIndexType2Field defining source attribute indexType in extension searchservices.
        See Also:
        Constant Field Values

      • ID

        public static final java.lang.String ID
        Generated constant - Attribute key of SnField.id attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of SnField.name attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • FIELDTYPE

        public static final java.lang.String FIELDTYPE
        Generated constant - Attribute key of SnField.fieldType attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • VALUEPROVIDER

        public static final java.lang.String VALUEPROVIDER
        Generated constant - Attribute key of SnField.valueProvider attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • VALUEPROVIDERPARAMETERS

        public static final java.lang.String VALUEPROVIDERPARAMETERS
        Generated constant - Attribute key of SnField.valueProviderParameters attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • RETRIEVABLE

        public static final java.lang.String RETRIEVABLE
        Generated constant - Attribute key of SnField.retrievable attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • SEARCHABLE

        public static final java.lang.String SEARCHABLE
        Generated constant - Attribute key of SnField.searchable attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • LOCALIZED

        public static final java.lang.String LOCALIZED
        Generated constant - Attribute key of SnField.localized attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • QUALIFIERTYPEID

        public static final java.lang.String QUALIFIERTYPEID
        Generated constant - Attribute key of SnField.qualifierTypeId attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • MULTIVALUED

        public static final java.lang.String MULTIVALUED
        Generated constant - Attribute key of SnField.multiValued attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • USEFORSPELLCHECKING

        public static final java.lang.String USEFORSPELLCHECKING
        Generated constant - Attribute key of SnField.useForSpellchecking attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • USEFORSUGGESTING

        public static final java.lang.String USEFORSUGGESTING
        Generated constant - Attribute key of SnField.useForSuggesting attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • WEIGHT

        public static final java.lang.String WEIGHT
        Generated constant - Attribute key of SnField.weight attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • INDEXTYPEPOS

        public static final java.lang.String INDEXTYPEPOS
        Generated constant - Attribute key of SnField.indexTypePOS attribute defined at extension searchservices.
        See Also:
        Constant Field Values

      • INDEXTYPE

        public static final java.lang.String INDEXTYPE
        Generated constant - Attribute key of SnField.indexType attribute defined at extension searchservices.
        See Also:
        Constant Field Values

    • Constructor Detail

      • SnFieldModel

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

      • SnFieldModel

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

      • SnFieldModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public SnFieldModel​(SnFieldType _fieldType,
                    java.lang.String _id,
                    SnIndexTypeModel _indexType)
        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:
        _fieldType - initial attribute declared by type SnField at extension searchservices
        _id - initial attribute declared by type SnField at extension searchservices
        _indexType - initial attribute declared by type SnField at extension searchservices

      • SnFieldModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public SnFieldModel​(SnFieldType _fieldType,
                    java.lang.String _id,
                    SnIndexTypeModel _indexType,
                    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:
        _fieldType - initial attribute declared by type SnField at extension searchservices
        _id - initial attribute declared by type SnField at extension searchservices
        _indexType - initial attribute declared by type SnField at extension searchservices
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getFieldType

        @Accessor(qualifier="fieldType",
          type=GETTER)
public SnFieldType getFieldType()
        Generated method - Getter of the SnField.fieldType attribute defined at extension searchservices.
        Returns:
        the fieldType

      • getId

        @Accessor(qualifier="id",
          type=GETTER)
public java.lang.String getId()
        Generated method - Getter of the SnField.id attribute defined at extension searchservices.
        Returns:
        the id

      • getIndexType

        @Accessor(qualifier="indexType",
          type=GETTER)
public SnIndexTypeModel getIndexType()
        Generated method - Getter of the SnField.indexType attribute defined at extension searchservices.
        Returns:
        the indexType

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the SnField.name attribute defined at extension searchservices.
        Returns:
        the name

      • getQualifierTypeId

        @Accessor(qualifier="qualifierTypeId",
          type=GETTER)
public java.lang.String getQualifierTypeId()
        Generated method - Getter of the SnField.qualifierTypeId attribute defined at extension searchservices.
        Returns:
        the qualifierTypeId

      • getValueProvider

        @Accessor(qualifier="valueProvider",
          type=GETTER)
public java.lang.String getValueProvider()
        Generated method - Getter of the SnField.valueProvider attribute defined at extension searchservices.
        Returns:
        the valueProvider

      • getValueProviderParameters

        @Accessor(qualifier="valueProviderParameters",
          type=GETTER)
public java.util.Map<java.lang.String,​java.lang.String> getValueProviderParameters()
        Generated method - Getter of the SnField.valueProviderParameters attribute defined at extension searchservices.
        Returns:
        the valueProviderParameters

      • getWeight

        @Accessor(qualifier="weight",
          type=GETTER)
public java.lang.Float getWeight()
        Generated method - Getter of the SnField.weight attribute defined at extension searchservices.
        Returns:
        the weight

      • isLocalized

        @Accessor(qualifier="localized",
          type=GETTER)
public boolean isLocalized()
        Generated method - Getter of the SnField.localized attribute defined at extension searchservices.
        Returns:
        the localized

      • isMultiValued

        @Accessor(qualifier="multiValued",
          type=GETTER)
public boolean isMultiValued()
        Generated method - Getter of the SnField.multiValued attribute defined at extension searchservices.
        Returns:
        the multiValued

      • isRetrievable

        @Accessor(qualifier="retrievable",
          type=GETTER)
public boolean isRetrievable()
        Generated method - Getter of the SnField.retrievable attribute defined at extension searchservices.
        Returns:
        the retrievable

      • isSearchable

        @Accessor(qualifier="searchable",
          type=GETTER)
public boolean isSearchable()
        Generated method - Getter of the SnField.searchable attribute defined at extension searchservices.
        Returns:
        the searchable

      • isUseForSpellchecking

        @Accessor(qualifier="useForSpellchecking",
          type=GETTER)
public boolean isUseForSpellchecking()
        Generated method - Getter of the SnField.useForSpellchecking attribute defined at extension searchservices.
        Returns:
        the useForSpellchecking

      • isUseForSuggesting

        @Accessor(qualifier="useForSuggesting",
          type=GETTER)
public boolean isUseForSuggesting()
        Generated method - Getter of the SnField.useForSuggesting attribute defined at extension searchservices.
        Returns:
        the useForSuggesting

      • setFieldType

        @Accessor(qualifier="fieldType",
          type=SETTER)
public void setFieldType​(SnFieldType value)
        Generated method - Setter of SnField.fieldType attribute defined at extension searchservices.
        Parameters:
        value - the fieldType

      • setId

        @Accessor(qualifier="id",
          type=SETTER)
public void setId​(java.lang.String value)
        Generated method - Setter of SnField.id attribute defined at extension searchservices.
        Parameters:
        value - the id

      • setIndexType

        @Accessor(qualifier="indexType",
          type=SETTER)
public void setIndexType​(SnIndexTypeModel value)
        Generated method - Initial setter of SnField.indexType attribute defined at extension searchservices. Can only be used at creation of model - before first save.
        Parameters:
        value - the indexType

      • setLocalized

        @Accessor(qualifier="localized",
          type=SETTER)
public void setLocalized​(boolean value)
        Generated method - Setter of SnField.localized attribute defined at extension searchservices.
        Parameters:
        value - the localized

      • setMultiValued

        @Accessor(qualifier="multiValued",
          type=SETTER)
public void setMultiValued​(boolean value)
        Generated method - Setter of SnField.multiValued attribute defined at extension searchservices.
        Parameters:
        value - the multiValued

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of SnField.name attribute defined at extension searchservices.
        Parameters:
        value - the name

      • setQualifierTypeId

        @Accessor(qualifier="qualifierTypeId",
          type=SETTER)
public void setQualifierTypeId​(java.lang.String value)
        Generated method - Setter of SnField.qualifierTypeId attribute defined at extension searchservices.
        Parameters:
        value - the qualifierTypeId

      • setRetrievable

        @Accessor(qualifier="retrievable",
          type=SETTER)
public void setRetrievable​(boolean value)
        Generated method - Setter of SnField.retrievable attribute defined at extension searchservices.
        Parameters:
        value - the retrievable

      • setSearchable

        @Accessor(qualifier="searchable",
          type=SETTER)
public void setSearchable​(boolean value)
        Generated method - Setter of SnField.searchable attribute defined at extension searchservices.
        Parameters:
        value - the searchable

      • setUseForSpellchecking

        @Accessor(qualifier="useForSpellchecking",
          type=SETTER)
public void setUseForSpellchecking​(boolean value)
        Generated method - Setter of SnField.useForSpellchecking attribute defined at extension searchservices.
        Parameters:
        value - the useForSpellchecking

      • setUseForSuggesting

        @Accessor(qualifier="useForSuggesting",
          type=SETTER)
public void setUseForSuggesting​(boolean value)
        Generated method - Setter of SnField.useForSuggesting attribute defined at extension searchservices.
        Parameters:
        value - the useForSuggesting

      • setValueProvider

        @Accessor(qualifier="valueProvider",
          type=SETTER)
public void setValueProvider​(java.lang.String value)
        Generated method - Setter of SnField.valueProvider attribute defined at extension searchservices.
        Parameters:
        value - the valueProvider

      • setValueProviderParameters

        @Accessor(qualifier="valueProviderParameters",
          type=SETTER)
public void setValueProviderParameters​(java.util.Map<java.lang.String,​java.lang.String> value)
        Generated method - Setter of SnField.valueProviderParameters attribute defined at extension searchservices.
        Parameters:
        value - the valueProviderParameters

      • setWeight

        @Accessor(qualifier="weight",
          type=SETTER)
public void setWeight​(java.lang.Float value)
        Generated method - Setter of SnField.weight attribute defined at extension searchservices.
        Parameters:
        value - the weight