Package de.hybris.platform.catalog.model
Class CatalogModel
java.lang.Object
de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.core.model.ItemModel
de.hybris.platform.catalog.model.CatalogModel
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ClassificationSystemModel,ContentCatalogModel
Generated model class for type Catalog first defined at extension catalog.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringGenerated relation code constant for relationCatalogsForBaseStoresdefining source attributebaseStoresin extensionbasecommerce.static final StringGenerated relation code constant for relationCatalogsForRestrictiondefining source attributerestrictionsin extensioncms2.static final StringGenerated relation code constant for relationCompany2ProvidedCatalogsdefining source attributesupplierin extensioncatalog.static final StringGenerated relation code constant for relationCompany2PurchasedCatalogsdefining source attributebuyerin extensioncatalog.static final StringGenerated model type code constant.static final StringGenerated constant - Attribute key ofCatalog.activeCatalogVersionattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.agreementsattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.baseStoresattribute defined at extensionbasecommerce.static final StringGenerated constant - Attribute key ofCatalog.buyerattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.catalogVersionsattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.defaultCatalogattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.defaultCurrencyattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.generationDateattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.generatorInfoattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.idattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.inclAssuranceattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.inclDutyattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.inclFreightattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.inclPackingattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.languagesattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.mimeRootDirectoryattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.nameattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.previewURLTemplateattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.restrictionsattribute defined at extensioncms2.static final StringGenerated constant - Attribute key ofCatalog.rootCategoriesattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.supplierattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.territoriesattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.urlPatternsattribute defined at extensioncatalog.static final StringGenerated constant - Attribute key ofCatalog.versionattribute defined at extensioncatalog.Fields inherited from class de.hybris.platform.core.model.ItemModel
_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALEDFields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY -
Constructor Summary
ConstructorsConstructorDescriptionGenerated constructor - Default constructor for generic creation.CatalogModel(de.hybris.platform.servicelayer.model.ItemModelContext ctx) Generated constructor - Default constructor for creation with existing contextCatalogModel(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 parametersCatalogModel(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 -
Method Summary
Modifier and TypeMethodDescriptionGenerated method - Getter of theCatalog.activeCatalogVersionattribute defined at extensioncatalog.Generated method - Getter of theCatalog.agreementsdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.baseStoresattribute defined at extensionbasecommerce.getBuyer()Generated method - Getter of theCatalog.buyerattribute defined at extensioncatalog.Generated method - Getter of theCatalog.catalogVersionsattribute defined at extensioncatalog.Generated method - Getter of theCatalog.defaultCatalogattribute defined at extensioncatalog.Generated method - Getter of theCatalog.defaultCurrencydynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.generationDatedynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.generatorInfodynamic attribute defined at extensioncatalog.getId()Generated method - Getter of theCatalog.idattribute defined at extensioncatalog.Generated method - Getter of theCatalog.inclAssurancedynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.inclDutydynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.inclFreightdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.inclPackingdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.languagesdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.mimeRootDirectorydynamic attribute defined at extensioncatalog.getName()Generated method - Getter of theCatalog.nameattribute defined at extensioncatalog.Generated method - Getter of theCatalog.nameattribute defined at extensioncatalog.Generated method - Getter of theCatalog.previewURLTemplateattribute defined at extensioncatalog.Generated method - Getter of theCatalog.restrictionsattribute defined at extensioncms2.Generated method - Getter of theCatalog.rootCategoriesdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.supplierattribute defined at extensioncatalog.Generated method - Getter of theCatalog.territoriesdynamic attribute defined at extensioncatalog.Generated method - Getter of theCatalog.urlPatternsattribute defined at extensioncatalog.Generated method - Getter of theCatalog.versiondynamic attribute defined at extensioncatalog.voidGenerated method - Setter ofCatalog.activeCatalogVersionattribute defined at extensioncatalog.voidsetBaseStores(Collection<BaseStoreModel> value) Generated method - Setter ofCatalog.baseStoresattribute defined at extensionbasecommerce.voidsetBuyer(CompanyModel value) Generated method - Setter ofCatalog.buyerattribute defined at extensioncatalog.voidsetCatalogVersions(Set<CatalogVersionModel> value) Generated method - Setter ofCatalog.catalogVersionsattribute defined at extensioncatalog.voidsetDefaultCatalog(Boolean value) Generated method - Setter ofCatalog.defaultCatalogattribute defined at extensioncatalog.voidGenerated method - Setter ofCatalog.idattribute defined at extensioncatalog.voidGenerated method - Setter ofCatalog.nameattribute defined at extensioncatalog.voidGenerated method - Setter ofCatalog.nameattribute defined at extensioncatalog.voidsetPreviewURLTemplate(String value) Generated method - Setter ofCatalog.previewURLTemplateattribute defined at extensioncatalog.voidGenerated method - Setter ofCatalog.restrictionsattribute defined at extensioncms2.voidsetSupplier(CompanyModel value) Generated method - Setter ofCatalog.supplierattribute defined at extensioncatalog.voidsetUrlPatterns(Collection<String> value) Generated method - Setter ofCatalog.urlPatternsattribute defined at extensioncatalog.Methods inherited from class de.hybris.platform.core.model.ItemModel
getComments, getCreationtime, getModifiedtime, getOwner, isSealed, setComments, setCreationtime, setModifiedtime, setOwnerMethods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace
-
Field Details
-
_TYPECODE
Generated model type code constant.- See Also:
-
_COMPANY2PROVIDEDCATALOGS
Generated relation code constant for relationCompany2ProvidedCatalogsdefining source attributesupplierin extensioncatalog.- See Also:
-
_COMPANY2PURCHASEDCATALOGS
Generated relation code constant for relationCompany2PurchasedCatalogsdefining source attributebuyerin extensioncatalog.- See Also:
-
_CATALOGSFORBASESTORES
Generated relation code constant for relationCatalogsForBaseStoresdefining source attributebaseStoresin extensionbasecommerce.- See Also:
-
_CATALOGSFORRESTRICTION
Generated relation code constant for relationCatalogsForRestrictiondefining source attributerestrictionsin extensioncms2.- See Also:
-
ID
Generated constant - Attribute key ofCatalog.idattribute defined at extensioncatalog.- See Also:
-
NAME
Generated constant - Attribute key ofCatalog.nameattribute defined at extensioncatalog.- See Also:
-
ACTIVECATALOGVERSION
Generated constant - Attribute key ofCatalog.activeCatalogVersionattribute defined at extensioncatalog.- See Also:
-
ROOTCATEGORIES
Generated constant - Attribute key ofCatalog.rootCategoriesattribute defined at extensioncatalog.- See Also:
-
DEFAULTCATALOG
Generated constant - Attribute key ofCatalog.defaultCatalogattribute defined at extensioncatalog.- See Also:
-
VERSION
Generated constant - Attribute key ofCatalog.versionattribute defined at extensioncatalog.- See Also:
-
MIMEROOTDIRECTORY
Generated constant - Attribute key ofCatalog.mimeRootDirectoryattribute defined at extensioncatalog.- See Also:
-
GENERATIONDATE
Generated constant - Attribute key ofCatalog.generationDateattribute defined at extensioncatalog.- See Also:
-
DEFAULTCURRENCY
Generated constant - Attribute key ofCatalog.defaultCurrencyattribute defined at extensioncatalog.- See Also:
-
INCLFREIGHT
Generated constant - Attribute key ofCatalog.inclFreightattribute defined at extensioncatalog.- See Also:
-
INCLPACKING
Generated constant - Attribute key ofCatalog.inclPackingattribute defined at extensioncatalog.- See Also:
-
INCLASSURANCE
Generated constant - Attribute key ofCatalog.inclAssuranceattribute defined at extensioncatalog.- See Also:
-
INCLDUTY
Generated constant - Attribute key ofCatalog.inclDutyattribute defined at extensioncatalog.- See Also:
-
TERRITORIES
Generated constant - Attribute key ofCatalog.territoriesattribute defined at extensioncatalog.- See Also:
-
LANGUAGES
Generated constant - Attribute key ofCatalog.languagesattribute defined at extensioncatalog.- See Also:
-
GENERATORINFO
Generated constant - Attribute key ofCatalog.generatorInfoattribute defined at extensioncatalog.- See Also:
-
AGREEMENTS
Generated constant - Attribute key ofCatalog.agreementsattribute defined at extensioncatalog.- See Also:
-
PREVIEWURLTEMPLATE
Generated constant - Attribute key ofCatalog.previewURLTemplateattribute defined at extensioncatalog.- See Also:
-
URLPATTERNS
Generated constant - Attribute key ofCatalog.urlPatternsattribute defined at extensioncatalog.- See Also:
-
CATALOGVERSIONS
Generated constant - Attribute key ofCatalog.catalogVersionsattribute defined at extensioncatalog.- See Also:
-
SUPPLIER
Generated constant - Attribute key ofCatalog.supplierattribute defined at extensioncatalog.- See Also:
-
BUYER
Generated constant - Attribute key ofCatalog.buyerattribute defined at extensioncatalog.- See Also:
-
BASESTORES
Generated constant - Attribute key ofCatalog.baseStoresattribute defined at extensionbasecommerce.- See Also:
-
RESTRICTIONS
Generated constant - Attribute key ofCatalog.restrictionsattribute defined at extensioncms2.- See Also:
-
-
Constructor Details
-
CatalogModel
public CatalogModel()Generated constructor - Default constructor for generic creation. -
CatalogModel
public CatalogModel(de.hybris.platform.servicelayer.model.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, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - Constructor with all mandatory attributes.- Parameters:
_id- initial attribute declared by typeCatalogat extensioncatalog
-
CatalogModel
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - for all mandatory and initial attributes.- Parameters:
_id- initial attribute declared by typeCatalogat extensioncatalog_owner- initial attribute declared by typeItemat extensioncore
-
-
Method Details
-
getActiveCatalogVersion
@Accessor(qualifier="activeCatalogVersion", type=GETTER) public CatalogVersionModel getActiveCatalogVersion()Generated method - Getter of theCatalog.activeCatalogVersionattribute defined at extensioncatalog.- Returns:
- the activeCatalogVersion - active CatalogVersion
-
getAgreements
Generated method - Getter of theCatalog.agreementsdynamic attribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the agreements - Agreement Collection
-
getBaseStores
Generated method - Getter of theCatalog.baseStoresattribute defined at extensionbasecommerce. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the baseStores
-
getBuyer
Generated method - Getter of theCatalog.buyerattribute defined at extensioncatalog.- Returns:
- the buyer
-
getCatalogVersions
@Accessor(qualifier="catalogVersions", type=GETTER) public Set<CatalogVersionModel> getCatalogVersions()Generated method - Getter of theCatalog.catalogVersionsattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the catalogVersions
-
getDefaultCatalog
Generated method - Getter of theCatalog.defaultCatalogattribute defined at extensioncatalog.- Returns:
- the defaultCatalog - Default catalog
-
getDefaultCurrency
Generated method - Getter of theCatalog.defaultCurrencydynamic attribute defined at extensioncatalog.- Returns:
- the defaultCurrency - Default Currency
-
getGenerationDate
Generated method - Getter of theCatalog.generationDatedynamic attribute defined at extensioncatalog.- Returns:
- the generationDate - Generation Date
-
getGeneratorInfo
Generated method - Getter of theCatalog.generatorInfodynamic attribute defined at extensioncatalog.- Returns:
- the generatorInfo - Generator Info
-
getId
Generated method - Getter of theCatalog.idattribute defined at extensioncatalog.- Returns:
- the id - ID
-
getInclAssurance
Generated method - Getter of theCatalog.inclAssurancedynamic attribute defined at extensioncatalog.- Returns:
- the inclAssurance - incl.Assurance
-
getInclDuty
Generated method - Getter of theCatalog.inclDutydynamic attribute defined at extensioncatalog.- Returns:
- the inclDuty - incl.Duty
-
getInclFreight
Generated method - Getter of theCatalog.inclFreightdynamic attribute defined at extensioncatalog.- Returns:
- the inclFreight - incl.Freight
-
getInclPacking
Generated method - Getter of theCatalog.inclPackingdynamic attribute defined at extensioncatalog.- Returns:
- the inclPacking - incl.Packing
-
getLanguages
Generated method - Getter of theCatalog.languagesdynamic attribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the languages - Language
-
getMimeRootDirectory
Generated method - Getter of theCatalog.mimeRootDirectorydynamic attribute defined at extensioncatalog.- Returns:
- the mimeRootDirectory - Mime Root Directory
-
getName
Generated method - Getter of theCatalog.nameattribute defined at extensioncatalog.- Returns:
- the name - Name
-
getName
Generated method - Getter of theCatalog.nameattribute defined at extensioncatalog.- Parameters:
loc- the value localization key- Returns:
- the name - Name
- Throws:
IllegalArgumentException- if localization key cannot be mapped to data language
-
getPreviewURLTemplate
Generated method - Getter of theCatalog.previewURLTemplateattribute defined at extensioncatalog.- Returns:
- the previewURLTemplate
-
getRestrictions
@Accessor(qualifier="restrictions", type=GETTER) public Collection<CMSCatalogRestrictionModel> getRestrictions()Generated method - Getter of theCatalog.restrictionsattribute defined at extensioncms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the restrictions
-
getRootCategories
Generated method - Getter of theCatalog.rootCategoriesdynamic attribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the rootCategories - The categories of the active CatalogVersion
-
getSupplier
Generated method - Getter of theCatalog.supplierattribute defined at extensioncatalog.- Returns:
- the supplier
-
getTerritories
Generated method - Getter of theCatalog.territoriesdynamic attribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the territories - Territory
-
getUrlPatterns
Generated method - Getter of theCatalog.urlPatternsattribute defined at extensioncatalog. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the urlPatterns - Collection of URL patterns
-
getVersion
Generated method - Getter of theCatalog.versiondynamic attribute defined at extensioncatalog.- Returns:
- the version - version
-
setActiveCatalogVersion
@Accessor(qualifier="activeCatalogVersion", type=SETTER) public void setActiveCatalogVersion(CatalogVersionModel value) Generated method - Setter ofCatalog.activeCatalogVersionattribute defined at extensioncatalog.- Parameters:
value- the activeCatalogVersion - active CatalogVersion
-
setBaseStores
@Accessor(qualifier="baseStores", type=SETTER) public void setBaseStores(Collection<BaseStoreModel> value) Generated method - Setter ofCatalog.baseStoresattribute defined at extensionbasecommerce.- Parameters:
value- the baseStores
-
setBuyer
Generated method - Setter ofCatalog.buyerattribute defined at extensioncatalog.- Parameters:
value- the buyer
-
setCatalogVersions
@Accessor(qualifier="catalogVersions", type=SETTER) public void setCatalogVersions(Set<CatalogVersionModel> value) Generated method - Setter ofCatalog.catalogVersionsattribute defined at extensioncatalog.- Parameters:
value- the catalogVersions
-
setDefaultCatalog
Generated method - Setter ofCatalog.defaultCatalogattribute defined at extensioncatalog.- Parameters:
value- the defaultCatalog - Default catalog
-
setId
Generated method - Setter ofCatalog.idattribute defined at extensioncatalog.- Parameters:
value- the id - ID
-
setName
Generated method - Setter ofCatalog.nameattribute defined at extensioncatalog.- Parameters:
value- the name - Name
-
setName
Generated method - Setter ofCatalog.nameattribute defined at extensioncatalog.- Parameters:
value- the name - Nameloc- the value localization key- Throws:
IllegalArgumentException- if localization key cannot be mapped to data language
-
setPreviewURLTemplate
@Accessor(qualifier="previewURLTemplate", type=SETTER) public void setPreviewURLTemplate(String value) Generated method - Setter ofCatalog.previewURLTemplateattribute defined at extensioncatalog.- Parameters:
value- the previewURLTemplate
-
setRestrictions
@Accessor(qualifier="restrictions", type=SETTER) public void setRestrictions(Collection<CMSCatalogRestrictionModel> value) Generated method - Setter ofCatalog.restrictionsattribute defined at extensioncms2.- Parameters:
value- the restrictions
-
setSupplier
Generated method - Setter ofCatalog.supplierattribute defined at extensioncatalog.- Parameters:
value- the supplier
-
setUrlPatterns
@Accessor(qualifier="urlPatterns", type=SETTER) public void setUrlPatterns(Collection<String> value) Generated method - Setter ofCatalog.urlPatternsattribute defined at extensioncatalog.- Parameters:
value- the urlPatterns - Collection of URL patterns
-