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 TypeMethodDescriptiongetAttributeForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeModelin the classification system version with the code.getAttributeUnitForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeUnitModelin the classification system version with the code.Retrieves allClassificationAttributeUnitModels in the classification system version.getAttributeValueForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeValueModelin the classification system version with the code.getClassForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationClassModelin the classification system version with its unique code.getConvertibleUnits(ClassificationAttributeUnitModel attributeUnit) Retrieves all other unites of the same type in the system version for the specific attribute unit.getRootClassesForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all rootClassificationClassModels in the classification system version.getSystemForId(String id) Retrieves theClassificationSystemModelwith the specifiedid.getSystemVersion(String systemId, String systemVersion) getUnitsOfTypeForSystemVersion(ClassificationSystemVersionModel systemVersion, String type) Retrieves allClassificationAttributeUnitModels in the classification system version with the specific type.getUnitTypesForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all unit types of theClassificationAttributeUnitModels in the classification system version.
-
Method Details
-
getSystemForId
Retrieves theClassificationSystemModelwith the specifiedid.- Parameters:
id- the id of the classification system- Returns:
- the found
ClassificationSystemModel. - Throws:
UnknownIdentifierException- if no ClassificationSystem with the specifiedidcan be found.AmbiguousIdentifierException- if more than one ClassificationSystem can be found with the specifiedid.IllegalArgumentException- ifidisnull
-
getSystemVersion
- Parameters:
systemId- the id of the classification systemsystemVersion- the version of the classification system version- Returns:
- the found
ClassificationSystemVersionModel - Throws:
UnknownIdentifierException- if no ClassificationSystemVersion with the specified system id and version existsAmbiguousIdentifierException- if more than one ClassificationSystemVersionModel can be found with the specified system id and versionIllegalArgumentException- ifsystemIdorsystemVersionisnull
-
getClassForCode
ClassificationClassModel getClassForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationClassModelin the classification system version with its unique code.- Parameters:
systemVersion- the classification system version of the classification classcode- the code of the classification class- Returns:
- the found
ClassificationClassModel - Throws:
UnknownIdentifierException- if no classification class in the system version with the code existsAmbiguousIdentifierException- if more than one classification class can be found in the specified system version with the codeIllegalArgumentException- ifsystemVersionorcodeisnull
-
getAttributeForCode
ClassificationAttributeModel getAttributeForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeModelin the classification system version with the code.- Parameters:
systemVersion- the classification system version of the classification attributecode- the code of the classification attribute- Returns:
- the found
ClassificationAttributeModel - Throws:
UnknownIdentifierException- if no classification attribute in the system version with the code existsAmbiguousIdentifierException- if more than one classification attribute can be found in the specified system version with the codeIllegalArgumentException- ifsystemVersionorcodeisnull
-
getAttributeValueForCode
ClassificationAttributeValueModel getAttributeValueForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeValueModelin the classification system version with the code.- Parameters:
systemVersion- the classification system version of the classification attribute valuecode- 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 existsAmbiguousIdentifierException- if more than one classification attribute value can be found in the specified system version with the codeIllegalArgumentException- ifsystemVersionorcodeisnull
-
getConvertibleUnits
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:
IllegalArgumentException- ifattributeUnitisnull
-
getAttributeUnitForCode
ClassificationAttributeUnitModel getAttributeUnitForCode(ClassificationSystemVersionModel systemVersion, String code) Retrieves theClassificationAttributeUnitModelin the classification system version with the code.- Parameters:
systemVersion- the classification system version of the classification attribute unitcode- 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 existsAmbiguousIdentifierException- if more than one classification attribute unit can be found in the specified system version with the codeIllegalArgumentException- ifsystemVersionorcodeisnull
-
getAttributeUnitsForSystemVersion
Collection<ClassificationAttributeUnitModel> getAttributeUnitsForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves allClassificationAttributeUnitModels 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:
IllegalArgumentException- ifsystemVersionisnull
-
getUnitsOfTypeForSystemVersion
Collection<ClassificationAttributeUnitModel> getUnitsOfTypeForSystemVersion(ClassificationSystemVersionModel systemVersion, String type) Retrieves allClassificationAttributeUnitModels in the classification system version with the specific type.- Parameters:
systemVersion- the classification system version that contains the classification attribute unitstype- unit type of the classification attribute units- Returns:
- the collection of all found
ClassificationAttributeUnitModels - Throws:
IllegalArgumentException- ifsystemVersionortypeisnull
-
getUnitTypesForSystemVersion
Retrieves all unit types of theClassificationAttributeUnitModels 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:
IllegalArgumentException- ifsystemVersionisnull
-
getRootClassesForSystemVersion
Collection<ClassificationClassModel> getRootClassesForSystemVersion(ClassificationSystemVersionModel systemVersion) Retrieves all rootClassificationClassModels 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:
IllegalArgumentException- ifsystemVersionisnull
-