UnitService (hybris Commerce Suite 2205)

All Known Implementing Classes:: DefaultUnitService

public interface UnitService

Service to read and update UnitModels.

Spring Bean ID:: unitService

Method Summary

Modifier and Type

Method

Description

Set<UnitModel>

getAllUnits()

Returns all Units.

Set<String>

getAllUnitTypes()

Returns all unit types (e.g.

UnitModel

getUnitForCode(String code)

Set<UnitModel>

getUnitsForUnitType(String unitType)

Returns all units for specific unit type

Method Details
- getUnitForCode
  
  UnitModel getUnitForCode(String code)
  
  Parameters:
  
  code - the UnitModel.CODE
  
  Returns:
  
  for the given code the UnitModel
  
  Throws:
  
  IllegalArgumentException - if code is null.
  
  UnknownIdentifierException - if no unit was found
  
  AmbiguousIdentifierException - if more than one unit was found by this code
- getAllUnits
  
  Set<UnitModel> getAllUnits()
  
  Returns all Units.
  
  Returns:
  
  a set containing all units.
- getAllUnitTypes
  
  Set<String> getAllUnitTypes()
  
  Returns all unit types (e.g. 'weight', 'size' ).
  
  Returns:
  
  a set of type strings
- getUnitsForUnitType
  
  Set<UnitModel> getUnitsForUnitType(String unitType)
  
  Returns all units for specific unit type
  
  Parameters:
  
  unitType - search only units for this unit type
  
  Returns:
  
  found units that match unit type