Class GeneratedSnField

All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
SnField

public abstract class GeneratedSnField extends GenericItem
Generated class for type SnField.
See Also:
  • Field Details

    • ID

      public static final String ID
      Qualifier of the SnField.id attribute
      See Also:
    • NAME

      public static final String NAME
      Qualifier of the SnField.name attribute
      See Also:
    • FIELDTYPE

      public static final String FIELDTYPE
      Qualifier of the SnField.fieldType attribute
      See Also:
    • VALUEPROVIDER

      public static final String VALUEPROVIDER
      Qualifier of the SnField.valueProvider attribute
      See Also:
    • VALUEPROVIDERPARAMETERS

      public static final String VALUEPROVIDERPARAMETERS
      Qualifier of the SnField.valueProviderParameters attribute
      See Also:
    • RETRIEVABLE

      public static final String RETRIEVABLE
      Qualifier of the SnField.retrievable attribute
      See Also:
    • SEARCHABLE

      public static final String SEARCHABLE
      Qualifier of the SnField.searchable attribute
      See Also:
    • SEARCHTOLERANCE

      public static final String SEARCHTOLERANCE
      Qualifier of the SnField.searchTolerance attribute
      See Also:
    • LOCALIZED

      public static final String LOCALIZED
      Qualifier of the SnField.localized attribute
      See Also:
    • QUALIFIERTYPEID

      public static final String QUALIFIERTYPEID
      Qualifier of the SnField.qualifierTypeId attribute
      See Also:
    • MULTIVALUED

      public static final String MULTIVALUED
      Qualifier of the SnField.multiValued attribute
      See Also:
    • USEFORSPELLCHECKING

      public static final String USEFORSPELLCHECKING
      Qualifier of the SnField.useForSpellchecking attribute
      See Also:
    • USEFORSUGGESTING

      public static final String USEFORSUGGESTING
      Qualifier of the SnField.useForSuggesting attribute
      See Also:
    • WEIGHT

      public static final String WEIGHT
      Qualifier of the SnField.weight attribute
      See Also:
    • INDEXTYPEPOS

      public static final String INDEXTYPEPOS
      Qualifier of the SnField.indexTypePOS attribute
      See Also:
    • INDEXTYPE

      public static final String INDEXTYPE
      Qualifier of the SnField.indexType attribute
      See Also:
    • INDEXERITEMSOURCEOPERATIONS

      public static final String INDEXERITEMSOURCEOPERATIONS
      Qualifier of the SnField.indexerItemSourceOperations attribute
      See Also:
    • SNINDEXERITEMSOURCEOPERATION2FIELD_SRC_ORDERED

      protected static String SNINDEXERITEMSOURCEOPERATION2FIELD_SRC_ORDERED
      Relation ordering override parameter constants for SnIndexerItemSourceOperation2Field from ((searchservices))
    • SNINDEXERITEMSOURCEOPERATION2FIELD_TGT_ORDERED

      protected static String SNINDEXERITEMSOURCEOPERATION2FIELD_TGT_ORDERED
    • SNINDEXERITEMSOURCEOPERATION2FIELD_MARKMODIFIED

      protected static String SNINDEXERITEMSOURCEOPERATION2FIELD_MARKMODIFIED
      Relation disable markmodifed parameter constants for SnIndexerItemSourceOperation2Field from ((searchservices))
    • INDEXTYPEHANDLER

      protected static final BidirectionalOneToManyHandler<GeneratedSnField> INDEXTYPEHANDLER
      BidirectionalOneToManyHandler for handling 1:n INDEXTYPE's relation attributes from 'one' side.
    • DEFAULT_INITIAL_ATTRIBUTES

      protected static final Map<String,Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES
  • Constructor Details

    • GeneratedSnField

      public GeneratedSnField()
  • Method Details

    • getDefaultAttributeModes

      protected Map<String,Item.AttributeMode> getDefaultAttributeModes()
      Overrides:
      getDefaultAttributeModes in class Item
    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example:

      
       public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
       ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
       man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
       // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
       SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
       super.getNonInitialAttributes( ctx, allAttributes );
       // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      
       
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked
    • getFieldType

      public EnumerationValue getFieldType(SessionContext ctx)
      Generated method - Getter of the SnField.fieldType attribute.
      Returns:
      the fieldType
    • getFieldType

      public EnumerationValue getFieldType()
      Generated method - Getter of the SnField.fieldType attribute.
      Returns:
      the fieldType
    • setFieldType

      public void setFieldType(SessionContext ctx, EnumerationValue value)
      Generated method - Setter of the SnField.fieldType attribute.
      Parameters:
      value - the fieldType
    • setFieldType

      public void setFieldType(EnumerationValue value)
      Generated method - Setter of the SnField.fieldType attribute.
      Parameters:
      value - the fieldType
    • getId

      public String getId(SessionContext ctx)
      Generated method - Getter of the SnField.id attribute.
      Returns:
      the id
    • getId

      public String getId()
      Generated method - Getter of the SnField.id attribute.
      Returns:
      the id
    • setId

      public void setId(SessionContext ctx, String value)
      Generated method - Setter of the SnField.id attribute.
      Parameters:
      value - the id
    • setId

      public void setId(String value)
      Generated method - Setter of the SnField.id attribute.
      Parameters:
      value - the id
    • getIndexerItemSourceOperations

      public List<SnIndexerItemSourceOperation> getIndexerItemSourceOperations(SessionContext ctx)
      Generated method - Getter of the SnField.indexerItemSourceOperations attribute.
      Returns:
      the indexerItemSourceOperations
    • getIndexerItemSourceOperations

      public List<SnIndexerItemSourceOperation> getIndexerItemSourceOperations()
      Generated method - Getter of the SnField.indexerItemSourceOperations attribute.
      Returns:
      the indexerItemSourceOperations
    • getIndexerItemSourceOperationsCount

      public long getIndexerItemSourceOperationsCount(SessionContext ctx)
    • getIndexerItemSourceOperationsCount

      public long getIndexerItemSourceOperationsCount()
    • setIndexerItemSourceOperations

      public void setIndexerItemSourceOperations(SessionContext ctx, List<SnIndexerItemSourceOperation> value)
      Generated method - Setter of the SnField.indexerItemSourceOperations attribute.
      Parameters:
      value - the indexerItemSourceOperations
    • setIndexerItemSourceOperations

      public void setIndexerItemSourceOperations(List<SnIndexerItemSourceOperation> value)
      Generated method - Setter of the SnField.indexerItemSourceOperations attribute.
      Parameters:
      value - the indexerItemSourceOperations
    • addToIndexerItemSourceOperations

      public void addToIndexerItemSourceOperations(SessionContext ctx, SnIndexerItemSourceOperation value)
      Generated method - Adds value to indexerItemSourceOperations.
      Parameters:
      value - the item to add to indexerItemSourceOperations
    • addToIndexerItemSourceOperations

      public void addToIndexerItemSourceOperations(SnIndexerItemSourceOperation value)
      Generated method - Adds value to indexerItemSourceOperations.
      Parameters:
      value - the item to add to indexerItemSourceOperations
    • removeFromIndexerItemSourceOperations

      public void removeFromIndexerItemSourceOperations(SessionContext ctx, SnIndexerItemSourceOperation value)
      Generated method - Removes value from indexerItemSourceOperations.
      Parameters:
      value - the item to remove from indexerItemSourceOperations
    • removeFromIndexerItemSourceOperations

      public void removeFromIndexerItemSourceOperations(SnIndexerItemSourceOperation value)
      Generated method - Removes value from indexerItemSourceOperations.
      Parameters:
      value - the item to remove from indexerItemSourceOperations
    • getIndexType

      public SnIndexType getIndexType(SessionContext ctx)
      Generated method - Getter of the SnField.indexType attribute.
      Returns:
      the indexType
    • getIndexType

      public SnIndexType getIndexType()
      Generated method - Getter of the SnField.indexType attribute.
      Returns:
      the indexType
    • setIndexType

      protected void setIndexType(SessionContext ctx, SnIndexType value)
      Generated method - Setter of the SnField.indexType attribute.
      Parameters:
      value - the indexType
    • setIndexType

      protected void setIndexType(SnIndexType value)
      Generated method - Setter of the SnField.indexType attribute.
      Parameters:
      value - the indexType
    • isMarkModifiedDisabled

      @Deprecated(since="2105", forRemoval=true) public boolean isMarkModifiedDisabled(Item referencedItem)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isMarkModifiedDisabled in class Item
    • isLocalized

      public Boolean isLocalized(SessionContext ctx)
      Generated method - Getter of the SnField.localized attribute.
      Returns:
      the localized
    • isLocalized

      public Boolean isLocalized()
      Generated method - Getter of the SnField.localized attribute.
      Returns:
      the localized
    • isLocalizedAsPrimitive

      public boolean isLocalizedAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.localized attribute.
      Returns:
      the localized
    • isLocalizedAsPrimitive

      public boolean isLocalizedAsPrimitive()
      Generated method - Getter of the SnField.localized attribute.
      Returns:
      the localized
    • setLocalized

      public void setLocalized(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.localized attribute.
      Parameters:
      value - the localized
    • setLocalized

      public void setLocalized(Boolean value)
      Generated method - Setter of the SnField.localized attribute.
      Parameters:
      value - the localized
    • setLocalized

      public void setLocalized(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.localized attribute.
      Parameters:
      value - the localized
    • setLocalized

      public void setLocalized(boolean value)
      Generated method - Setter of the SnField.localized attribute.
      Parameters:
      value - the localized
    • isMultiValued

      public Boolean isMultiValued(SessionContext ctx)
      Generated method - Getter of the SnField.multiValued attribute.
      Returns:
      the multiValued
    • isMultiValued

      public Boolean isMultiValued()
      Generated method - Getter of the SnField.multiValued attribute.
      Returns:
      the multiValued
    • isMultiValuedAsPrimitive

      public boolean isMultiValuedAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.multiValued attribute.
      Returns:
      the multiValued
    • isMultiValuedAsPrimitive

      public boolean isMultiValuedAsPrimitive()
      Generated method - Getter of the SnField.multiValued attribute.
      Returns:
      the multiValued
    • setMultiValued

      public void setMultiValued(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.multiValued attribute.
      Parameters:
      value - the multiValued
    • setMultiValued

      public void setMultiValued(Boolean value)
      Generated method - Setter of the SnField.multiValued attribute.
      Parameters:
      value - the multiValued
    • setMultiValued

      public void setMultiValued(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.multiValued attribute.
      Parameters:
      value - the multiValued
    • setMultiValued

      public void setMultiValued(boolean value)
      Generated method - Setter of the SnField.multiValued attribute.
      Parameters:
      value - the multiValued
    • getName

      public String getName(SessionContext ctx)
      Generated method - Getter of the SnField.name attribute.
      Returns:
      the name
    • getName

      public String getName()
      Generated method - Getter of the SnField.name attribute.
      Returns:
      the name
    • getAllName

      public Map<Language,String> getAllName(SessionContext ctx)
      Generated method - Getter of the SnField.name attribute.
      Returns:
      the localized name
    • getAllName

      public Map<Language,String> getAllName()
      Generated method - Getter of the SnField.name attribute.
      Returns:
      the localized name
    • setName

      public void setName(SessionContext ctx, String value)
      Generated method - Setter of the SnField.name attribute.
      Parameters:
      value - the name
    • setName

      public void setName(String value)
      Generated method - Setter of the SnField.name attribute.
      Parameters:
      value - the name
    • setAllName

      public void setAllName(SessionContext ctx, Map<Language,String> value)
      Generated method - Setter of the SnField.name attribute.
      Parameters:
      value - the name
    • setAllName

      public void setAllName(Map<Language,String> value)
      Generated method - Setter of the SnField.name attribute.
      Parameters:
      value - the name
    • getQualifierTypeId

      public String getQualifierTypeId(SessionContext ctx)
      Generated method - Getter of the SnField.qualifierTypeId attribute.
      Returns:
      the qualifierTypeId
    • getQualifierTypeId

      public String getQualifierTypeId()
      Generated method - Getter of the SnField.qualifierTypeId attribute.
      Returns:
      the qualifierTypeId
    • setQualifierTypeId

      public void setQualifierTypeId(SessionContext ctx, String value)
      Generated method - Setter of the SnField.qualifierTypeId attribute.
      Parameters:
      value - the qualifierTypeId
    • setQualifierTypeId

      public void setQualifierTypeId(String value)
      Generated method - Setter of the SnField.qualifierTypeId attribute.
      Parameters:
      value - the qualifierTypeId
    • isRetrievable

      public Boolean isRetrievable(SessionContext ctx)
      Generated method - Getter of the SnField.retrievable attribute.
      Returns:
      the retrievable
    • isRetrievable

      public Boolean isRetrievable()
      Generated method - Getter of the SnField.retrievable attribute.
      Returns:
      the retrievable
    • isRetrievableAsPrimitive

      public boolean isRetrievableAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.retrievable attribute.
      Returns:
      the retrievable
    • isRetrievableAsPrimitive

      public boolean isRetrievableAsPrimitive()
      Generated method - Getter of the SnField.retrievable attribute.
      Returns:
      the retrievable
    • setRetrievable

      public void setRetrievable(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.retrievable attribute.
      Parameters:
      value - the retrievable
    • setRetrievable

      public void setRetrievable(Boolean value)
      Generated method - Setter of the SnField.retrievable attribute.
      Parameters:
      value - the retrievable
    • setRetrievable

      public void setRetrievable(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.retrievable attribute.
      Parameters:
      value - the retrievable
    • setRetrievable

      public void setRetrievable(boolean value)
      Generated method - Setter of the SnField.retrievable attribute.
      Parameters:
      value - the retrievable
    • isSearchable

      public Boolean isSearchable(SessionContext ctx)
      Generated method - Getter of the SnField.searchable attribute.
      Returns:
      the searchable
    • isSearchable

      public Boolean isSearchable()
      Generated method - Getter of the SnField.searchable attribute.
      Returns:
      the searchable
    • isSearchableAsPrimitive

      public boolean isSearchableAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.searchable attribute.
      Returns:
      the searchable
    • isSearchableAsPrimitive

      public boolean isSearchableAsPrimitive()
      Generated method - Getter of the SnField.searchable attribute.
      Returns:
      the searchable
    • setSearchable

      public void setSearchable(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.searchable attribute.
      Parameters:
      value - the searchable
    • setSearchable

      public void setSearchable(Boolean value)
      Generated method - Setter of the SnField.searchable attribute.
      Parameters:
      value - the searchable
    • setSearchable

      public void setSearchable(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.searchable attribute.
      Parameters:
      value - the searchable
    • setSearchable

      public void setSearchable(boolean value)
      Generated method - Setter of the SnField.searchable attribute.
      Parameters:
      value - the searchable
    • getSearchTolerance

      public EnumerationValue getSearchTolerance(SessionContext ctx)
      Generated method - Getter of the SnField.searchTolerance attribute.
      Returns:
      the searchTolerance
    • getSearchTolerance

      public EnumerationValue getSearchTolerance()
      Generated method - Getter of the SnField.searchTolerance attribute.
      Returns:
      the searchTolerance
    • setSearchTolerance

      public void setSearchTolerance(SessionContext ctx, EnumerationValue value)
      Generated method - Setter of the SnField.searchTolerance attribute.
      Parameters:
      value - the searchTolerance
    • setSearchTolerance

      public void setSearchTolerance(EnumerationValue value)
      Generated method - Setter of the SnField.searchTolerance attribute.
      Parameters:
      value - the searchTolerance
    • isUseForSpellchecking

      public Boolean isUseForSpellchecking(SessionContext ctx)
      Generated method - Getter of the SnField.useForSpellchecking attribute.
      Returns:
      the useForSpellchecking
    • isUseForSpellchecking

      public Boolean isUseForSpellchecking()
      Generated method - Getter of the SnField.useForSpellchecking attribute.
      Returns:
      the useForSpellchecking
    • isUseForSpellcheckingAsPrimitive

      public boolean isUseForSpellcheckingAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.useForSpellchecking attribute.
      Returns:
      the useForSpellchecking
    • isUseForSpellcheckingAsPrimitive

      public boolean isUseForSpellcheckingAsPrimitive()
      Generated method - Getter of the SnField.useForSpellchecking attribute.
      Returns:
      the useForSpellchecking
    • setUseForSpellchecking

      public void setUseForSpellchecking(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.useForSpellchecking attribute.
      Parameters:
      value - the useForSpellchecking
    • setUseForSpellchecking

      public void setUseForSpellchecking(Boolean value)
      Generated method - Setter of the SnField.useForSpellchecking attribute.
      Parameters:
      value - the useForSpellchecking
    • setUseForSpellchecking

      public void setUseForSpellchecking(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.useForSpellchecking attribute.
      Parameters:
      value - the useForSpellchecking
    • setUseForSpellchecking

      public void setUseForSpellchecking(boolean value)
      Generated method - Setter of the SnField.useForSpellchecking attribute.
      Parameters:
      value - the useForSpellchecking
    • isUseForSuggesting

      public Boolean isUseForSuggesting(SessionContext ctx)
      Generated method - Getter of the SnField.useForSuggesting attribute.
      Returns:
      the useForSuggesting
    • isUseForSuggesting

      public Boolean isUseForSuggesting()
      Generated method - Getter of the SnField.useForSuggesting attribute.
      Returns:
      the useForSuggesting
    • isUseForSuggestingAsPrimitive

      public boolean isUseForSuggestingAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.useForSuggesting attribute.
      Returns:
      the useForSuggesting
    • isUseForSuggestingAsPrimitive

      public boolean isUseForSuggestingAsPrimitive()
      Generated method - Getter of the SnField.useForSuggesting attribute.
      Returns:
      the useForSuggesting
    • setUseForSuggesting

      public void setUseForSuggesting(SessionContext ctx, Boolean value)
      Generated method - Setter of the SnField.useForSuggesting attribute.
      Parameters:
      value - the useForSuggesting
    • setUseForSuggesting

      public void setUseForSuggesting(Boolean value)
      Generated method - Setter of the SnField.useForSuggesting attribute.
      Parameters:
      value - the useForSuggesting
    • setUseForSuggesting

      public void setUseForSuggesting(SessionContext ctx, boolean value)
      Generated method - Setter of the SnField.useForSuggesting attribute.
      Parameters:
      value - the useForSuggesting
    • setUseForSuggesting

      public void setUseForSuggesting(boolean value)
      Generated method - Setter of the SnField.useForSuggesting attribute.
      Parameters:
      value - the useForSuggesting
    • getValueProvider

      public String getValueProvider(SessionContext ctx)
      Generated method - Getter of the SnField.valueProvider attribute.
      Returns:
      the valueProvider
    • getValueProvider

      public String getValueProvider()
      Generated method - Getter of the SnField.valueProvider attribute.
      Returns:
      the valueProvider
    • setValueProvider

      public void setValueProvider(SessionContext ctx, String value)
      Generated method - Setter of the SnField.valueProvider attribute.
      Parameters:
      value - the valueProvider
    • setValueProvider

      public void setValueProvider(String value)
      Generated method - Setter of the SnField.valueProvider attribute.
      Parameters:
      value - the valueProvider
    • getAllValueProviderParameters

      public Map<String,String> getAllValueProviderParameters(SessionContext ctx)
      Generated method - Getter of the SnField.valueProviderParameters attribute.
      Returns:
      the valueProviderParameters
    • getAllValueProviderParameters

      public Map<String,String> getAllValueProviderParameters()
      Generated method - Getter of the SnField.valueProviderParameters attribute.
      Returns:
      the valueProviderParameters
    • setAllValueProviderParameters

      public void setAllValueProviderParameters(SessionContext ctx, Map<String,String> value)
      Generated method - Setter of the SnField.valueProviderParameters attribute.
      Parameters:
      value - the valueProviderParameters
    • setAllValueProviderParameters

      public void setAllValueProviderParameters(Map<String,String> value)
      Generated method - Setter of the SnField.valueProviderParameters attribute.
      Parameters:
      value - the valueProviderParameters
    • getWeight

      public Float getWeight(SessionContext ctx)
      Generated method - Getter of the SnField.weight attribute.
      Returns:
      the weight
    • getWeight

      public Float getWeight()
      Generated method - Getter of the SnField.weight attribute.
      Returns:
      the weight
    • getWeightAsPrimitive

      public float getWeightAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SnField.weight attribute.
      Returns:
      the weight
    • getWeightAsPrimitive

      public float getWeightAsPrimitive()
      Generated method - Getter of the SnField.weight attribute.
      Returns:
      the weight
    • setWeight

      public void setWeight(SessionContext ctx, Float value)
      Generated method - Setter of the SnField.weight attribute.
      Parameters:
      value - the weight
    • setWeight

      public void setWeight(Float value)
      Generated method - Setter of the SnField.weight attribute.
      Parameters:
      value - the weight
    • setWeight

      public void setWeight(SessionContext ctx, float value)
      Generated method - Setter of the SnField.weight attribute.
      Parameters:
      value - the weight
    • setWeight

      public void setWeight(float value)
      Generated method - Setter of the SnField.weight attribute.
      Parameters:
      value - the weight