Class GeneratedProductListComponent

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

public abstract class GeneratedProductListComponent extends SimpleCMSComponent
Generated class for type ProductListComponent.
See Also:
  • Field Details

    • HEADLINE

      public static final String HEADLINE
      Qualifier of the ProductListComponent.headline attribute
      See Also:
    • CATEGORYCODE

      public static final String CATEGORYCODE
      Qualifier of the ProductListComponent.categoryCode attribute
      See Also:
    • PRODUCTSFROMCONTEXT

      public static final String PRODUCTSFROMCONTEXT
      Qualifier of the ProductListComponent.productsFromContext attribute
      See Also:
    • SEARCHQUERY

      public static final String SEARCHQUERY
      Qualifier of the ProductListComponent.searchQuery attribute
      See Also:
    • PAGINATION

      public static final String PAGINATION
      Qualifier of the ProductListComponent.pagination attribute
      See Also:
    • LAYOUT

      public static final String LAYOUT
      Qualifier of the ProductListComponent.layout attribute
      See Also:
    • PRODUCTCODES

      public static final String PRODUCTCODES
      Qualifier of the ProductListComponent.productCodes attribute
      See Also:
    • PRODUCTS

      public static final String PRODUCTS
      Qualifier of the ProductListComponent.products attribute
      See Also:
    • PRODUCTSFORPRODUCTLISTCOMPONENT_SRC_ORDERED

      protected static String PRODUCTSFORPRODUCTLISTCOMPONENT_SRC_ORDERED
      Relation ordering override parameter constants for ProductsForProductListComponent from ((cms2lib))
    • PRODUCTSFORPRODUCTLISTCOMPONENT_TGT_ORDERED

      protected static String PRODUCTSFORPRODUCTLISTCOMPONENT_TGT_ORDERED
    • PRODUCTSFORPRODUCTLISTCOMPONENT_MARKMODIFIED

      protected static String PRODUCTSFORPRODUCTLISTCOMPONENT_MARKMODIFIED
      Relation disable markmodifed parameter constants for ProductsForProductListComponent from ((cms2lib))
    • CATEGORY

      public static final String CATEGORY
      Qualifier of the ProductListComponent.category attribute
      See Also:
    • CATEGORYHANDLER

      protected static final BidirectionalOneToManyHandler<GeneratedProductListComponent> CATEGORYHANDLER
      BidirectionalOneToManyHandler for handling 1:n CATEGORY's relation attributes from 'one' side.
    • DEFAULT_INITIAL_ATTRIBUTES

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

    • GeneratedProductListComponent

      public GeneratedProductListComponent()
  • Method Details

    • getDefaultAttributeModes

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

      public Category getCategory(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.category attribute.
      Returns:
      the category
    • getCategory

      public Category getCategory()
      Generated method - Getter of the ProductListComponent.category attribute.
      Returns:
      the category
    • setCategory

      public void setCategory(SessionContext ctx, Category value)
      Generated method - Setter of the ProductListComponent.category attribute.
      Parameters:
      value - the category
    • setCategory

      public void setCategory(Category value)
      Generated method - Setter of the ProductListComponent.category attribute.
      Parameters:
      value - the category
    • getCategoryCode

      public abstract String getCategoryCode(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.categoryCode attribute.
      Returns:
      the categoryCode
    • getCategoryCode

      public String getCategoryCode()
      Generated method - Getter of the ProductListComponent.categoryCode attribute.
      Returns:
      the categoryCode
    • 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 AbstractCMSComponent
      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
    • getHeadline

      public String getHeadline(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.headline attribute.
      Returns:
      the headline
    • getHeadline

      public String getHeadline()
      Generated method - Getter of the ProductListComponent.headline attribute.
      Returns:
      the headline
    • getAllHeadline

      public Map<Language,String> getAllHeadline(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.headline attribute.
      Returns:
      the localized headline
    • getAllHeadline

      public Map<Language,String> getAllHeadline()
      Generated method - Getter of the ProductListComponent.headline attribute.
      Returns:
      the localized headline
    • setHeadline

      public void setHeadline(SessionContext ctx, String value)
      Generated method - Setter of the ProductListComponent.headline attribute.
      Parameters:
      value - the headline
    • setHeadline

      public void setHeadline(String value)
      Generated method - Setter of the ProductListComponent.headline attribute.
      Parameters:
      value - the headline
    • setAllHeadline

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

      public void setAllHeadline(Map<Language,String> value)
      Generated method - Setter of the ProductListComponent.headline attribute.
      Parameters:
      value - the headline
    • 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 GeneratedSimpleCMSComponent
    • getLayout

      public EnumerationValue getLayout(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.layout attribute.
      Returns:
      the layout
    • getLayout

      public EnumerationValue getLayout()
      Generated method - Getter of the ProductListComponent.layout attribute.
      Returns:
      the layout
    • setLayout

      public void setLayout(SessionContext ctx, EnumerationValue value)
      Generated method - Setter of the ProductListComponent.layout attribute.
      Parameters:
      value - the layout
    • setLayout

      public void setLayout(EnumerationValue value)
      Generated method - Setter of the ProductListComponent.layout attribute.
      Parameters:
      value - the layout
    • isPagination

      public Boolean isPagination(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.pagination attribute.
      Returns:
      the pagination
    • isPagination

      public Boolean isPagination()
      Generated method - Getter of the ProductListComponent.pagination attribute.
      Returns:
      the pagination
    • isPaginationAsPrimitive

      public boolean isPaginationAsPrimitive(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.pagination attribute.
      Returns:
      the pagination
    • isPaginationAsPrimitive

      public boolean isPaginationAsPrimitive()
      Generated method - Getter of the ProductListComponent.pagination attribute.
      Returns:
      the pagination
    • setPagination

      public void setPagination(SessionContext ctx, Boolean value)
      Generated method - Setter of the ProductListComponent.pagination attribute.
      Parameters:
      value - the pagination
    • setPagination

      public void setPagination(Boolean value)
      Generated method - Setter of the ProductListComponent.pagination attribute.
      Parameters:
      value - the pagination
    • setPagination

      public void setPagination(SessionContext ctx, boolean value)
      Generated method - Setter of the ProductListComponent.pagination attribute.
      Parameters:
      value - the pagination
    • setPagination

      public void setPagination(boolean value)
      Generated method - Setter of the ProductListComponent.pagination attribute.
      Parameters:
      value - the pagination
    • getProductCodes

      public abstract List<String> getProductCodes(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.productCodes attribute.
      Returns:
      the productCodes
    • getProductCodes

      public List<String> getProductCodes()
      Generated method - Getter of the ProductListComponent.productCodes attribute.
      Returns:
      the productCodes
    • getProducts

      public List<Product> getProducts(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.products attribute.
      Returns:
      the products
    • getProducts

      public List<Product> getProducts()
      Generated method - Getter of the ProductListComponent.products attribute.
      Returns:
      the products
    • getProductsCount

      public long getProductsCount(SessionContext ctx)
    • getProductsCount

      public long getProductsCount()
    • setProducts

      public void setProducts(SessionContext ctx, List<Product> value)
      Generated method - Setter of the ProductListComponent.products attribute.
      Parameters:
      value - the products
    • setProducts

      public void setProducts(List<Product> value)
      Generated method - Setter of the ProductListComponent.products attribute.
      Parameters:
      value - the products
    • addToProducts

      public void addToProducts(SessionContext ctx, Product value)
      Generated method - Adds value to products.
      Parameters:
      value - the item to add to products
    • addToProducts

      public void addToProducts(Product value)
      Generated method - Adds value to products.
      Parameters:
      value - the item to add to products
    • removeFromProducts

      public void removeFromProducts(SessionContext ctx, Product value)
      Generated method - Removes value from products.
      Parameters:
      value - the item to remove from products
    • removeFromProducts

      public void removeFromProducts(Product value)
      Generated method - Removes value from products.
      Parameters:
      value - the item to remove from products
    • isProductsFromContext

      public Boolean isProductsFromContext(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.productsFromContext attribute.
      Returns:
      the productsFromContext
    • isProductsFromContext

      public Boolean isProductsFromContext()
      Generated method - Getter of the ProductListComponent.productsFromContext attribute.
      Returns:
      the productsFromContext
    • isProductsFromContextAsPrimitive

      public boolean isProductsFromContextAsPrimitive(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.productsFromContext attribute.
      Returns:
      the productsFromContext
    • isProductsFromContextAsPrimitive

      public boolean isProductsFromContextAsPrimitive()
      Generated method - Getter of the ProductListComponent.productsFromContext attribute.
      Returns:
      the productsFromContext
    • setProductsFromContext

      public void setProductsFromContext(SessionContext ctx, Boolean value)
      Generated method - Setter of the ProductListComponent.productsFromContext attribute.
      Parameters:
      value - the productsFromContext
    • setProductsFromContext

      public void setProductsFromContext(Boolean value)
      Generated method - Setter of the ProductListComponent.productsFromContext attribute.
      Parameters:
      value - the productsFromContext
    • setProductsFromContext

      public void setProductsFromContext(SessionContext ctx, boolean value)
      Generated method - Setter of the ProductListComponent.productsFromContext attribute.
      Parameters:
      value - the productsFromContext
    • setProductsFromContext

      public void setProductsFromContext(boolean value)
      Generated method - Setter of the ProductListComponent.productsFromContext attribute.
      Parameters:
      value - the productsFromContext
    • getSearchQuery

      public String getSearchQuery(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.searchQuery attribute.
      Returns:
      the searchQuery
    • getSearchQuery

      public String getSearchQuery()
      Generated method - Getter of the ProductListComponent.searchQuery attribute.
      Returns:
      the searchQuery
    • getAllSearchQuery

      public Map<Language,String> getAllSearchQuery(SessionContext ctx)
      Generated method - Getter of the ProductListComponent.searchQuery attribute.
      Returns:
      the localized searchQuery
    • getAllSearchQuery

      public Map<Language,String> getAllSearchQuery()
      Generated method - Getter of the ProductListComponent.searchQuery attribute.
      Returns:
      the localized searchQuery
    • setSearchQuery

      public void setSearchQuery(SessionContext ctx, String value)
      Generated method - Setter of the ProductListComponent.searchQuery attribute.
      Parameters:
      value - the searchQuery
    • setSearchQuery

      public void setSearchQuery(String value)
      Generated method - Setter of the ProductListComponent.searchQuery attribute.
      Parameters:
      value - the searchQuery
    • setAllSearchQuery

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

      public void setAllSearchQuery(Map<Language,String> value)
      Generated method - Setter of the ProductListComponent.searchQuery attribute.
      Parameters:
      value - the searchQuery