Class GeneratedSnField

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable
    Direct Known Subclasses:
    SnField

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

      • ID

        public static final java.lang.String ID
        Qualifier of the SnField.id attribute
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Qualifier of the SnField.name attribute
        See Also:
        Constant Field Values
      • FIELDTYPE

        public static final java.lang.String FIELDTYPE
        Qualifier of the SnField.fieldType attribute
        See Also:
        Constant Field Values
      • VALUEPROVIDER

        public static final java.lang.String VALUEPROVIDER
        Qualifier of the SnField.valueProvider attribute
        See Also:
        Constant Field Values
      • VALUEPROVIDERPARAMETERS

        public static final java.lang.String VALUEPROVIDERPARAMETERS
        Qualifier of the SnField.valueProviderParameters attribute
        See Also:
        Constant Field Values
      • RETRIEVABLE

        public static final java.lang.String RETRIEVABLE
        Qualifier of the SnField.retrievable attribute
        See Also:
        Constant Field Values
      • SEARCHABLE

        public static final java.lang.String SEARCHABLE
        Qualifier of the SnField.searchable attribute
        See Also:
        Constant Field Values
      • LOCALIZED

        public static final java.lang.String LOCALIZED
        Qualifier of the SnField.localized attribute
        See Also:
        Constant Field Values
      • QUALIFIERTYPEID

        public static final java.lang.String QUALIFIERTYPEID
        Qualifier of the SnField.qualifierTypeId attribute
        See Also:
        Constant Field Values
      • MULTIVALUED

        public static final java.lang.String MULTIVALUED
        Qualifier of the SnField.multiValued attribute
        See Also:
        Constant Field Values
      • USEFORSPELLCHECKING

        public static final java.lang.String USEFORSPELLCHECKING
        Qualifier of the SnField.useForSpellchecking attribute
        See Also:
        Constant Field Values
      • USEFORSUGGESTING

        public static final java.lang.String USEFORSUGGESTING
        Qualifier of the SnField.useForSuggesting attribute
        See Also:
        Constant Field Values
      • WEIGHT

        public static final java.lang.String WEIGHT
        Qualifier of the SnField.weight attribute
        See Also:
        Constant Field Values
      • INDEXTYPEPOS

        public static final java.lang.String INDEXTYPEPOS
        Qualifier of the SnField.indexTypePOS attribute
        See Also:
        Constant Field Values
      • INDEXTYPE

        public static final java.lang.String INDEXTYPE
        Qualifier of the SnField.indexType attribute
        See Also:
        Constant Field Values
      • DEFAULT_INITIAL_ATTRIBUTES

        protected static final java.util.Map<java.lang.String,​Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES
    • Constructor Detail

      • GeneratedSnField

        public GeneratedSnField()
    • Method Detail

      • 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 java.lang.String getId​(SessionContext ctx)
        Generated method - Getter of the SnField.id attribute.
        Returns:
        the id
      • getId

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

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

        public void setId​(java.lang.String value)
        Generated method - Setter of the SnField.id attribute.
        Parameters:
        value - the id
      • 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
      • isLocalized

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

        public java.lang.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,
                                 java.lang.Boolean value)
        Generated method - Setter of the SnField.localized attribute.
        Parameters:
        value - the localized
      • setLocalized

        public void setLocalized​(java.lang.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 java.lang.Boolean isMultiValued​(SessionContext ctx)
        Generated method - Getter of the SnField.multiValued attribute.
        Returns:
        the multiValued
      • isMultiValued

        public java.lang.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,
                                   java.lang.Boolean value)
        Generated method - Setter of the SnField.multiValued attribute.
        Parameters:
        value - the multiValued
      • setMultiValued

        public void setMultiValued​(java.lang.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 java.lang.String getName​(SessionContext ctx)
        Generated method - Getter of the SnField.name attribute.
        Returns:
        the name
      • getName

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

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

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

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

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

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

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

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

        public java.lang.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,
                                   java.lang.Boolean value)
        Generated method - Setter of the SnField.retrievable attribute.
        Parameters:
        value - the retrievable
      • setRetrievable

        public void setRetrievable​(java.lang.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 java.lang.Boolean isSearchable​(SessionContext ctx)
        Generated method - Getter of the SnField.searchable attribute.
        Returns:
        the searchable
      • isSearchable

        public java.lang.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,
                                  java.lang.Boolean value)
        Generated method - Setter of the SnField.searchable attribute.
        Parameters:
        value - the searchable
      • setSearchable

        public void setSearchable​(java.lang.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
      • isUseForSpellchecking

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

        public java.lang.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,
                                           java.lang.Boolean value)
        Generated method - Setter of the SnField.useForSpellchecking attribute.
        Parameters:
        value - the useForSpellchecking
      • setUseForSpellchecking

        public void setUseForSpellchecking​(java.lang.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 java.lang.Boolean isUseForSuggesting​(SessionContext ctx)
        Generated method - Getter of the SnField.useForSuggesting attribute.
        Returns:
        the useForSuggesting
      • isUseForSuggesting

        public java.lang.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,
                                        java.lang.Boolean value)
        Generated method - Setter of the SnField.useForSuggesting attribute.
        Parameters:
        value - the useForSuggesting
      • setUseForSuggesting

        public void setUseForSuggesting​(java.lang.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 java.lang.String getValueProvider​(SessionContext ctx)
        Generated method - Getter of the SnField.valueProvider attribute.
        Returns:
        the valueProvider
      • getValueProvider

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

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

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

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

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

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

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

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

        public java.lang.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,
                              java.lang.Float value)
        Generated method - Setter of the SnField.weight attribute.
        Parameters:
        value - the weight
      • setWeight

        public void setWeight​(java.lang.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