Class GeneratedSnIndexType

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

public abstract class GeneratedSnIndexType extends GenericItem
Generated class for type SnIndexType.
See Also:
  • Field Details

    • ID

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

      public static final String NAME
      Qualifier of the SnIndexType.name attribute
      See Also:
    • ITEMCOMPOSEDTYPE

      public static final String ITEMCOMPOSEDTYPE
      Qualifier of the SnIndexType.itemComposedType attribute
      See Also:
    • IDENTITYPROVIDER

      public static final String IDENTITYPROVIDER
      Qualifier of the SnIndexType.identityProvider attribute
      See Also:
    • IDENTITYPROVIDERPARAMETERS

      public static final String IDENTITYPROVIDERPARAMETERS
      Qualifier of the SnIndexType.identityProviderParameters attribute
      See Also:
    • DEFAULTVALUEPROVIDER

      public static final String DEFAULTVALUEPROVIDER
      Qualifier of the SnIndexType.defaultValueProvider attribute
      See Also:
    • DEFAULTVALUEPROVIDERPARAMETERS

      public static final String DEFAULTVALUEPROVIDERPARAMETERS
      Qualifier of the SnIndexType.defaultValueProviderParameters attribute
      See Also:
    • LISTENERS

      public static final String LISTENERS
      Qualifier of the SnIndexType.listeners attribute
      See Also:
    • INDEXCONFIGURATIONPOS

      public static final String INDEXCONFIGURATIONPOS
      Qualifier of the SnIndexType.indexConfigurationPOS attribute
      See Also:
    • INDEXCONFIGURATION

      public static final String INDEXCONFIGURATION
      Qualifier of the SnIndexType.indexConfiguration attribute
      See Also:
    • FIELDS

      public static final String FIELDS
      Qualifier of the SnIndexType.fields attribute
      See Also:
    • CATALOGS

      public static final String CATALOGS
      Qualifier of the SnIndexType.catalogs attribute
      See Also:
    • SNINDEXTYPE2CATALOG_SRC_ORDERED

      protected static String SNINDEXTYPE2CATALOG_SRC_ORDERED
      Relation ordering override parameter constants for SnIndexType2Catalog from ((searchservices))
    • SNINDEXTYPE2CATALOG_TGT_ORDERED

      protected static String SNINDEXTYPE2CATALOG_TGT_ORDERED
    • SNINDEXTYPE2CATALOG_MARKMODIFIED

      protected static String SNINDEXTYPE2CATALOG_MARKMODIFIED
      Relation disable markmodifed parameter constants for SnIndexType2Catalog from ((searchservices))
    • CATALOGVERSIONS

      public static final String CATALOGVERSIONS
      Qualifier of the SnIndexType.catalogVersions attribute
      See Also:
    • SNINDEXTYPE2CATALOGVERSION_SRC_ORDERED

      protected static String SNINDEXTYPE2CATALOGVERSION_SRC_ORDERED
      Relation ordering override parameter constants for SnIndexType2CatalogVersion from ((searchservices))
    • SNINDEXTYPE2CATALOGVERSION_TGT_ORDERED

      protected static String SNINDEXTYPE2CATALOGVERSION_TGT_ORDERED
    • SNINDEXTYPE2CATALOGVERSION_MARKMODIFIED

      protected static String SNINDEXTYPE2CATALOGVERSION_MARKMODIFIED
      Relation disable markmodifed parameter constants for SnIndexType2CatalogVersion from ((searchservices))
    • INDEXERCRONJOBS

      public static final String INDEXERCRONJOBS
      Qualifier of the SnIndexType.indexerCronJobs attribute
      See Also:
    • INDEXCONFIGURATIONHANDLER

      protected static final BidirectionalOneToManyHandler<GeneratedSnIndexType> INDEXCONFIGURATIONHANDLER
      BidirectionalOneToManyHandler for handling 1:n INDEXCONFIGURATION's relation attributes from 'one' side.
    • FIELDSHANDLER

      protected static final OneToManyHandler<SnField> FIELDSHANDLER
      OneToManyHandler for handling 1:n FIELDS's relation attributes from 'many' side.
    • INDEXERCRONJOBSHANDLER

      protected static final OneToManyHandler<AbstractSnIndexerCronJob> INDEXERCRONJOBSHANDLER
      OneToManyHandler for handling 1:n INDEXERCRONJOBS's relation attributes from 'many' side.
    • DEFAULT_INITIAL_ATTRIBUTES

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

    • GeneratedSnIndexType

      public GeneratedSnIndexType()
  • Method Details

    • getDefaultAttributeModes

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

      public List<Catalog> getCatalogs(SessionContext ctx)
      Generated method - Getter of the SnIndexType.catalogs attribute.
      Returns:
      the catalogs
    • getCatalogs

      public List<Catalog> getCatalogs()
      Generated method - Getter of the SnIndexType.catalogs attribute.
      Returns:
      the catalogs
    • getCatalogsCount

      public long getCatalogsCount(SessionContext ctx)
    • getCatalogsCount

      public long getCatalogsCount()
    • setCatalogs

      public void setCatalogs(SessionContext ctx, List<Catalog> value)
      Generated method - Setter of the SnIndexType.catalogs attribute.
      Parameters:
      value - the catalogs
    • setCatalogs

      public void setCatalogs(List<Catalog> value)
      Generated method - Setter of the SnIndexType.catalogs attribute.
      Parameters:
      value - the catalogs
    • addToCatalogs

      public void addToCatalogs(SessionContext ctx, Catalog value)
      Generated method - Adds value to catalogs.
      Parameters:
      value - the item to add to catalogs
    • addToCatalogs

      public void addToCatalogs(Catalog value)
      Generated method - Adds value to catalogs.
      Parameters:
      value - the item to add to catalogs
    • removeFromCatalogs

      public void removeFromCatalogs(SessionContext ctx, Catalog value)
      Generated method - Removes value from catalogs.
      Parameters:
      value - the item to remove from catalogs
    • removeFromCatalogs

      public void removeFromCatalogs(Catalog value)
      Generated method - Removes value from catalogs.
      Parameters:
      value - the item to remove from catalogs
    • getCatalogVersions

      public List<CatalogVersion> getCatalogVersions(SessionContext ctx)
      Generated method - Getter of the SnIndexType.catalogVersions attribute.
      Returns:
      the catalogVersions
    • getCatalogVersions

      public List<CatalogVersion> getCatalogVersions()
      Generated method - Getter of the SnIndexType.catalogVersions attribute.
      Returns:
      the catalogVersions
    • getCatalogVersionsCount

      public long getCatalogVersionsCount(SessionContext ctx)
    • getCatalogVersionsCount

      public long getCatalogVersionsCount()
    • setCatalogVersions

      public void setCatalogVersions(SessionContext ctx, List<CatalogVersion> value)
      Generated method - Setter of the SnIndexType.catalogVersions attribute.
      Parameters:
      value - the catalogVersions
    • setCatalogVersions

      public void setCatalogVersions(List<CatalogVersion> value)
      Generated method - Setter of the SnIndexType.catalogVersions attribute.
      Parameters:
      value - the catalogVersions
    • addToCatalogVersions

      public void addToCatalogVersions(SessionContext ctx, CatalogVersion value)
      Generated method - Adds value to catalogVersions.
      Parameters:
      value - the item to add to catalogVersions
    • addToCatalogVersions

      public void addToCatalogVersions(CatalogVersion value)
      Generated method - Adds value to catalogVersions.
      Parameters:
      value - the item to add to catalogVersions
    • removeFromCatalogVersions

      public void removeFromCatalogVersions(SessionContext ctx, CatalogVersion value)
      Generated method - Removes value from catalogVersions.
      Parameters:
      value - the item to remove from catalogVersions
    • removeFromCatalogVersions

      public void removeFromCatalogVersions(CatalogVersion value)
      Generated method - Removes value from catalogVersions.
      Parameters:
      value - the item to remove from catalogVersions
    • 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
    • getDefaultValueProvider

      public String getDefaultValueProvider(SessionContext ctx)
      Generated method - Getter of the SnIndexType.defaultValueProvider attribute.
      Returns:
      the defaultValueProvider
    • getDefaultValueProvider

      public String getDefaultValueProvider()
      Generated method - Getter of the SnIndexType.defaultValueProvider attribute.
      Returns:
      the defaultValueProvider
    • setDefaultValueProvider

      public void setDefaultValueProvider(SessionContext ctx, String value)
      Generated method - Setter of the SnIndexType.defaultValueProvider attribute.
      Parameters:
      value - the defaultValueProvider
    • setDefaultValueProvider

      public void setDefaultValueProvider(String value)
      Generated method - Setter of the SnIndexType.defaultValueProvider attribute.
      Parameters:
      value - the defaultValueProvider
    • getAllDefaultValueProviderParameters

      public Map<String,String> getAllDefaultValueProviderParameters(SessionContext ctx)
      Generated method - Getter of the SnIndexType.defaultValueProviderParameters attribute.
      Returns:
      the defaultValueProviderParameters
    • getAllDefaultValueProviderParameters

      public Map<String,String> getAllDefaultValueProviderParameters()
      Generated method - Getter of the SnIndexType.defaultValueProviderParameters attribute.
      Returns:
      the defaultValueProviderParameters
    • setAllDefaultValueProviderParameters

      public void setAllDefaultValueProviderParameters(SessionContext ctx, Map<String,String> value)
      Generated method - Setter of the SnIndexType.defaultValueProviderParameters attribute.
      Parameters:
      value - the defaultValueProviderParameters
    • setAllDefaultValueProviderParameters

      public void setAllDefaultValueProviderParameters(Map<String,String> value)
      Generated method - Setter of the SnIndexType.defaultValueProviderParameters attribute.
      Parameters:
      value - the defaultValueProviderParameters
    • getFields

      public List<SnField> getFields(SessionContext ctx)
      Generated method - Getter of the SnIndexType.fields attribute.
      Returns:
      the fields
    • getFields

      public List<SnField> getFields()
      Generated method - Getter of the SnIndexType.fields attribute.
      Returns:
      the fields
    • setFields

      public void setFields(SessionContext ctx, List<SnField> value)
      Generated method - Setter of the SnIndexType.fields attribute.
      Parameters:
      value - the fields
    • setFields

      public void setFields(List<SnField> value)
      Generated method - Setter of the SnIndexType.fields attribute.
      Parameters:
      value - the fields
    • addToFields

      public void addToFields(SessionContext ctx, SnField value)
      Generated method - Adds value to fields.
      Parameters:
      value - the item to add to fields
    • addToFields

      public void addToFields(SnField value)
      Generated method - Adds value to fields.
      Parameters:
      value - the item to add to fields
    • removeFromFields

      public void removeFromFields(SessionContext ctx, SnField value)
      Generated method - Removes value from fields.
      Parameters:
      value - the item to remove from fields
    • removeFromFields

      public void removeFromFields(SnField value)
      Generated method - Removes value from fields.
      Parameters:
      value - the item to remove from fields
    • getId

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

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

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

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

      public String getIdentityProvider(SessionContext ctx)
      Generated method - Getter of the SnIndexType.identityProvider attribute.
      Returns:
      the identityProvider
    • getIdentityProvider

      public String getIdentityProvider()
      Generated method - Getter of the SnIndexType.identityProvider attribute.
      Returns:
      the identityProvider
    • setIdentityProvider

      public void setIdentityProvider(SessionContext ctx, String value)
      Generated method - Setter of the SnIndexType.identityProvider attribute.
      Parameters:
      value - the identityProvider
    • setIdentityProvider

      public void setIdentityProvider(String value)
      Generated method - Setter of the SnIndexType.identityProvider attribute.
      Parameters:
      value - the identityProvider
    • getAllIdentityProviderParameters

      public Map<String,String> getAllIdentityProviderParameters(SessionContext ctx)
      Generated method - Getter of the SnIndexType.identityProviderParameters attribute.
      Returns:
      the identityProviderParameters
    • getAllIdentityProviderParameters

      public Map<String,String> getAllIdentityProviderParameters()
      Generated method - Getter of the SnIndexType.identityProviderParameters attribute.
      Returns:
      the identityProviderParameters
    • setAllIdentityProviderParameters

      public void setAllIdentityProviderParameters(SessionContext ctx, Map<String,String> value)
      Generated method - Setter of the SnIndexType.identityProviderParameters attribute.
      Parameters:
      value - the identityProviderParameters
    • setAllIdentityProviderParameters

      public void setAllIdentityProviderParameters(Map<String,String> value)
      Generated method - Setter of the SnIndexType.identityProviderParameters attribute.
      Parameters:
      value - the identityProviderParameters
    • getIndexConfiguration

      public SnIndexConfiguration getIndexConfiguration(SessionContext ctx)
      Generated method - Getter of the SnIndexType.indexConfiguration attribute.
      Returns:
      the indexConfiguration
    • getIndexConfiguration

      public SnIndexConfiguration getIndexConfiguration()
      Generated method - Getter of the SnIndexType.indexConfiguration attribute.
      Returns:
      the indexConfiguration
    • setIndexConfiguration

      public void setIndexConfiguration(SessionContext ctx, SnIndexConfiguration value)
      Generated method - Setter of the SnIndexType.indexConfiguration attribute.
      Parameters:
      value - the indexConfiguration
    • setIndexConfiguration

      public void setIndexConfiguration(SnIndexConfiguration value)
      Generated method - Setter of the SnIndexType.indexConfiguration attribute.
      Parameters:
      value - the indexConfiguration
    • getIndexerCronJobs

      public List<AbstractSnIndexerCronJob> getIndexerCronJobs(SessionContext ctx)
      Generated method - Getter of the SnIndexType.indexerCronJobs attribute.
      Returns:
      the indexerCronJobs
    • getIndexerCronJobs

      public List<AbstractSnIndexerCronJob> getIndexerCronJobs()
      Generated method - Getter of the SnIndexType.indexerCronJobs attribute.
      Returns:
      the indexerCronJobs
    • setIndexerCronJobs

      public void setIndexerCronJobs(SessionContext ctx, List<AbstractSnIndexerCronJob> value)
      Generated method - Setter of the SnIndexType.indexerCronJobs attribute.
      Parameters:
      value - the indexerCronJobs
    • setIndexerCronJobs

      public void setIndexerCronJobs(List<AbstractSnIndexerCronJob> value)
      Generated method - Setter of the SnIndexType.indexerCronJobs attribute.
      Parameters:
      value - the indexerCronJobs
    • addToIndexerCronJobs

      public void addToIndexerCronJobs(SessionContext ctx, AbstractSnIndexerCronJob value)
      Generated method - Adds value to indexerCronJobs.
      Parameters:
      value - the item to add to indexerCronJobs
    • addToIndexerCronJobs

      public void addToIndexerCronJobs(AbstractSnIndexerCronJob value)
      Generated method - Adds value to indexerCronJobs.
      Parameters:
      value - the item to add to indexerCronJobs
    • removeFromIndexerCronJobs

      public void removeFromIndexerCronJobs(SessionContext ctx, AbstractSnIndexerCronJob value)
      Generated method - Removes value from indexerCronJobs.
      Parameters:
      value - the item to remove from indexerCronJobs
    • removeFromIndexerCronJobs

      public void removeFromIndexerCronJobs(AbstractSnIndexerCronJob value)
      Generated method - Removes value from indexerCronJobs.
      Parameters:
      value - the item to remove from indexerCronJobs
    • 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
    • getItemComposedType

      public ComposedType getItemComposedType(SessionContext ctx)
      Generated method - Getter of the SnIndexType.itemComposedType attribute.
      Returns:
      the itemComposedType
    • getItemComposedType

      public ComposedType getItemComposedType()
      Generated method - Getter of the SnIndexType.itemComposedType attribute.
      Returns:
      the itemComposedType
    • setItemComposedType

      public void setItemComposedType(SessionContext ctx, ComposedType value)
      Generated method - Setter of the SnIndexType.itemComposedType attribute.
      Parameters:
      value - the itemComposedType
    • setItemComposedType

      public void setItemComposedType(ComposedType value)
      Generated method - Setter of the SnIndexType.itemComposedType attribute.
      Parameters:
      value - the itemComposedType
    • getListeners

      public List<String> getListeners(SessionContext ctx)
      Generated method - Getter of the SnIndexType.listeners attribute.
      Returns:
      the listeners
    • getListeners

      public List<String> getListeners()
      Generated method - Getter of the SnIndexType.listeners attribute.
      Returns:
      the listeners
    • setListeners

      public void setListeners(SessionContext ctx, List<String> value)
      Generated method - Setter of the SnIndexType.listeners attribute.
      Parameters:
      value - the listeners
    • setListeners

      public void setListeners(List<String> value)
      Generated method - Setter of the SnIndexType.listeners attribute.
      Parameters:
      value - the listeners
    • getName

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

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

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

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

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

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

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

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