de.hybris.platform.classification

Interface ClassificationSystemService

All Known Implementing Classes:

DefaultClassificationSystemService

public interface ClassificationSystemService

Provides access to ClassificationSystems, and ClassificationSystemVersions, ClassificationClasses, ClassificationAttributes, ClassificationAttributeUnits, and ClassificationAttributeValues.

Spring Bean ID:

classificationSystemService

Method Summary

Modifier and Type	Method and Description
ClassificationAttributeModel	getAttributeForCode(ClassificationSystemVersionModel systemVersion, java.lang.String code) Retrieves the ClassificationAttributeModel in the classification system version with the code.
ClassificationAttributeUnitModel	getAttributeUnitForCode(ClassificationSystemVersionModel systemVersion, java.lang.String code) Retrieves the ClassificationAttributeUnitModel in the classification system version with the code.
java.util.Collection<ClassificationAttributeUnitModel>	getAttributeUnitsForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all ClassificationAttributeUnitModels in the classification system version.
ClassificationAttributeValueModel	getAttributeValueForCode(ClassificationSystemVersionModel systemVersion, java.lang.String code) Retrieves the ClassificationAttributeValueModel in the classification system version with the code.
ClassificationClassModel	getClassForCode(ClassificationSystemVersionModel systemVersion, java.lang.String code) Retrieves the ClassificationClassModel in the classification system version with its unique code.
java.util.Collection<ClassificationAttributeUnitModel>	getConvertibleUnits(ClassificationAttributeUnitModel attributeUnit) Retrieves all other unites of the same type in the system version for the specific attribute unit.
java.util.Collection<ClassificationClassModel>	getRootClassesForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all root ClassificationClassModels in the classification system version.
ClassificationSystemModel	getSystemForId(java.lang.String id) Retrieves the ClassificationSystemModel with the specified id.
ClassificationSystemVersionModel	getSystemVersion(java.lang.String systemId, java.lang.String systemVersion) Retrieves the ClassificationSystemVersionModel with the specified systemId and versionName.
java.util.Collection<ClassificationAttributeUnitModel>	getUnitsOfTypeForSystemVersion(ClassificationSystemVersionModel systemVersion, java.lang.String type) Retrieves all ClassificationAttributeUnitModels in the classification system version with the specific type.
java.util.Collection<java.lang.String>	getUnitTypesForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all unit types of the ClassificationAttributeUnitModels in the classification system version.

Method Detail

getSystemForId

ClassificationSystemModel getSystemForId(java.lang.String id)

Retrieves the ClassificationSystemModel with the specified id.

Parameters:

id - the id of the classification system

Returns:

the found ClassificationSystemModel.

Throws:

UnknownIdentifierException - if no ClassificationSystem with the specified id can be found.

AmbiguousIdentifierException - if more than one ClassificationSystem can be found with the specified id.

java.lang.IllegalArgumentException - if id is null

getSystemVersion

ClassificationSystemVersionModel getSystemVersion(java.lang.String systemId,
                                                  java.lang.String systemVersion)

Retrieves the ClassificationSystemVersionModel with the specified systemId and versionName.

Parameters:

systemId - the id of the classification system

systemVersion - the version of the classification system version

Returns:

the found ClassificationSystemVersionModel

Throws:

UnknownIdentifierException - if no ClassificationSystemVersion with the specified system id and version exists

AmbiguousIdentifierException - if more than one ClassificationSystemVersionModel can be found with the specified system id and version

java.lang.IllegalArgumentException - if systemId or systemVersion is null

getClassForCode

ClassificationClassModel getClassForCode(ClassificationSystemVersionModel systemVersion,
                                         java.lang.String code)

Retrieves the ClassificationClassModel in the classification system version with its unique code.

Parameters:

systemVersion - the classification system version of the classification class

code - the code of the classification class

Returns:

the found ClassificationClassModel

Throws:

UnknownIdentifierException - if no classification class in the system version with the code exists

AmbiguousIdentifierException - if more than one classification class can be found in the specified system version with the code

java.lang.IllegalArgumentException - if systemVersion or code is null

getAttributeForCode

ClassificationAttributeModel getAttributeForCode(ClassificationSystemVersionModel systemVersion,
                                                 java.lang.String code)

Retrieves the ClassificationAttributeModel in the classification system version with the code.

Parameters:

systemVersion - the classification system version of the classification attribute

code - the code of the classification attribute

Returns:

the found ClassificationAttributeModel

Throws:

UnknownIdentifierException - if no classification attribute in the system version with the code exists

AmbiguousIdentifierException - if more than one classification attribute can be found in the specified system version with the code

java.lang.IllegalArgumentException - if systemVersion or code is null

getAttributeValueForCode

ClassificationAttributeValueModel getAttributeValueForCode(ClassificationSystemVersionModel systemVersion,
                                                           java.lang.String code)

Retrieves the ClassificationAttributeValueModel in the classification system version with the code.

Parameters:

systemVersion - the classification system version of the classification attribute value

code - the code of the classification attribute value

Returns:

the found ClassificationAttributeValueModel

Throws:

UnknownIdentifierException - if no classification attribute value in the system version with the code exists

AmbiguousIdentifierException - if more than one classification attribute value can be found in the specified system version with the code

java.lang.IllegalArgumentException - if systemVersion or code is null

getConvertibleUnits

java.util.Collection<ClassificationAttributeUnitModel> getConvertibleUnits(ClassificationAttributeUnitModel attributeUnit)

Retrieves all other unites of the same type in the system version for the specific attribute unit.

Parameters:

attributeUnit - the classification attribute unit which has convertible units

Returns:

all OTHER ClassificationAttributeUnitModels that have the same type and in the same system version

Throws:

java.lang.IllegalArgumentException - if attributeUnit is null

getAttributeUnitForCode

ClassificationAttributeUnitModel getAttributeUnitForCode(ClassificationSystemVersionModel systemVersion,
                                                         java.lang.String code)

Retrieves the ClassificationAttributeUnitModel in the classification system version with the code.

Parameters:

systemVersion - the classification system version of the classification attribute unit

code - the code of the classification attribute unit

Returns:

the found ClassificationAttributeUnitModel

Throws:

UnknownIdentifierException - if no classification attribute unit in the system version with the code exists

AmbiguousIdentifierException - if more than one classification attribute unit can be found in the specified system version with the code

java.lang.IllegalArgumentException - if systemVersion or code is null

getAttributeUnitsForSystemVersion

java.util.Collection<ClassificationAttributeUnitModel> getAttributeUnitsForSystemVersion(ClassificationSystemVersionModel systemVersion)

Retrieves all ClassificationAttributeUnitModels in the classification system version.

Parameters:

systemVersion - the classification system version that contains the classification attribute units

Returns:

the collection of all found ClassificationAttributeUnitModels

Throws:

java.lang.IllegalArgumentException - if systemVersion is null

getUnitsOfTypeForSystemVersion

java.util.Collection<ClassificationAttributeUnitModel> getUnitsOfTypeForSystemVersion(ClassificationSystemVersionModel systemVersion,
                                                                                      java.lang.String type)

Retrieves all ClassificationAttributeUnitModels in the classification system version with the specific type.

Parameters:

systemVersion - the classification system version that contains the classification attribute units

type - unit type of the classification attribute units

Returns:

the collection of all found ClassificationAttributeUnitModels

Throws:

java.lang.IllegalArgumentException - if systemVersion or type is null

getUnitTypesForSystemVersion

java.util.Collection<java.lang.String> getUnitTypesForSystemVersion(ClassificationSystemVersionModel systemVersion)

Retrieves all unit types of the ClassificationAttributeUnitModels in the classification system version.

Parameters:

systemVersion - the classification system version that contains the classification attribute units

Returns:

the collection of all unit types

Throws:

java.lang.IllegalArgumentException - if systemVersion is null

getRootClassesForSystemVersion

java.util.Collection<ClassificationClassModel> getRootClassesForSystemVersion(ClassificationSystemVersionModel systemVersion)

Retrieves all root ClassificationClassModels in the classification system version.

Parameters:

systemVersion - the classification system version that contains the root classification attribute classes

Returns:

the collection of all found root ClassificationClassModels

Throws:

java.lang.IllegalArgumentException - if systemVersion is null