Package de.hybris.platform.catalog.jalo.classification

Class ClassificationSystemVersion

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.catalog.jalo.GeneratedCatalogVersion

de.hybris.platform.catalog.jalo.CatalogVersion

de.hybris.platform.catalog.jalo.classification.GeneratedClassificationSystemVersion

de.hybris.platform.catalog.jalo.classification.ClassificationSystemVersion

All Implemented Interfaces:

Serializable, Comparable

public class ClassificationSystemVersion
extends GeneratedClassificationSystemVersion

Represents a classification system version. This is the actual container for classification classes, attributes, values and units.

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 inherited from class de.hybris.platform.catalog.jalo.classification.GeneratedClassificationSystemVersion

CATALOGHANDLER, DEFAULT_INITIAL_ATTRIBUTES

Fields inherited from class de.hybris.platform.catalog.jalo.CatalogVersion

ERROR

Fields inherited from class de.hybris.platform.catalog.jalo.GeneratedCatalogVersion

ACTIVE, AGREEMENTS, AGREEMENTSHANDLER, CATALOG, CATEGORYSYSTEMDESCRIPTION, CATEGORYSYSTEMID, CATEGORYSYSTEMNAME, DEFAULTCURRENCY, GENERATIONDATE, GENERATORINFO, INCLASSURANCE, INCLDUTY, INCLFREIGHT, INCLPACKING, INCOMINGSYNCHRONIZATIONS, INCOMINGSYNCHRONIZATIONSHANDLER, LANGUAGES, MIMEROOTDIRECTORY, PREVIOUSUPDATEVERSION, PRINCIPAL2READABLECATALOGVERSIONRELATION_MARKMODIFIED, PRINCIPAL2READABLECATALOGVERSIONRELATION_SRC_ORDERED, PRINCIPAL2READABLECATALOGVERSIONRELATION_TGT_ORDERED, PRINCIPAL2WRITEABLECATALOGVERSIONRELATION_MARKMODIFIED, PRINCIPAL2WRITEABLECATALOGVERSIONRELATION_SRC_ORDERED, PRINCIPAL2WRITEABLECATALOGVERSIONRELATION_TGT_ORDERED, READPRINCIPALS, SYNCHRONIZATIONS, SYNCHRONIZATIONSHANDLER, TERRITORIES, VERSION, WRITEPRINCIPALS

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
ClassificationSystemVersion()

Method Summary

Modifier and Type	Method	Description
ClassificationAttributeUnit	createAttributeUnit(String code, String symbol)	Creates a new attribute unit within this system.
ClassificationAttributeUnit	createAttributeUnit(String code, String symbol, String unitType, double conversion)	Creates a new attribute unit within this system.
ClassificationClass	createClass(ClassificationClass superClass, String code)	Creates a new class within this system version.
ClassificationClass	createClass(String code)	Creates a new class within this system version.
ClassificationAttribute	createClassificationAttribute(String code)	Creates a new classification attribute.
ClassificationAttributeValue	createClassificationAttributeValue(String code)	Creates a new attribute value within this system version.
ClassificationAttributeUnit	getAttributeUnit(String code)	Deprecated. since ages - use classificationSystemService.getAttributeUnitForCode(systemVersion, code)
ClassificationAttributeUnit	getAttributeUnitBySymbol(String unitSymbol)
Collection<ClassificationAttributeUnit>	getAttributeUnits()	Deprecated. since ages - use classificationSystemService.getAttributeUnitsForSystemVersion(systemVersion)
ClassificationAttribute	getClassificationAttribute(String code)	Deprecated. since ages - use classificationSystemService.getAttributeForCode(systemVersion, code)
ClassificationAttributeValue	getClassificationAttributeValue(String code)	Deprecated. since ages - use classificationSystemService.getAttributeValueForCode(systemVersion, code)
ClassificationClass	getClassificationClass(Product product)	Returns the classification class within this system version which is used to classify the given product, or null if the product is not beeing classified by this system version.
ClassificationClass	getClassificationClass(String code)	Deprecated. since ages - use classificationSystemService.getClassForCode(systemVersion, code)
Collection<ClassificationClass>	getClassificationClasses(Product product)
ClassificationSystem	getClassificationSystem()
String	getFullVersionName()
Collection<ClassificationClass>	getRootClasses()	Deprecated. since ages - use classificationSystemService.getRootClassesForSystemVersion(systemVersion);
protected void	setCatalog(SessionContext ctx, Catalog param)	Generated method - Setter of the CatalogVersion.catalog attribute.
void	setClassificationClass(Product product, ClassificationClass classificationClass)	Changes the class assignment of the given product to the given classification class from this system version without changing its class assignments regarding other systems or system versions.
String	toString()	Returns the String representation of this item.

Methods inherited from class de.hybris.platform.catalog.jalo.classification.GeneratedClassificationSystemVersion

createItem, getDefaultAttributeModes

Methods inherited from class de.hybris.platform.catalog.jalo.CatalogVersion

addLanguage, checkRemovable, getAllCategories, getAllCategories, getAllCategoryCount, getAllCategoryCount, getAllKeywordCount, getAllKeywordCount, getAllKeywords, getAllKeywords, getAllMediaCount, getAllMedias, getAllMedias, getAllProductCount, getAllProductCount, getAllProducts, getAllProducts, getAllVisibleCategories, getAllVisibleCategoryCount, getAllVisibleProductCount, getAllVisibleProducts, getCatalogVersionItems, getCatalogVersionItems, getCategories, getCategories, getCategory, getCategory, getDuplicateCatalogItemIDs, getDuplicateCategoryIDs, getDuplicatedCatalogItemsCount, getDuplicateKeywords, getDuplicateMediaIDs, getDuplicateProductIDs, getKeywords, getMedia, getMedia, getMedias, getMedias, getProduct, getProduct, getProducts, getProducts, getRootCategories, getRootCategories, getRootCategoriesCount, getRootCategoriesCount, getSameCategories, getSameCategories, getSameKeywords, getSameMedias, getSameProducts, getSameProducts, getSyncJobs, getSyncJobs, hasAgreement, hasSynchronizations, isImportedLanguage, isRemovable, owns, owns, ownsCategories, remove, setActive, setActiveInternal, setLanguages, setReadPrincipals, setRootCategories, setRootCategories, setWritePrincipals

Methods inherited from class de.hybris.platform.catalog.jalo.GeneratedCatalogVersion

addToAgreements, addToAgreements, addToReadPrincipals, addToReadPrincipals, addToSynchronizations, addToSynchronizations, addToWritePrincipals, addToWritePrincipals, getAgreements, getAgreements, getAllCategorySystemDescription, getAllCategorySystemDescription, getAllCategorySystemName, getAllCategorySystemName, getCatalog, getCatalog, getCategorySystemDescription, getCategorySystemDescription, getCategorySystemID, getCategorySystemID, getCategorySystemName, getCategorySystemName, getDefaultCurrency, getDefaultCurrency, getGenerationDate, getGenerationDate, getGeneratorInfo, getGeneratorInfo, getIncomingSynchronizations, getIncomingSynchronizations, getLanguages, getLanguages, getMimeRootDirectory, getMimeRootDirectory, getPreviousUpdateVersion, getPreviousUpdateVersion, getPreviousUpdateVersionAsPrimitive, getPreviousUpdateVersionAsPrimitive, getReadPrincipals, getReadPrincipals, getReadPrincipalsCount, getReadPrincipalsCount, getSynchronizations, getSynchronizations, getTerritories, getTerritories, getVersion, getVersion, getWritePrincipals, getWritePrincipals, getWritePrincipalsCount, getWritePrincipalsCount, isActive, isActive, isActiveAsPrimitive, isActiveAsPrimitive, isInclAssurance, isInclAssurance, isInclAssuranceAsPrimitive, isInclAssuranceAsPrimitive, isInclDuty, isInclDuty, isInclDutyAsPrimitive, isInclDutyAsPrimitive, isInclFreight, isInclFreight, isInclFreightAsPrimitive, isInclFreightAsPrimitive, isInclPacking, isInclPacking, isInclPackingAsPrimitive, isInclPackingAsPrimitive, isMarkModifiedDisabled, removeFromAgreements, removeFromAgreements, removeFromReadPrincipals, removeFromReadPrincipals, removeFromSynchronizations, removeFromSynchronizations, removeFromWritePrincipals, removeFromWritePrincipals, setActive, setActive, setActive, setAgreements, setAgreements, setAllCategorySystemDescription, setAllCategorySystemDescription, setAllCategorySystemName, setAllCategorySystemName, setCatalog, setCategorySystemDescription, setCategorySystemDescription, setCategorySystemID, setCategorySystemID, setCategorySystemName, setCategorySystemName, setDefaultCurrency, setDefaultCurrency, setGenerationDate, setGenerationDate, setGeneratorInfo, setGeneratorInfo, setInclAssurance, setInclAssurance, setInclAssurance, setInclAssurance, setInclDuty, setInclDuty, setInclDuty, setInclDuty, setInclFreight, setInclFreight, setInclFreight, setInclFreight, setInclPacking, setInclPacking, setInclPacking, setInclPacking, setLanguages, setMimeRootDirectory, setMimeRootDirectory, setPreviousUpdateVersion, setPreviousUpdateVersion, setPreviousUpdateVersion, setPreviousUpdateVersion, setReadPrincipals, setSynchronizations, setSynchronizations, setTerritories, setTerritories, setVersion, setVersion, setWritePrincipals

Methods inherited from class de.hybris.platform.jalo.GenericItem

getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, 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, getPartOfRemovedSessionMarker, 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, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, 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, suppressRelation, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClassificationSystemVersion

public ClassificationSystemVersion()

Method Details

toString

public String toString()

Description copied from class: Item

Returns the String representation of this item. This is by default the representation of the primary key of this item.

Overrides:

toString in class CatalogVersion

Returns:

the String representation of this item.

See Also:

• Object.toString()

getClassificationSystem

public ClassificationSystem getClassificationSystem()

setCatalog

protected void setCatalog(SessionContext ctx,
 Catalog param)

Description copied from class: GeneratedCatalogVersion

Generated method - Setter of the CatalogVersion.catalog attribute.

Overrides:

setCatalog in class CatalogVersion

param - the catalog

getFullVersionName

public String getFullVersionName()

Returns:

the full classification system version name; that is systemId+"."+version

createClass

public ClassificationClass createClass(String code)
                                throws ConsistencyCheckException

Creates a new class within this system version. Ensures that the class code is unique.

Parameters:

code - the code of the new class

Throws:

ConsistencyCheckException - in case a class with the same code already exists

createClass

public ClassificationClass createClass(ClassificationClass superClass,
 String code)
                                throws ConsistencyCheckException

Creates a new class within this system version. Ensures that the class code is unique.

Parameters:

code - the code of the new class

Throws:

ConsistencyCheckException - in case a class with the same code already exists

createClassificationAttribute

public ClassificationAttribute createClassificationAttribute(String code)
                                                      throws ConsistencyCheckException

Creates a new classification attribute. Ensures that the attribute code is unique within this system.

Parameters:

code - the code of the new attribute

Throws:

ConsistencyCheckException - in case an attribute exists holding the same code

getClassificationAttribute

@Deprecated(since="ages",
            forRemoval=false)
public ClassificationAttribute getClassificationAttribute(String code)
                                                   throws JaloItemNotFoundException

Deprecated.

since ages - use classificationSystemService.getAttributeForCode(systemVersion, code)

Finds a classification attribute by its (unique) code.

Parameters:

code - the attribute code

Throws:

JaloItemNotFoundException - if no such attribute exists

getClassificationClass

@Deprecated(since="ages",
            forRemoval=false)
public ClassificationClass getClassificationClass(String code)
                                           throws JaloItemNotFoundException

Deprecated.

since ages - use classificationSystemService.getClassForCode(systemVersion, code)

Finds a classification class by its (unique) code.

Parameters:

code - the class code

Throws:

JaloItemNotFoundException - in case there is no such class

getClassificationClass

public ClassificationClass getClassificationClass(Product product)
                                           throws JaloInvalidParameterException

Returns the classification class within this system version which is used to classify the given product, or null if the product is not beeing classified by this system version.

Please note that the product may be assigned to more than one classification class within this system though this should be rather an exception. In this case a exception is raised.

Throws:

JaloInvalidParameterException - if the product is assigned to more than one class of this system version

getClassificationClasses

public Collection<ClassificationClass> getClassificationClasses(Product product)

setClassificationClass

public void setClassificationClass(Product product,
 ClassificationClass classificationClass)

Changes the class assignment of the given product to the given classification class from this system version without changing its class assignments regarding other systems or system versions.

Parameters:

product - the product to change classification for

classificationClass - the new classification class to assign

getRootClasses

@Deprecated(since="ages",
            forRemoval=false)
public Collection<ClassificationClass> getRootClasses()

Deprecated.

since ages - use classificationSystemService.getRootClassesForSystemVersion(systemVersion);

Returns all root classes. This method does the same as CatalogVersion.getRootCategories() except that only ClassificationClass instances are returned.

createClassificationAttributeValue

public ClassificationAttributeValue createClassificationAttributeValue(String code)
                                                                throws ConsistencyCheckException

Creates a new attribute value within this system version. Ensures uniqe value code.

Parameters:

code - the code of the new value

Throws:

ConsistencyCheckException - in case a value holding the same code already exists

getClassificationAttributeValue

@Deprecated(since="ages",
            forRemoval=false)
public ClassificationAttributeValue getClassificationAttributeValue(String code)
                                                             throws JaloItemNotFoundException

Deprecated.

since ages - use classificationSystemService.getAttributeValueForCode(systemVersion, code)

Finds a attribute value by its (unique) code.

Parameters:

code - the value code

Throws:

JaloItemNotFoundException - if no such value exists

createAttributeUnit

public ClassificationAttributeUnit createAttributeUnit(String code,
 String symbol)
                                                throws ConsistencyCheckException

Creates a new attribute unit within this system.

Parameters:

code - the unit code

symbol - the unit symbol

Throws:

ConsistencyCheckException - if a unit with the same code already exists

createAttributeUnit

public ClassificationAttributeUnit createAttributeUnit(String code,
 String symbol,
 String unitType,
 double conversion)
                                                throws ConsistencyCheckException,
JaloInvalidParameterException

Creates a new attribute unit within this system. By specifying a unit type and a conversion factor this unit may be convertible with other units.

Parameters:

code - the unit code

symbol - the unit symbol

unitType - the unit type indetifier; all units with the same type are considered as beeing convertible

conversion - only valid if unitType is set: specifies how values of this unit are measured in comparison to values of other convertible units; must be > 0 !

Throws:

ConsistencyCheckException - if a unit with the same code already exists

JaloInvalidParameterException - if the conversion factor is <= 0

getAttributeUnitBySymbol

public ClassificationAttributeUnit getAttributeUnitBySymbol(String unitSymbol)
                                                     throws JaloItemNotFoundException

Throws:

JaloItemNotFoundException

getAttributeUnit

@Deprecated(since="ages",
            forRemoval=false)
public ClassificationAttributeUnit getAttributeUnit(String code)
                                             throws JaloItemNotFoundException

Deprecated.

since ages - use classificationSystemService.getAttributeUnitForCode(systemVersion, code)

Finds an attribute unit by its unique code.

Parameters:

code - the unit code

Throws:

JaloItemNotFoundException - in case there is no such unit

getAttributeUnits

@Deprecated(since="ages",
            forRemoval=false)
public Collection<ClassificationAttributeUnit> getAttributeUnits()

Deprecated.

since ages - use classificationSystemService.getAttributeUnitsForSystemVersion(systemVersion)