Package de.hybris.platform.cms2lib.components

Class GeneratedProductListComponent

    • Field Detail

      • HEADLINE

        public static final java.lang.String HEADLINE
        Qualifier of the ProductListComponent.headline attribute
        See Also:
        Constant Field Values

      • CATEGORYCODE

        public static final java.lang.String CATEGORYCODE
        Qualifier of the ProductListComponent.categoryCode attribute
        See Also:
        Constant Field Values

      • PRODUCTSFROMCONTEXT

        public static final java.lang.String PRODUCTSFROMCONTEXT
        Qualifier of the ProductListComponent.productsFromContext attribute
        See Also:
        Constant Field Values

      • SEARCHQUERY

        public static final java.lang.String SEARCHQUERY
        Qualifier of the ProductListComponent.searchQuery attribute
        See Also:
        Constant Field Values

      • PAGINATION

        public static final java.lang.String PAGINATION
        Qualifier of the ProductListComponent.pagination attribute
        See Also:
        Constant Field Values

      • LAYOUT

        public static final java.lang.String LAYOUT
        Qualifier of the ProductListComponent.layout attribute
        See Also:
        Constant Field Values

      • PRODUCTCODES

        public static final java.lang.String PRODUCTCODES
        Qualifier of the ProductListComponent.productCodes attribute
        See Also:
        Constant Field Values

      • PRODUCTS

        public static final java.lang.String PRODUCTS
        Qualifier of the ProductListComponent.products attribute
        See Also:
        Constant Field Values

      • PRODUCTSFORPRODUCTLISTCOMPONENT_SRC_ORDERED

        protected static java.lang.String PRODUCTSFORPRODUCTLISTCOMPONENT_SRC_ORDERED
        Relation ordering override parameter constants for ProductsForProductListComponent from ((cms2lib))

      • PRODUCTSFORPRODUCTLISTCOMPONENT_TGT_ORDERED

        protected static java.lang.String PRODUCTSFORPRODUCTLISTCOMPONENT_TGT_ORDERED

      • PRODUCTSFORPRODUCTLISTCOMPONENT_MARKMODIFIED

        protected static java.lang.String PRODUCTSFORPRODUCTLISTCOMPONENT_MARKMODIFIED
        Relation disable markmodifed parameter constants for ProductsForProductListComponent from ((cms2lib))

      • CATEGORY

        public static final java.lang.String CATEGORY
        Qualifier of the ProductListComponent.category 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

      • GeneratedProductListComponent

        public GeneratedProductListComponent()

    • Method Detail

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

      • getCategoryCode

        public java.lang.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 java.lang.String getHeadline​(SessionContext ctx)
        Generated method - Getter of the ProductListComponent.headline attribute.
        Returns:
        the headline

      • getHeadline

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

      • getAllHeadline

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

      • getAllHeadline

        public java.util.Map<Language,​java.lang.String> getAllHeadline()
        Generated method - Getter of the ProductListComponent.headline attribute.
        Returns:
        the localized headline

      • setHeadline

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

      • setHeadline

        public void setHeadline​(java.lang.String value)
        Generated method - Setter of the ProductListComponent.headline attribute.
        Parameters:
        value - the headline

      • setAllHeadline

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

      • setAllHeadline

        public void setAllHeadline​(java.util.Map<Language,​java.lang.String> value)
        Generated method - Setter of the ProductListComponent.headline attribute.
        Parameters:
        value - the headline

      • 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 java.lang.Boolean isPagination​(SessionContext ctx)
        Generated method - Getter of the ProductListComponent.pagination attribute.
        Returns:
        the pagination

      • isPagination

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

      • setPagination

        public void setPagination​(java.lang.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 java.util.List<java.lang.String> getProductCodes​(SessionContext ctx)
        Generated method - Getter of the ProductListComponent.productCodes attribute.
        Returns:
        the productCodes

      • getProductCodes

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

      • getProducts

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

      • getProducts

        public java.util.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,
                        java.util.List<Product> value)
        Generated method - Setter of the ProductListComponent.products attribute.
        Parameters:
        value - the products

      • setProducts

        public void setProducts​(java.util.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 java.lang.Boolean isProductsFromContext​(SessionContext ctx)
        Generated method - Getter of the ProductListComponent.productsFromContext attribute.
        Returns:
        the productsFromContext

      • isProductsFromContext

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

      • setProductsFromContext

        public void setProductsFromContext​(java.lang.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 java.lang.String getSearchQuery​(SessionContext ctx)
        Generated method - Getter of the ProductListComponent.searchQuery attribute.
        Returns:
        the searchQuery

      • getSearchQuery

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

      • getAllSearchQuery

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

      • getAllSearchQuery

        public java.util.Map<Language,​java.lang.String> getAllSearchQuery()
        Generated method - Getter of the ProductListComponent.searchQuery attribute.
        Returns:
        the localized searchQuery

      • setSearchQuery

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

      • setSearchQuery

        public void setSearchQuery​(java.lang.String value)
        Generated method - Setter of the ProductListComponent.searchQuery attribute.
        Parameters:
        value - the searchQuery

      • setAllSearchQuery

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

      • setAllSearchQuery

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