Package de.hybris.platform.catalog.model

Class CatalogModel

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _CATALOGSFORBASESTORES
      Generated relation code constant for relation CatalogsForBaseStores defining source attribute baseStores in extension basecommerce.
      static java.lang.String _CATALOGSFORRESTRICTION
      Generated relation code constant for relation CatalogsForRestriction defining source attribute restrictions in extension cms2.
      static java.lang.String _COMPANY2PROVIDEDCATALOGS
      Generated relation code constant for relation Company2ProvidedCatalogs defining source attribute supplier in extension catalog.
      static java.lang.String _COMPANY2PURCHASEDCATALOGS
      Generated relation code constant for relation Company2PurchasedCatalogs defining source attribute buyer in extension catalog.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ACTIVECATALOGVERSION
      Generated constant - Attribute key of Catalog.activeCatalogVersion attribute defined at extension catalog.
      static java.lang.String AGREEMENTS
      Generated constant - Attribute key of Catalog.agreements attribute defined at extension catalog.
      static java.lang.String BASESTORES
      Generated constant - Attribute key of Catalog.baseStores attribute defined at extension basecommerce.
      static java.lang.String BUYER
      Generated constant - Attribute key of Catalog.buyer attribute defined at extension catalog.
      static java.lang.String CATALOGVERSIONS
      Generated constant - Attribute key of Catalog.catalogVersions attribute defined at extension catalog.
      static java.lang.String DEFAULTCATALOG
      Generated constant - Attribute key of Catalog.defaultCatalog attribute defined at extension catalog.
      static java.lang.String DEFAULTCURRENCY
      Generated constant - Attribute key of Catalog.defaultCurrency attribute defined at extension catalog.
      static java.lang.String GENERATIONDATE
      Generated constant - Attribute key of Catalog.generationDate attribute defined at extension catalog.
      static java.lang.String GENERATORINFO
      Generated constant - Attribute key of Catalog.generatorInfo attribute defined at extension catalog.
      static java.lang.String ID
      Generated constant - Attribute key of Catalog.id attribute defined at extension catalog.
      static java.lang.String INCLASSURANCE
      Generated constant - Attribute key of Catalog.inclAssurance attribute defined at extension catalog.
      static java.lang.String INCLDUTY
      Generated constant - Attribute key of Catalog.inclDuty attribute defined at extension catalog.
      static java.lang.String INCLFREIGHT
      Generated constant - Attribute key of Catalog.inclFreight attribute defined at extension catalog.
      static java.lang.String INCLPACKING
      Generated constant - Attribute key of Catalog.inclPacking attribute defined at extension catalog.
      static java.lang.String LANGUAGES
      Generated constant - Attribute key of Catalog.languages attribute defined at extension catalog.
      static java.lang.String MIMEROOTDIRECTORY
      Generated constant - Attribute key of Catalog.mimeRootDirectory attribute defined at extension catalog.
      static java.lang.String NAME
      Generated constant - Attribute key of Catalog.name attribute defined at extension catalog.
      static java.lang.String PREVIEWURLTEMPLATE
      Generated constant - Attribute key of Catalog.previewURLTemplate attribute defined at extension catalog.
      static java.lang.String RESTRICTIONS
      Generated constant - Attribute key of Catalog.restrictions attribute defined at extension cms2.
      static java.lang.String ROOTCATEGORIES
      Generated constant - Attribute key of Catalog.rootCategories attribute defined at extension catalog.
      static java.lang.String SUPPLIER
      Generated constant - Attribute key of Catalog.supplier attribute defined at extension catalog.
      static java.lang.String TERRITORIES
      Generated constant - Attribute key of Catalog.territories attribute defined at extension catalog.
      static java.lang.String URLPATTERNS
      Generated constant - Attribute key of Catalog.urlPatterns attribute defined at extension catalog.
      static java.lang.String VERSION
      Generated constant - Attribute key of Catalog.version attribute defined at extension catalog.

    • Constructor Summary

      Constructors 
      Constructor Description
      CatalogModel()
      Generated constructor - Default constructor for generic creation.
      CatalogModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      CatalogModel​(java.lang.String _id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      CatalogModel​(java.lang.String _id, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • _COMPANY2PROVIDEDCATALOGS

        public static final java.lang.String _COMPANY2PROVIDEDCATALOGS
        Generated relation code constant for relation Company2ProvidedCatalogs defining source attribute supplier in extension catalog.
        See Also:
        Constant Field Values

      • _COMPANY2PURCHASEDCATALOGS

        public static final java.lang.String _COMPANY2PURCHASEDCATALOGS
        Generated relation code constant for relation Company2PurchasedCatalogs defining source attribute buyer in extension catalog.
        See Also:
        Constant Field Values

      • _CATALOGSFORBASESTORES

        public static final java.lang.String _CATALOGSFORBASESTORES
        Generated relation code constant for relation CatalogsForBaseStores defining source attribute baseStores in extension basecommerce.
        See Also:
        Constant Field Values

      • _CATALOGSFORRESTRICTION

        public static final java.lang.String _CATALOGSFORRESTRICTION
        Generated relation code constant for relation CatalogsForRestriction defining source attribute restrictions in extension cms2.
        See Also:
        Constant Field Values

      • ID

        public static final java.lang.String ID
        Generated constant - Attribute key of Catalog.id attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of Catalog.name attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • ACTIVECATALOGVERSION

        public static final java.lang.String ACTIVECATALOGVERSION
        Generated constant - Attribute key of Catalog.activeCatalogVersion attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • ROOTCATEGORIES

        public static final java.lang.String ROOTCATEGORIES
        Generated constant - Attribute key of Catalog.rootCategories attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • DEFAULTCATALOG

        public static final java.lang.String DEFAULTCATALOG
        Generated constant - Attribute key of Catalog.defaultCatalog attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • VERSION

        public static final java.lang.String VERSION
        Generated constant - Attribute key of Catalog.version attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • MIMEROOTDIRECTORY

        public static final java.lang.String MIMEROOTDIRECTORY
        Generated constant - Attribute key of Catalog.mimeRootDirectory attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • GENERATIONDATE

        public static final java.lang.String GENERATIONDATE
        Generated constant - Attribute key of Catalog.generationDate attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • DEFAULTCURRENCY

        public static final java.lang.String DEFAULTCURRENCY
        Generated constant - Attribute key of Catalog.defaultCurrency attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • INCLFREIGHT

        public static final java.lang.String INCLFREIGHT
        Generated constant - Attribute key of Catalog.inclFreight attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • INCLPACKING

        public static final java.lang.String INCLPACKING
        Generated constant - Attribute key of Catalog.inclPacking attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • INCLASSURANCE

        public static final java.lang.String INCLASSURANCE
        Generated constant - Attribute key of Catalog.inclAssurance attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • INCLDUTY

        public static final java.lang.String INCLDUTY
        Generated constant - Attribute key of Catalog.inclDuty attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • TERRITORIES

        public static final java.lang.String TERRITORIES
        Generated constant - Attribute key of Catalog.territories attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • LANGUAGES

        public static final java.lang.String LANGUAGES
        Generated constant - Attribute key of Catalog.languages attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • GENERATORINFO

        public static final java.lang.String GENERATORINFO
        Generated constant - Attribute key of Catalog.generatorInfo attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • AGREEMENTS

        public static final java.lang.String AGREEMENTS
        Generated constant - Attribute key of Catalog.agreements attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • PREVIEWURLTEMPLATE

        public static final java.lang.String PREVIEWURLTEMPLATE
        Generated constant - Attribute key of Catalog.previewURLTemplate attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • URLPATTERNS

        public static final java.lang.String URLPATTERNS
        Generated constant - Attribute key of Catalog.urlPatterns attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • CATALOGVERSIONS

        public static final java.lang.String CATALOGVERSIONS
        Generated constant - Attribute key of Catalog.catalogVersions attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • SUPPLIER

        public static final java.lang.String SUPPLIER
        Generated constant - Attribute key of Catalog.supplier attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • BUYER

        public static final java.lang.String BUYER
        Generated constant - Attribute key of Catalog.buyer attribute defined at extension catalog.
        See Also:
        Constant Field Values

      • BASESTORES

        public static final java.lang.String BASESTORES
        Generated constant - Attribute key of Catalog.baseStores attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • RESTRICTIONS

        public static final java.lang.String RESTRICTIONS
        Generated constant - Attribute key of Catalog.restrictions attribute defined at extension cms2.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CatalogModel

        public CatalogModel()
        Generated constructor - Default constructor for generic creation.

      • CatalogModel

        public CatalogModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null

      • CatalogModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CatalogModel​(java.lang.String _id)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _id - initial attribute declared by type Catalog at extension catalog

      • CatalogModel

        @Deprecated(since="4.1.1",
            forRemoval=true)
public CatalogModel​(java.lang.String _id,
                    ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _id - initial attribute declared by type Catalog at extension catalog
        _owner - initial attribute declared by type Item at extension core

    • Method Detail

      • getActiveCatalogVersion

        @Accessor(qualifier="activeCatalogVersion",
          type=GETTER)
public CatalogVersionModel getActiveCatalogVersion()
        Generated method - Getter of the Catalog.activeCatalogVersion attribute defined at extension catalog.
        Returns:
        the activeCatalogVersion - active CatalogVersion

      • getAgreements

        @Accessor(qualifier="agreements",
          type=GETTER)
public java.util.Collection<AgreementModel> getAgreements()
        Generated method - Getter of the Catalog.agreements dynamic attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the agreements - Agreement Collection

      • getBaseStores

        @Accessor(qualifier="baseStores",
          type=GETTER)
public java.util.Collection<BaseStoreModel> getBaseStores()
        Generated method - Getter of the Catalog.baseStores attribute defined at extension basecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the baseStores

      • getCatalogVersions

        @Accessor(qualifier="catalogVersions",
          type=GETTER)
public java.util.Set<CatalogVersionModel> getCatalogVersions()
        Generated method - Getter of the Catalog.catalogVersions attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the catalogVersions

      • getDefaultCatalog

        @Accessor(qualifier="defaultCatalog",
          type=GETTER)
public java.lang.Boolean getDefaultCatalog()
        Generated method - Getter of the Catalog.defaultCatalog attribute defined at extension catalog.
        Returns:
        the defaultCatalog - Default catalog

      • getDefaultCurrency

        @Accessor(qualifier="defaultCurrency",
          type=GETTER)
public CurrencyModel getDefaultCurrency()
        Generated method - Getter of the Catalog.defaultCurrency dynamic attribute defined at extension catalog.
        Returns:
        the defaultCurrency - Default Currency

      • getGenerationDate

        @Accessor(qualifier="generationDate",
          type=GETTER)
public java.util.Date getGenerationDate()
        Generated method - Getter of the Catalog.generationDate dynamic attribute defined at extension catalog.
        Returns:
        the generationDate - Generation Date

      • getGeneratorInfo

        @Accessor(qualifier="generatorInfo",
          type=GETTER)
public java.lang.String getGeneratorInfo()
        Generated method - Getter of the Catalog.generatorInfo dynamic attribute defined at extension catalog.
        Returns:
        the generatorInfo - Generator Info

      • getId

        @Accessor(qualifier="id",
          type=GETTER)
public java.lang.String getId()
        Generated method - Getter of the Catalog.id attribute defined at extension catalog.
        Returns:
        the id - ID

      • getInclAssurance

        @Accessor(qualifier="inclAssurance",
          type=GETTER)
public java.lang.Boolean getInclAssurance()
        Generated method - Getter of the Catalog.inclAssurance dynamic attribute defined at extension catalog.
        Returns:
        the inclAssurance - incl.Assurance

      • getInclDuty

        @Accessor(qualifier="inclDuty",
          type=GETTER)
public java.lang.Boolean getInclDuty()
        Generated method - Getter of the Catalog.inclDuty dynamic attribute defined at extension catalog.
        Returns:
        the inclDuty - incl.Duty

      • getInclFreight

        @Accessor(qualifier="inclFreight",
          type=GETTER)
public java.lang.Boolean getInclFreight()
        Generated method - Getter of the Catalog.inclFreight dynamic attribute defined at extension catalog.
        Returns:
        the inclFreight - incl.Freight

      • getInclPacking

        @Accessor(qualifier="inclPacking",
          type=GETTER)
public java.lang.Boolean getInclPacking()
        Generated method - Getter of the Catalog.inclPacking dynamic attribute defined at extension catalog.
        Returns:
        the inclPacking - incl.Packing

      • getLanguages

        @Accessor(qualifier="languages",
          type=GETTER)
public java.util.Collection<LanguageModel> getLanguages()
        Generated method - Getter of the Catalog.languages dynamic attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the languages - Language

      • getMimeRootDirectory

        @Accessor(qualifier="mimeRootDirectory",
          type=GETTER)
public java.lang.String getMimeRootDirectory()
        Generated method - Getter of the Catalog.mimeRootDirectory dynamic attribute defined at extension catalog.
        Returns:
        the mimeRootDirectory - Mime Root Directory

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName()
        Generated method - Getter of the Catalog.name attribute defined at extension catalog.
        Returns:
        the name - Name

      • getName

        @Accessor(qualifier="name",
          type=GETTER)
public java.lang.String getName​(java.util.Locale loc)
        Generated method - Getter of the Catalog.name attribute defined at extension catalog.
        Parameters:
        loc - the value localization key
        Returns:
        the name - Name
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • getPreviewURLTemplate

        @Accessor(qualifier="previewURLTemplate",
          type=GETTER)
public java.lang.String getPreviewURLTemplate()
        Generated method - Getter of the Catalog.previewURLTemplate attribute defined at extension catalog.
        Returns:
        the previewURLTemplate

      • getRestrictions

        @Accessor(qualifier="restrictions",
          type=GETTER)
public java.util.Collection<CMSCatalogRestrictionModel> getRestrictions()
        Generated method - Getter of the Catalog.restrictions attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the restrictions

      • getRootCategories

        @Accessor(qualifier="rootCategories",
          type=GETTER)
public java.util.List<CategoryModel> getRootCategories()
        Generated method - Getter of the Catalog.rootCategories dynamic attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the rootCategories - The categories of the active CatalogVersion

      • getSupplier

        @Accessor(qualifier="supplier",
          type=GETTER)
public CompanyModel getSupplier()
        Generated method - Getter of the Catalog.supplier attribute defined at extension catalog.
        Returns:
        the supplier

      • getTerritories

        @Accessor(qualifier="territories",
          type=GETTER)
public java.util.Collection<CountryModel> getTerritories()
        Generated method - Getter of the Catalog.territories dynamic attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the territories - Territory

      • getUrlPatterns

        @Accessor(qualifier="urlPatterns",
          type=GETTER)
public java.util.Collection<java.lang.String> getUrlPatterns()
        Generated method - Getter of the Catalog.urlPatterns attribute defined at extension catalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the urlPatterns - Collection of URL patterns

      • getVersion

        @Accessor(qualifier="version",
          type=GETTER)
public java.lang.String getVersion()
        Generated method - Getter of the Catalog.version dynamic attribute defined at extension catalog.
        Returns:
        the version - version

      • setActiveCatalogVersion

        @Accessor(qualifier="activeCatalogVersion",
          type=SETTER)
public void setActiveCatalogVersion​(CatalogVersionModel value)
        Generated method - Setter of Catalog.activeCatalogVersion attribute defined at extension catalog.
        Parameters:
        value - the activeCatalogVersion - active CatalogVersion

      • setBaseStores

        @Accessor(qualifier="baseStores",
          type=SETTER)
public void setBaseStores​(java.util.Collection<BaseStoreModel> value)
        Generated method - Setter of Catalog.baseStores attribute defined at extension basecommerce.
        Parameters:
        value - the baseStores

      • setBuyer

        @Accessor(qualifier="buyer",
          type=SETTER)
public void setBuyer​(CompanyModel value)
        Generated method - Setter of Catalog.buyer attribute defined at extension catalog.
        Parameters:
        value - the buyer

      • setCatalogVersions

        @Accessor(qualifier="catalogVersions",
          type=SETTER)
public void setCatalogVersions​(java.util.Set<CatalogVersionModel> value)
        Generated method - Setter of Catalog.catalogVersions attribute defined at extension catalog.
        Parameters:
        value - the catalogVersions

      • setDefaultCatalog

        @Accessor(qualifier="defaultCatalog",
          type=SETTER)
public void setDefaultCatalog​(java.lang.Boolean value)
        Generated method - Setter of Catalog.defaultCatalog attribute defined at extension catalog.
        Parameters:
        value - the defaultCatalog - Default catalog

      • setId

        @Accessor(qualifier="id",
          type=SETTER)
public void setId​(java.lang.String value)
        Generated method - Setter of Catalog.id attribute defined at extension catalog.
        Parameters:
        value - the id - ID

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value)
        Generated method - Setter of Catalog.name attribute defined at extension catalog.
        Parameters:
        value - the name - Name

      • setName

        @Accessor(qualifier="name",
          type=SETTER)
public void setName​(java.lang.String value,
                    java.util.Locale loc)
        Generated method - Setter of Catalog.name attribute defined at extension catalog.
        Parameters:
        value - the name - Name
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language

      • setPreviewURLTemplate

        @Accessor(qualifier="previewURLTemplate",
          type=SETTER)
public void setPreviewURLTemplate​(java.lang.String value)
        Generated method - Setter of Catalog.previewURLTemplate attribute defined at extension catalog.
        Parameters:
        value - the previewURLTemplate

      • setRestrictions

        @Accessor(qualifier="restrictions",
          type=SETTER)
public void setRestrictions​(java.util.Collection<CMSCatalogRestrictionModel> value)
        Generated method - Setter of Catalog.restrictions attribute defined at extension cms2.
        Parameters:
        value - the restrictions

      • setSupplier

        @Accessor(qualifier="supplier",
          type=SETTER)
public void setSupplier​(CompanyModel value)
        Generated method - Setter of Catalog.supplier attribute defined at extension catalog.
        Parameters:
        value - the supplier

      • setUrlPatterns

        @Accessor(qualifier="urlPatterns",
          type=SETTER)
public void setUrlPatterns​(java.util.Collection<java.lang.String> value)
        Generated method - Setter of Catalog.urlPatterns attribute defined at extension catalog.
        Parameters:
        value - the urlPatterns - Collection of URL patterns