Package de.hybris.platform.catalog.jalo
Class Catalog
- java.lang.Object
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable
- Direct Known Subclasses:
GeneratedClassificationSystem
,GeneratedContentCatalog
public class Catalog extends GeneratedCatalog
ACatalog
is the root element of theCatalogExtension
. Each catalog has an ID, a name and a supplier. The combination of the supplier of an catalog and its id must be unique. The different versions of a catalog are represented byCatalogVersion
s, which are accessible throughGeneratedCatalog.getCatalogVersions()
andgetCatalogVersion(String)
.
To simplify the development of storefront, catalog provides the possibility to set oneCatalogVersion
as active. All attributes of the activeCatalogVersion
can be accessed through delegation methods of theCatalog
. If no activeCatalogVersion
is set, these methods will returnnull. The following methods will return the corresponding value of the currently active CatalogVersion
:getAgreements(SessionContext)
getRootCategories(SessionContext)
getGenerationDate(SessionContext)
getGeneratorInfo(SessionContext)
getLanguages(SessionContext)
getMimeRootDirectory(SessionContext)
getTerritories(SessionContext)
getVersion(SessionContext)
isInclAssurance(SessionContext)
isInclAssuranceAsPrimitive(SessionContext)
isInclDuty(SessionContext)
isInclDutyAsPrimitive(SessionContext)
isInclFreight(SessionContext)
isInclFreightAsPrimitive(SessionContext)
isInclPacking(SessionContext)
isInclPackingAsPrimitive(SessionContext)
getAllCategories()
getAllCategories(int, int)
getAllCategoryCount()
getAllKeywordCount()
getAllKeywords()
getAllKeywords(int, int)
getAllMediaCount()
getAllMedias()
getAllMedias(int, int)
getAllProductCount()
getAllProducts()
getAllProducts(int, int)
getCategories(SessionContext, String)
getCategories(String)
getCategory(SessionContext, String)
getCategory(String)
getProducts(SessionContext, String)
getProducts(String)
getProduct(SessionContext, String)
getProduct(String)
getMedias(SessionContext, String)
getMedias(String)
getMedia(SessionContext, String)
getMedia(String)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem
GenericItem.GenericItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item
Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException
-
-
Field Summary
Fields Modifier and Type Field Description static int
ERROR
-
Fields inherited from class de.hybris.platform.catalog.jalo.GeneratedCatalog
ACTIVECATALOGVERSION, BUYER, BUYERHANDLER, CATALOGVERSIONS, CATALOGVERSIONSHANDLER, DEFAULT_INITIAL_ATTRIBUTES, DEFAULTCATALOG, ID, NAME, PREVIEWURLTEMPLATE, SUPPLIER, SUPPLIERHANDLER, URLPATTERNS
-
Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLED
-
Fields inherited from class de.hybris.platform.jalo.Item
_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE
-
Fields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant
-
-
Constructor Summary
Constructors Constructor Description Catalog()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
checkRemovable(SessionContext ctx)
Checks whether or not this it may be removed or not.protected Item
createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)
Has to be implemented for each concrete subtype of item.java.util.Collection<Agreement>
getAgreements()
java.util.Collection<Agreement>
getAgreements(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getAgreements() instead.java.util.Collection<Category>
getAllCategories()
ReturnsCatalogVersion.getAllCategories()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Category>
getAllCategories(int start, int count)
ReturnsCatalogVersion.getAllCategories(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.int
getAllCategoryCount()
ReturnsCatalogVersion.getAllCategoryCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.int
getAllKeywordCount()
ReturnsCatalogVersion.getAllKeywordCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.java.util.Collection<Keyword>
getAllKeywords()
ReturnsCatalogVersion.getAllKeywords()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Keyword>
getAllKeywords(int start, int count)
ReturnsCatalogVersion.getAllKeywords(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.int
getAllMediaCount()
ReturnsCatalogVersion.getAllMediaCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.java.util.Collection<Media>
getAllMedias()
ReturnsCatalogVersion.getAllMedias()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Media>
getAllMedias(int start, int count)
ReturnsCatalogVersion.getAllMedias(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.int
getAllProductCount()
ReturnsCatalogVersion.getAllProductCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.java.util.Collection<Product>
getAllProducts()
ReturnsCatalogVersion.getAllProducts()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Product>
getAllProducts(int start, int count)
ReturnsCatalogVersion.getAllProducts(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.CatalogVersion
getCatalogVersion(java.lang.String version)
Deprecated.since ages - Use CatalogVersionService.getCatalogVersion(String, String) instead.java.util.Collection<Category>
getCategories(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getCategories(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Category>
getCategories(java.lang.String code)
ReturnsCatalogVersion.getCategory(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.Category
getCategory(SessionContext ctx, java.lang.String code)
Deprecated.since ages - Use CategoryService.getCategory(de.hybris.platform.catalog.model.CatalogVersionModel, String)} for active CatalogVersionModel instead.Category
getCategory(java.lang.String code)
Deprecated.since ages - Use CategoryService.getCategory(de.hybris.platform.catalog.model.CatalogVersionModel, String)} for active CatalogVersionModel instead.Currency
getDefaultCurrency()
Currency
getDefaultCurrency(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getDefaultCurrency() instead.java.util.Date
getGenerationDate()
java.util.Date
getGenerationDate(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getGenerationDate() instead.java.lang.String
getGeneratorInfo()
java.lang.String
getGeneratorInfo(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getGeneratorInfo() instead.java.util.Collection<Language>
getLanguages()
java.util.Collection<Language>
getLanguages(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getLanguages() instead.Media
getMedia(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getMedia(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.Media
getMedia(java.lang.String code)
ReturnsCatalogVersion.getMedia(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Media>
getMedias(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getMedias(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Media>
getMedias(java.lang.String code)
ReturnsCatalogVersion.getMedias(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.lang.String
getMimeRootDirectory()
java.lang.String
getMimeRootDirectory(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getMimeRootDirectory() instead.Product
getProduct(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getProduct(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.Product
getProduct(java.lang.String code)
Deprecated.since ages - Use ProductService.getProduct(CatalogVersionModel, String)} for active CatalogVersionModel instead.java.util.Collection<Product>
getProducts(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getProducts(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.Collection<Product>
getProducts(java.lang.String code)
ReturnsCatalogVersion.getProducts(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.java.util.List<Category>
getRootCategories()
java.util.List<Category>
getRootCategories(SessionContext ctx)
ReturnsCatalogVersion.getRootCategories(SessionContext)
of the active (GeneratedCatalog.getActiveCatalogVersion()
orCollections.EMPTY_LIST
if no activeCatalogVersion
is set.java.util.Collection<Country>
getTerritories()
java.util.Collection<Country>
getTerritories(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getTerritories() instead.java.lang.String
getVersion()
java.lang.String
getVersion(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() instead.java.lang.Boolean
isInclAssurance()
java.lang.Boolean
isInclAssurance(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclAssurance() instead.boolean
isInclAssuranceAsPrimitive()
boolean
isInclAssuranceAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclAssurance() instead.java.lang.Boolean
isInclDuty()
java.lang.Boolean
isInclDuty(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclDuty() instead.boolean
isInclDutyAsPrimitive()
boolean
isInclDutyAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclDuty() instead.java.lang.Boolean
isInclFreight()
java.lang.Boolean
isInclFreight(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclFreight() instead.boolean
isInclFreightAsPrimitive()
boolean
isInclFreightAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclFreight() instead.java.lang.Boolean
isInclPacking()
java.lang.Boolean
isInclPacking(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclPacking() instead.boolean
isInclPackingAsPrimitive()
boolean
isInclPackingAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclPacking() instead.void
setActiveCatalogVersion(SessionContext ctx, CatalogVersion catalogVersion)
Deprecated.since ages - Use CatalogModel.setActiveCatalogVersion(de.hybris.platform.catalog.model.CatalogVersionModel) instead.protected void
setActiveCatalogVersionInternal(SessionContext ctx, CatalogVersion catalogVersion)
Used byCatalogVersion.setActive(SessionContext, Boolean)
to make sure the catalog is having the correct active version even if only the active flag of the version is changed.void
setDefaultCatalog(SessionContext ctx, java.lang.Boolean param)
Deprecated.since ages - The corresponding logic is handled by CatalogPrepareInterceptor.void
setUrlPatterns(SessionContext ctx, java.util.Collection<java.lang.String> value)
Deprecated.since ages - The corresponding logic is handled by CatalogURLPatternsValidator.-
Methods inherited from class de.hybris.platform.catalog.jalo.GeneratedCatalog
addToCatalogVersions, addToCatalogVersions, getActiveCatalogVersion, getActiveCatalogVersion, getAllName, getAllName, getBuyer, getBuyer, getCatalogVersions, getCatalogVersions, getDefaultAttributeModes, getId, getId, getName, getName, getPreviewURLTemplate, getPreviewURLTemplate, getSupplier, getSupplier, getUrlPatterns, getUrlPatterns, isDefaultCatalog, isDefaultCatalog, isDefaultCatalogAsPrimitive, isDefaultCatalogAsPrimitive, removeFromCatalogVersions, removeFromCatalogVersions, setActiveCatalogVersion, setAllName, setAllName, setBuyer, setBuyer, setCatalogVersions, setCatalogVersions, setDefaultCatalog, setDefaultCatalog, setDefaultCatalog, setId, setId, setName, setName, setPreviewURLTemplate, setPreviewURLTemplate, setSupplier, setSupplier, setUrlPatterns
-
Methods inherited from class de.hybris.platform.jalo.GenericItem
getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, setRelatedItems
-
Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty
-
Methods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty
-
Methods inherited from class de.hybris.platform.jalo.Item
addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isMarkModifiedDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace
-
Methods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
-
-
-
Field Detail
-
ERROR
public static final int ERROR
- See Also:
- Constant Field Values
-
-
Method Detail
-
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. ) duringComposedType.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 classGeneratedCatalog
- Parameters:
ctx
- the current session context which this item is created withintype
- 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
-
checkRemovable
protected void checkRemovable(SessionContext ctx) throws ConsistencyCheckException
Description copied from class:Item
Checks whether or not this it may be removed or not. Called before the actual removal process.- Overrides:
checkRemovable
in classItem
- Throws:
ConsistencyCheckException
- to indicate that the item cannot be removed
-
setActiveCatalogVersion
@Deprecated public void setActiveCatalogVersion(SessionContext ctx, CatalogVersion catalogVersion)
Deprecated.since ages - Use CatalogModel.setActiveCatalogVersion(de.hybris.platform.catalog.model.CatalogVersionModel) instead. The DefaultCatalogPrepareInterceptor will handle the corresponding logic.Description copied from class:GeneratedCatalog
Generated method - Setter of theCatalog.activeCatalogVersion
attribute.- Overrides:
setActiveCatalogVersion
in classGeneratedCatalog
catalogVersion
- the activeCatalogVersion - active CatalogVersion
-
setActiveCatalogVersionInternal
protected void setActiveCatalogVersionInternal(SessionContext ctx, CatalogVersion catalogVersion)
Used byCatalogVersion.setActive(SessionContext, Boolean)
to make sure the catalog is having the correct active version even if only the active flag of the version is changed.For internal use only!
-
getRootCategories
public java.util.List<Category> getRootCategories(SessionContext ctx)
ReturnsCatalogVersion.getRootCategories(SessionContext)
of the active (GeneratedCatalog.getActiveCatalogVersion()
orCollections.EMPTY_LIST
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
CatalogVersion.getRootCategories(SessionContext)
of the active (GeneratedCatalog.getActiveCatalogVersion()
orCollections.EMPTY_LIST
if no activeCatalogVersion
is set
-
getRootCategories
public java.util.List<Category> getRootCategories()
-
getCatalogVersion
@Deprecated public CatalogVersion getCatalogVersion(java.lang.String version)
Deprecated.since ages - Use CatalogVersionService.getCatalogVersion(String, String) instead.Returns theCatalogVersion
of thisCatalog
with version specified in the version parameter ornull
if noCatalogVersion
with the specified version exists.- Parameters:
version
- version of theCatalogVersion
as aString
which should be returned.- Returns:
- the
CatalogVersion
of thisCatalog
with version specified in the version parameter ornull
if noCatalogVersion
with the specified version exists
-
getVersion
@Deprecated public java.lang.String getVersion(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() instead.ReturnsGeneratedCatalogVersion.getVersion()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.getVersion()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getVersion
public java.lang.String getVersion()
-
getMimeRootDirectory
@Deprecated public java.lang.String getMimeRootDirectory(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getMimeRootDirectory() instead.ReturnsGeneratedCatalogVersion.getMimeRootDirectory()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.getMimeRootDirectory()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getMimeRootDirectory
public java.lang.String getMimeRootDirectory()
-
getGenerationDate
@Deprecated public java.util.Date getGenerationDate(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getGenerationDate() instead.ReturnsGeneratedCatalogVersion.getGenerationDate()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.getGenerationDate()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getGenerationDate
public java.util.Date getGenerationDate()
-
getDefaultCurrency
@Deprecated public Currency getDefaultCurrency(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getDefaultCurrency() instead.ReturnsGeneratedCatalogVersion.getDefaultCurrency()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.getDefaultCurrency()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getDefaultCurrency
public Currency getDefaultCurrency()
-
isInclFreight
@Deprecated public java.lang.Boolean isInclFreight(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclFreight() instead.ReturnsGeneratedCatalogVersion.isInclFreight()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclFreight()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
isInclFreight
public java.lang.Boolean isInclFreight()
-
isInclFreightAsPrimitive
public boolean isInclFreightAsPrimitive()
-
isInclFreightAsPrimitive
@Deprecated public boolean isInclFreightAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclFreight() instead.ReturnsGeneratedCatalogVersion.isInclFreightAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclFreightAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set
-
isInclPacking
@Deprecated public java.lang.Boolean isInclPacking(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclPacking() instead.ReturnsGeneratedCatalogVersion.isInclPacking()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclPacking()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
isInclPacking
public java.lang.Boolean isInclPacking()
-
isInclPackingAsPrimitive
public boolean isInclPackingAsPrimitive()
-
isInclPackingAsPrimitive
@Deprecated public boolean isInclPackingAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclPacking() instead.ReturnsGeneratedCatalogVersion.isInclPackingAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclPackingAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set
-
isInclAssurance
@Deprecated public java.lang.Boolean isInclAssurance(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclAssurance() instead.ReturnsGeneratedCatalogVersion.isInclAssurance()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclAssurance()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
isInclAssurance
public java.lang.Boolean isInclAssurance()
-
isInclAssuranceAsPrimitive
public boolean isInclAssuranceAsPrimitive()
-
isInclAssuranceAsPrimitive
@Deprecated public boolean isInclAssuranceAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclAssurance() instead.ReturnsGeneratedCatalogVersion.isInclAssuranceAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclAssuranceAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set
-
isInclDuty
@Deprecated public java.lang.Boolean isInclDuty(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclDuty() instead.ReturnsGeneratedCatalogVersion.isInclDuty()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclDuty()
of the active (GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
isInclDuty
public java.lang.Boolean isInclDuty()
-
isInclDutyAsPrimitive
public boolean isInclDutyAsPrimitive()
-
isInclDutyAsPrimitive
@Deprecated public boolean isInclDutyAsPrimitive(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getInclDuty() instead.ReturnsGeneratedCatalogVersion.isInclDutyAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
GeneratedCatalogVersion.isInclDutyAsPrimitive()
of the active (GeneratedCatalog.getActiveCatalogVersion()
orfalse
if no activeCatalogVersion
is set
-
getTerritories
@Deprecated public java.util.Collection<Country> getTerritories(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getTerritories() instead.Returns aCollection
of allCountry
s (GeneratedCatalogVersion.getTerritories()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
- a
Collection
of allCountry
s (GeneratedCatalogVersion.getTerritories()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getTerritories
public java.util.Collection<Country> getTerritories()
-
getLanguages
@Deprecated public java.util.Collection<Language> getLanguages(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getLanguages() instead.Returns aCollection
of allLanguage
s of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
- a
Collection
of allLanguage
s of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getLanguages
public java.util.Collection<Language> getLanguages()
-
getGeneratorInfo
@Deprecated public java.lang.String getGeneratorInfo(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getGeneratorInfo() instead.Returns the generator info (GeneratedCatalogVersion.getGeneratorInfo()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
- the generator info (
GeneratedCatalogVersion.getGeneratorInfo()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getGeneratorInfo
public java.lang.String getGeneratorInfo()
-
getAgreements
@Deprecated public java.util.Collection<Agreement> getAgreements(SessionContext ctx)
Deprecated.since ages - Use CatalogModel.getActiveCatalogVersion() and CatalogVersionModel.getAgreements() instead.Returns allAgreement
s (GeneratedCatalogVersion.getAgreements()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
- theSessionContext
- Returns:
- all
Agreement
s (GeneratedCatalogVersion.getAgreements()
) of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.
-
getAgreements
public java.util.Collection<Agreement> getAgreements()
-
getAllCategories
public java.util.Collection<Category> getAllCategories()
ReturnsCatalogVersion.getAllCategories()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllCategories()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllCategories
public java.util.Collection<Category> getAllCategories(int start, int count)
ReturnsCatalogVersion.getAllCategories(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
start
-count
-- Returns:
CatalogVersion.getAllCategories(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllCategoryCount
public int getAllCategoryCount()
ReturnsCatalogVersion.getAllCategoryCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllCategoryCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set
-
getAllKeywords
public java.util.Collection<Keyword> getAllKeywords()
ReturnsCatalogVersion.getAllKeywords()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllKeywords()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllKeywords
public java.util.Collection<Keyword> getAllKeywords(int start, int count)
ReturnsCatalogVersion.getAllKeywords(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
start
-count
-- Returns:
CatalogVersion.getAllKeywords(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllKeywordCount
public int getAllKeywordCount()
ReturnsCatalogVersion.getAllKeywordCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllKeywordCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set
-
getAllMedias
public java.util.Collection<Media> getAllMedias()
ReturnsCatalogVersion.getAllMedias()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllMedias()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllMedias
public java.util.Collection<Media> getAllMedias(int start, int count)
ReturnsCatalogVersion.getAllMedias(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
start
-count
-- Returns:
CatalogVersion.getAllMedias(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllMediaCount
public int getAllMediaCount()
ReturnsCatalogVersion.getAllMediaCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllMediaCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set
-
getAllProducts
public java.util.Collection<Product> getAllProducts()
ReturnsCatalogVersion.getAllProducts()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllProducts()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllProducts
public java.util.Collection<Product> getAllProducts(int start, int count)
ReturnsCatalogVersion.getAllProducts(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
start
-count
-- Returns:
CatalogVersion.getAllProducts(int, int)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getAllProductCount
public int getAllProductCount()
ReturnsCatalogVersion.getAllProductCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set.- Returns:
CatalogVersion.getAllProductCount()
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
or-1
if no activeCatalogVersion
is set
-
getCategory
@Deprecated public Category getCategory(java.lang.String code)
Deprecated.since ages - Use CategoryService.getCategory(de.hybris.platform.catalog.model.CatalogVersionModel, String)} for active CatalogVersionModel instead.ReturnsCatalogVersion.getCategory(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getCategory(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getCategory
@Deprecated public Category getCategory(SessionContext ctx, java.lang.String code)
Deprecated.since ages - Use CategoryService.getCategory(de.hybris.platform.catalog.model.CatalogVersionModel, String)} for active CatalogVersionModel instead.ReturnsCatalogVersion.getCategory(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getCategory(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getCategories
public java.util.Collection<Category> getCategories(java.lang.String code)
ReturnsCatalogVersion.getCategory(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getCategory(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getCategories
public java.util.Collection<Category> getCategories(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getCategories(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getCategories(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getProduct
@Deprecated public Product getProduct(java.lang.String code)
Deprecated.since ages - Use ProductService.getProduct(CatalogVersionModel, String)} for active CatalogVersionModel instead.ReturnsCatalogVersion.getProduct(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getProduct(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getProduct
public Product getProduct(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getProduct(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getProduct(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getProducts
public java.util.Collection<Product> getProducts(java.lang.String code)
ReturnsCatalogVersion.getProducts(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getProducts(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getProducts
public java.util.Collection<Product> getProducts(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getProducts(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getProducts(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getMedia
public Media getMedia(java.lang.String code)
ReturnsCatalogVersion.getMedia(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getMedia(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getMedia
public Media getMedia(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getMedia(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getMedia(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getMedias
public java.util.Collection<Media> getMedias(java.lang.String code)
ReturnsCatalogVersion.getMedias(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
code
-- Returns:
CatalogVersion.getMedias(String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
getMedias
public java.util.Collection<Media> getMedias(SessionContext ctx, java.lang.String code)
ReturnsCatalogVersion.getMedias(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set.- Parameters:
ctx
-code
-- Returns:
CatalogVersion.getMedias(SessionContext, String)
of the activeCatalogVersion
(GeneratedCatalog.getActiveCatalogVersion()
ornull
if no activeCatalogVersion
is set
-
setDefaultCatalog
@Deprecated public void setDefaultCatalog(SessionContext ctx, java.lang.Boolean param)
Deprecated.since ages - The corresponding logic is handled by CatalogPrepareInterceptor.Description copied from class:GeneratedCatalog
Generated method - Setter of theCatalog.defaultCatalog
attribute.- Overrides:
setDefaultCatalog
in classGeneratedCatalog
param
- the defaultCatalog - Default catalog- See Also:
GeneratedCatalog.setDefaultCatalog(de.hybris.platform.jalo.SessionContext, java.lang.Boolean)
-
setUrlPatterns
@Deprecated public void setUrlPatterns(SessionContext ctx, java.util.Collection<java.lang.String> value)
Deprecated.since ages - The corresponding logic is handled by CatalogURLPatternsValidator.Description copied from class:GeneratedCatalog
Generated method - Setter of theCatalog.urlPatterns
attribute.- Overrides:
setUrlPatterns
in classGeneratedCatalog
value
- the urlPatterns - Collection of URL patterns
-
-