Class SnFieldModel

All Implemented Interfaces:
Serializable

public class SnFieldModel extends ItemModel
Generated model class for type SnField first defined at extension searchservices.
See Also:
  • Field Details

    • _TYPECODE

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

      public static final String _SNINDEXTYPE2FIELD
      Generated relation code constant for relation SnIndexType2Field defining source attribute indexType in extension searchservices.
      See Also:
    • _SNINDEXERITEMSOURCEOPERATION2FIELD

      public static final String _SNINDEXERITEMSOURCEOPERATION2FIELD
      Generated relation code constant for relation SnIndexerItemSourceOperation2Field defining source attribute indexerItemSourceOperations in extension searchservices.
      See Also:
    • ID

      public static final String ID
      Generated constant - Attribute key of SnField.id attribute defined at extension searchservices.
      See Also:
    • NAME

      public static final String NAME
      Generated constant - Attribute key of SnField.name attribute defined at extension searchservices.
      See Also:
    • FIELDTYPE

      public static final String FIELDTYPE
      Generated constant - Attribute key of SnField.fieldType attribute defined at extension searchservices.
      See Also:
    • VALUEPROVIDER

      public static final String VALUEPROVIDER
      Generated constant - Attribute key of SnField.valueProvider attribute defined at extension searchservices.
      See Also:
    • VALUEPROVIDERPARAMETERS

      public static final String VALUEPROVIDERPARAMETERS
      Generated constant - Attribute key of SnField.valueProviderParameters attribute defined at extension searchservices.
      See Also:
    • RETRIEVABLE

      public static final String RETRIEVABLE
      Generated constant - Attribute key of SnField.retrievable attribute defined at extension searchservices.
      See Also:
    • SEARCHABLE

      public static final String SEARCHABLE
      Generated constant - Attribute key of SnField.searchable attribute defined at extension searchservices.
      See Also:
    • SEARCHTOLERANCE

      public static final String SEARCHTOLERANCE
      Generated constant - Attribute key of SnField.searchTolerance attribute defined at extension searchservices.
      See Also:
    • LOCALIZED

      public static final String LOCALIZED
      Generated constant - Attribute key of SnField.localized attribute defined at extension searchservices.
      See Also:
    • QUALIFIERTYPEID

      public static final String QUALIFIERTYPEID
      Generated constant - Attribute key of SnField.qualifierTypeId attribute defined at extension searchservices.
      See Also:
    • MULTIVALUED

      public static final String MULTIVALUED
      Generated constant - Attribute key of SnField.multiValued attribute defined at extension searchservices.
      See Also:
    • USEFORSPELLCHECKING

      public static final String USEFORSPELLCHECKING
      Generated constant - Attribute key of SnField.useForSpellchecking attribute defined at extension searchservices.
      See Also:
    • USEFORSUGGESTING

      public static final String USEFORSUGGESTING
      Generated constant - Attribute key of SnField.useForSuggesting attribute defined at extension searchservices.
      See Also:
    • WEIGHT

      public static final String WEIGHT
      Generated constant - Attribute key of SnField.weight attribute defined at extension searchservices.
      See Also:
    • INDEXTYPEPOS

      public static final String INDEXTYPEPOS
      Generated constant - Attribute key of SnField.indexTypePOS attribute defined at extension searchservices.
      See Also:
    • INDEXTYPE

      public static final String INDEXTYPE
      Generated constant - Attribute key of SnField.indexType attribute defined at extension searchservices.
      See Also:
    • INDEXERITEMSOURCEOPERATIONS

      public static final String INDEXERITEMSOURCEOPERATIONS
      Generated constant - Attribute key of SnField.indexerItemSourceOperations attribute defined at extension searchservices.
      See Also:
  • Constructor Details

    • 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, 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, 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 Details

    • 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 String getId()
      Generated method - Getter of the SnField.id attribute defined at extension searchservices.
      Returns:
      the id
    • getIndexerItemSourceOperations

      @Accessor(qualifier="indexerItemSourceOperations", type=GETTER) public List<SnIndexerItemSourceOperationModel> getIndexerItemSourceOperations()
      Generated method - Getter of the SnField.indexerItemSourceOperations attribute defined at extension searchservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the indexerItemSourceOperations
    • getIndexType

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

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

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

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

      @Accessor(qualifier="name", type=GETTER) public String getName(Locale loc)
      Generated method - Getter of the SnField.name attribute defined at extension searchservices.
      Parameters:
      loc - the value localization key
      Returns:
      the name
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • getQualifierTypeId

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

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

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

      @Accessor(qualifier="searchTolerance", type=GETTER) public SnSearchTolerance getSearchTolerance()
      Generated method - Getter of the SnField.searchTolerance attribute defined at extension searchservices.
      Returns:
      the searchTolerance
    • getUseForSpellchecking

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

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

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

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

      @Accessor(qualifier="weight", type=GETTER) public Float getWeight()
      Generated method - Getter of the SnField.weight attribute defined at extension searchservices.
      Returns:
      the weight
    • 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(String value)
      Generated method - Setter of SnField.id attribute defined at extension searchservices.
      Parameters:
      value - the id
    • setIndexerItemSourceOperations

      @Accessor(qualifier="indexerItemSourceOperations", type=SETTER) public void setIndexerItemSourceOperations(List<SnIndexerItemSourceOperationModel> value)
      Generated method - Setter of SnField.indexerItemSourceOperations attribute defined at extension searchservices.
      Parameters:
      value - the indexerItemSourceOperations
    • 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(String value)
      Generated method - Setter of SnField.name attribute defined at extension searchservices.
      Parameters:
      value - the name
    • setName

      @Accessor(qualifier="name", type=SETTER) public void setName(String value, Locale loc)
      Generated method - Setter of SnField.name attribute defined at extension searchservices.
      Parameters:
      value - the name
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • setQualifierTypeId

      @Accessor(qualifier="qualifierTypeId", type=SETTER) public void setQualifierTypeId(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
    • setSearchTolerance

      @Accessor(qualifier="searchTolerance", type=SETTER) public void setSearchTolerance(SnSearchTolerance value)
      Generated method - Setter of SnField.searchTolerance attribute defined at extension searchservices.
      Parameters:
      value - the searchTolerance
    • 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(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(Map<String,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(Float value)
      Generated method - Setter of SnField.weight attribute defined at extension searchservices.
      Parameters:
      value - the weight