com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting

Class BaseUnit

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<BaseUnit>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.BaseUnit

public class BaseUnit
extends VdmEntity<BaseUnit>

Unit of Measure

Original entity name from the Odata EDM: BaseUnitType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseUnit.BaseUnitBuilder Helper class to allow for fluent creation of BaseUnit instances.

Field Summary

Fields

Modifier and Type	Field and Description
static BaseUnitSelectable	ALL_FIELDS Selector for all available fields of BaseUnit.
static BaseUnitLink<BaseUnitText>	TO_CNSLDTN_BASE_UNIT_T Use with available fluent helpers to apply the to_CnsldtnBaseUnitT navigation property to query operations.
static BaseUnitField<String>	UNIT_OF_MEASURE Use with available fluent helpers to apply the UnitOfMeasure field to query operations.
static BaseUnitField<Short>	UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS Use with available fluent helpers to apply the UnitOfMeasureDspNmbrOfDcmls field to query operations.
static BaseUnitField<String>	UNIT_OF_MEASURE_ISO_CODE Use with available fluent helpers to apply the UnitOfMeasureISOCode field to query operations.
static BaseUnitField<Short>	UNIT_OF_MEASURE_NUMBER_OF_DECIMALS Use with available fluent helpers to apply the UnitOfMeasureNumberOfDecimals field to query operations.
static BaseUnitField<String>	UNIT_OF_MEASURE_TEXT Use with available fluent helpers to apply the UnitOfMeasure_Text field to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BaseUnit()
BaseUnit(String unitOfMeasure, String unitOfMeasure_Text, String unitOfMeasureISOCode, Short unitOfMeasureNumberOfDecimals, Short unitOfMeasureDspNmbrOfDcmls, List<BaseUnitText> toCnsldtnBaseUnitT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnBaseUnitT(BaseUnitText... entity) Adds elements to the list of associated BaseUnitText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BaseUnit.BaseUnitBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<BaseUnitText>	fetchCnsldtnBaseUnitT() Fetches the BaseUnitText entities (one to many) associated with this entity.
static <T> BaseUnitField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BaseUnitField<T>	field(String fieldName, TypeConverter<T,DomainT> typeConverter) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
io.vavr.control.Option<List<BaseUnitText>>	getCnsldtnBaseUnitTIfPresent() Retrieval of associated BaseUnitText entities (one to many).
List<BaseUnitText>	getCnsldtnBaseUnitTOrFetch() Retrieval of associated BaseUnitText entities (one to many).
protected String	getDefaultServicePath()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
Class<BaseUnit>	getType()
String	getUnitOfMeasure_Text() Constraints: Not nullable, Maximum length: 10
String	getUnitOfMeasure() (Key Field) Constraints: Not nullable, Maximum length: 3
Short	getUnitOfMeasureDspNmbrOfDcmls() Constraints: none
String	getUnitOfMeasureISOCode() Constraints: Not nullable, Maximum length: 3
Short	getUnitOfMeasureNumberOfDecimals() Constraints: none
int	hashCode()
void	setCnsldtnBaseUnitT(List<BaseUnitText> value) Overwrites the list of associated BaseUnitText entities for the loaded navigation property to_CnsldtnBaseUnitT.
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setUnitOfMeasure_Text(String unitOfMeasure_Text) Constraints: Not nullable, Maximum length: 10
void	setUnitOfMeasure(String unitOfMeasure) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setUnitOfMeasureDspNmbrOfDcmls(Short unitOfMeasureDspNmbrOfDcmls) Constraints: none
void	setUnitOfMeasureISOCode(String unitOfMeasureISOCode) Constraints: Not nullable, Maximum length: 3
void	setUnitOfMeasureNumberOfDecimals(Short unitOfMeasureNumberOfDecimals) Constraints: none
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmObject

getChangedFields, getCustomField, getCustomField, getCustomFieldNames, getCustomFields, getSetOfCustomFields, getSetOfFields, getSetOfNavigationProperties, hasCustomField, hasCustomField, rememberChangedField, resetChangedFields, setCustomField, setCustomField, toMap, toMapOfCustomFields

Methods inherited from class java.lang.Object

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

Field Detail

ALL_FIELDS

public static final BaseUnitSelectable ALL_FIELDS

Selector for all available fields of BaseUnit.

UNIT_OF_MEASURE

public static final BaseUnitField<String> UNIT_OF_MEASURE

Use with available fluent helpers to apply the UnitOfMeasure field to query operations.

UNIT_OF_MEASURE_TEXT

public static final BaseUnitField<String> UNIT_OF_MEASURE_TEXT

Use with available fluent helpers to apply the UnitOfMeasure_Text field to query operations.

UNIT_OF_MEASURE_ISO_CODE

public static final BaseUnitField<String> UNIT_OF_MEASURE_ISO_CODE

Use with available fluent helpers to apply the UnitOfMeasureISOCode field to query operations.

UNIT_OF_MEASURE_NUMBER_OF_DECIMALS

public static final BaseUnitField<Short> UNIT_OF_MEASURE_NUMBER_OF_DECIMALS

Use with available fluent helpers to apply the UnitOfMeasureNumberOfDecimals field to query operations.

UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS

public static final BaseUnitField<Short> UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS

Use with available fluent helpers to apply the UnitOfMeasureDspNmbrOfDcmls field to query operations.

TO_CNSLDTN_BASE_UNIT_T

public static final BaseUnitLink<BaseUnitText> TO_CNSLDTN_BASE_UNIT_T

Use with available fluent helpers to apply the to_CnsldtnBaseUnitT navigation property to query operations.

Constructor Detail

BaseUnit

public BaseUnit()

BaseUnit

public BaseUnit(@Nullable
                String unitOfMeasure,
                @Nullable
                String unitOfMeasure_Text,
                @Nullable
                String unitOfMeasureISOCode,
                @Nullable
                Short unitOfMeasureNumberOfDecimals,
                @Nullable
                Short unitOfMeasureDspNmbrOfDcmls,
                List<BaseUnitText> toCnsldtnBaseUnitT)

Method Detail

getType

@Nonnull
public Class<BaseUnit> getType()

Specified by:

getType in class VdmObject<BaseUnit>

Returns:

The class of this object.

setUnitOfMeasure

public void setUnitOfMeasure(@Nullable
                             String unitOfMeasure)

(Key Field) Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasure

This format is used for internal processing.The internal format is automatically replaced by either the external commercial (three-character) or technical (six-character) format before output to the screen.

Parameters:

unitOfMeasure - Internal, language-independent, measurement unit format.

setUnitOfMeasure_Text

public void setUnitOfMeasure_Text(@Nullable
                                  String unitOfMeasure_Text)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: UnitOfMeasure_Text

Parameters:

unitOfMeasure_Text - Unit of measure name

setUnitOfMeasureISOCode

public void setUnitOfMeasureISOCode(@Nullable
                                    String unitOfMeasureISOCode)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasureISOCode

The ISO code is important for EDI. It is used to convert the internal SAP measurement units into standard measurement units. Data exchange via EDI requires internal measurement units to be converted into standard measurement units.A list of the current internationally agreed ISO codes can be ordered from the UN commission responsible (WP.4 Trade Facilitation Recommendations, Recommendation 20):UN Economic Commission for EuropeInformation OfficePalais des Nations1211 GenevaSwitzerlande-mail: info.ece@unece.orgor viewed directly on the Internet:http://www.unece.org/cefact/codesfortrade/codes_index.htmFor more information, see SAP Note 69063.

Parameters:

unitOfMeasureISOCode - ISO code for measurement units. An ISO code can be assigned to several internal measurement units of a dimension.

setUnitOfMeasureNumberOfDecimals

public void setUnitOfMeasureNumberOfDecimals(@Nullable
                                             Short unitOfMeasureNumberOfDecimals)

Constraints: none

Original property name from the Odata EDM: UnitOfMeasureNumberOfDecimals

Parameters:

unitOfMeasureNumberOfDecimals - Specifies the number of decimal places to which this measurement unit should be rounded.

setUnitOfMeasureDspNmbrOfDcmls

public void setUnitOfMeasureDspNmbrOfDcmls(@Nullable
                                           Short unitOfMeasureDspNmbrOfDcmls)

Constraints: none

Original property name from the Odata EDM: UnitOfMeasureDspNmbrOfDcmls

Parameters:

unitOfMeasureDspNmbrOfDcmls - This parameter determines the number of decimal places with which this measurement unit is displayed.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BaseUnit>

getKey

@Nonnull
protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<BaseUnit>

Returns:

The compound key of this object.

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<BaseUnit>

fromMap

protected void fromMap(Map<String,Object> inputValues)

Overrides:

fromMap in class VdmObject<BaseUnit>

field

@Nonnull
public static <T> BaseUnitField<T> field(@Nonnull
                                                  String fieldName,
                                                  @Nonnull
                                                  Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

Parameters:

fieldName - The name of the extension field as returned by the OData service.

fieldType - The Java type to use for the extension field when performing value comparisons.

Returns:

A representation of an extension field from this entity.

field

@Nonnull
public static <T,DomainT> BaseUnitField<T> field(@Nonnull
                                                          String fieldName,
                                                          @Nonnull
                                                          TypeConverter<T,DomainT> typeConverter)

Use with available fluent helpers to apply an extension field to query operations.

Type Parameters:

T - The type of the extension field when performing value comparisons.

DomainT - The type of the extension field as returned by the OData service.

Parameters:

typeConverter - A TypeConverter instance whose first generic type matches the Java type of the field

fieldName - The name of the extension field as returned by the OData service.

Returns:

A representation of an extension field from this entity, holding a reference to the given TypeConverter.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<BaseUnit>

Returns:

The stored destination for executing queries, or null if no such context has been set.

setServicePathForFetch

protected void setServicePathForFetch(@Nullable
                                      String servicePathForFetch)

Description copied from class: VdmEntity

The service path only used for the fetch commands of this entity.

Note: Use with caution, as this can easily break the fetch call on this entity. See the interface of the corresponding service for the default service path.

Overrides:

setServicePathForFetch in class VdmEntity<BaseUnit>

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. Also applies to any associated entities (navigation properties) that were previously fetched.

Note: Use with caution, as this can easily break the fetch calls on this entity. See the interface of the corresponding service for the default service path.

Overrides:

attachToService in class VdmEntity<BaseUnit>

Parameters:

servicePath - Optional parameter. New service path to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the service path has never been set, then the service path will be set to the default defined in the corresponding service interface.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<BaseUnit>

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<BaseUnit>

fetchCnsldtnBaseUnitT

@Nonnull
public List<BaseUnitText> fetchCnsldtnBaseUnitT()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the BaseUnitText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnBaseUnitT.

Please note: This method will not cache or persist the query results.

Returns:

List containing one or more associated BaseUnitText entities. If no entities are associated then an empty list is returned.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getCnsldtnBaseUnitTOrFetch

@Nonnull
public List<BaseUnitText> getCnsldtnBaseUnitTOrFetch()
                                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BaseUnitText entities (one to many). This corresponds to the OData navigation property to_CnsldtnBaseUnitT.

If the navigation property to_CnsldtnBaseUnitT of a queried BaseUnit is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Returns:

List of associated BaseUnitText entities.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the entity is unmanaged, i.e. it has not been retrieved using the OData VDM's services and therefore has no ERP configuration context assigned. An entity is managed if it has been either retrieved using the VDM's services or returned from the VDM's services as the result of a CREATE or UPDATE call.

getCnsldtnBaseUnitTIfPresent

@Nonnull
public io.vavr.control.Option<List<BaseUnitText>> getCnsldtnBaseUnitTIfPresent()

Retrieval of associated BaseUnitText entities (one to many). This corresponds to the OData navigation property to_CnsldtnBaseUnitT.

If the navigation property for an entity BaseUnit has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_CnsldtnBaseUnitT is already loaded, the result will contain the BaseUnitText entities. If not, an Option with result state empty is returned.

setCnsldtnBaseUnitT

public void setCnsldtnBaseUnitT(@Nonnull
                                List<BaseUnitText> value)

Overwrites the list of associated BaseUnitText entities for the loaded navigation property to_CnsldtnBaseUnitT.

If the navigation property to_CnsldtnBaseUnitT of a queried BaseUnit is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Parameters:

value - List of BaseUnitText entities.

addCnsldtnBaseUnitT

public void addCnsldtnBaseUnitT(BaseUnitText... entity)

Adds elements to the list of associated BaseUnitText entities. This corresponds to the OData navigation property to_CnsldtnBaseUnitT.

If the navigation property to_CnsldtnBaseUnitT of a queried BaseUnit is operated lazily, an ODataException can be thrown in case of an OData query error.

Please note: Lazy loading of OData entity associations is the process of asynchronous retrieval and persisting of items from a navigation property. If a lazy property is requested by the application for the first time and it has not yet been loaded, an OData query will be run in order to load the missing information and its result will get cached for future invocations.

Parameters:

entity - Array of BaseUnitText entities.

builder

public static BaseUnit.BaseUnitBuilder builder()

getUnitOfMeasure

@Nullable
public String getUnitOfMeasure()

(Key Field) Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasure

This format is used for internal processing.The internal format is automatically replaced by either the external commercial (three-character) or technical (six-character) format before output to the screen.

Returns:

Internal, language-independent, measurement unit format.

getUnitOfMeasure_Text

@Nullable
public String getUnitOfMeasure_Text()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: UnitOfMeasure_Text

Returns:

Unit of measure name

getUnitOfMeasureISOCode

@Nullable
public String getUnitOfMeasureISOCode()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasureISOCode

The ISO code is important for EDI. It is used to convert the internal SAP measurement units into standard measurement units. Data exchange via EDI requires internal measurement units to be converted into standard measurement units.A list of the current internationally agreed ISO codes can be ordered from the UN commission responsible (WP.4 Trade Facilitation Recommendations, Recommendation 20):UN Economic Commission for EuropeInformation OfficePalais des Nations1211 GenevaSwitzerlande-mail: info.ece@unece.orgor viewed directly on the Internet:http://www.unece.org/cefact/codesfortrade/codes_index.htmFor more information, see SAP Note 69063.

Returns:

ISO code for measurement units. An ISO code can be assigned to several internal measurement units of a dimension.

getUnitOfMeasureNumberOfDecimals

@Nullable
public Short getUnitOfMeasureNumberOfDecimals()

Constraints: none

Original property name from the Odata EDM: UnitOfMeasureNumberOfDecimals

Returns:

Specifies the number of decimal places to which this measurement unit should be rounded.

getUnitOfMeasureDspNmbrOfDcmls

@Nullable
public Short getUnitOfMeasureDspNmbrOfDcmls()

Constraints: none

Original property name from the Odata EDM: UnitOfMeasureDspNmbrOfDcmls

Returns:

This parameter determines the number of decimal places with which this measurement unit is displayed.

toString

public String toString()

Overrides:

toString in class VdmObject<BaseUnit>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BaseUnit>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BaseUnit>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BaseUnit>