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

Class BaseUnitText

java.lang.Object

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

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

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

public class BaseUnitText
extends VdmEntity<BaseUnitText>

Unit of Measure Text

Original entity name from the Odata EDM: BaseUnitTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BaseUnitTextSelectable	ALL_FIELDS Selector for all available fields of BaseUnitText.
static BaseUnitTextField<String>	BASE_UNIT_TEXT Use with available fluent helpers to apply the BaseUnitText field to query operations.
static BaseUnitTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static BaseUnitTextOneToOneLink<BaseUnit>	TO_CNSLDTN_BASE_UNIT Use with available fluent helpers to apply the to_CnsldtnBaseUnit navigation property to query operations.
static BaseUnitTextField<String>	UNIT_OF_MEASURE Use with available fluent helpers to apply the UnitOfMeasure field to query operations.
static BaseUnitTextField<String>	UNIT_OF_MEASURE_E Use with available fluent helpers to apply the UnitOfMeasure_E field to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BaseUnitText()
BaseUnitText(String language, String unitOfMeasure, String baseUnitText, String unitOfMeasure_E, BaseUnit toCnsldtnBaseUnit)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static BaseUnitText.BaseUnitTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BaseUnit	fetchCnsldtnBaseUnit() Fetches the BaseUnit entity (one to one) associated with this entity.
static <T> BaseUnitTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BaseUnitTextField<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)
String	getBaseUnitText() Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<BaseUnit>	getCnsldtnBaseUnitIfPresent() Retrieval of associated BaseUnit entity (one to one).
BaseUnit	getCnsldtnBaseUnitOrFetch() Retrieval of associated BaseUnit entity (one to one).
protected String	getDefaultServicePath() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
Class<BaseUnitText>	getType()
String	getUnitOfMeasure_E() Constraints: Not nullable, Maximum length: 3
String	getUnitOfMeasure() (Key Field) Constraints: Not nullable, Maximum length: 3
int	hashCode()
void	setBaseUnitText(String baseUnitText) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnBaseUnit(BaseUnit value) Overwrites the associated BaseUnit entity for the loaded navigation property to_CnsldtnBaseUnit.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setUnitOfMeasure_E(String unitOfMeasure_E) Constraints: Not nullable, Maximum length: 3
void	setUnitOfMeasure(String unitOfMeasure) (Key Field) Constraints: Not nullable, Maximum length: 3
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 BaseUnitTextSelectable ALL_FIELDS

Selector for all available fields of BaseUnitText.

LANGUAGE

public static final BaseUnitTextField<String> LANGUAGE

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

UNIT_OF_MEASURE

public static final BaseUnitTextField<String> UNIT_OF_MEASURE

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

BASE_UNIT_TEXT

public static final BaseUnitTextField<String> BASE_UNIT_TEXT

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

UNIT_OF_MEASURE_E

public static final BaseUnitTextField<String> UNIT_OF_MEASURE_E

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

TO_CNSLDTN_BASE_UNIT

public static final BaseUnitTextOneToOneLink<BaseUnit> TO_CNSLDTN_BASE_UNIT

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

Constructor Detail

BaseUnitText

public BaseUnitText()

BaseUnitText

public BaseUnitText(@Nullable
                    String language,
                    @Nullable
                    String unitOfMeasure,
                    @Nullable
                    String baseUnitText,
                    @Nullable
                    String unitOfMeasure_E,
                    @Nullable
                    BaseUnit toCnsldtnBaseUnit)

Method Detail

getType

@Nonnull
public Class<BaseUnitText> getType()

Specified by:

getType in class VdmObject<BaseUnitText>

Returns:

The class of this object.

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setUnitOfMeasure

public void setUnitOfMeasure(@Nullable
                             String unitOfMeasure)

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

Original property name from the Odata EDM: UnitOfMeasure

Parameters:

unitOfMeasure - Base Unit

setBaseUnitText

public void setBaseUnitText(@Nullable
                            String baseUnitText)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: BaseUnitText

Parameters:

baseUnitText - Base Unit Description

setUnitOfMeasure_E

public void setUnitOfMeasure_E(@Nullable
                               String unitOfMeasure_E)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasure_E

The internal measurement units are automatically converted to this format for screen output.This format dependends on the logon language.

Parameters:

unitOfMeasure_E - Commercial measurement unit format.

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<BaseUnitText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BaseUnitText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BaseUnitText>

fromMap

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

Overrides:

fromMap in class VdmObject<BaseUnitText>

field

@Nonnull
public static <T> BaseUnitTextField<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> BaseUnitTextField<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<BaseUnitText>

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<BaseUnitText>

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<BaseUnitText>

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

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<BaseUnitText>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<BaseUnitText>

fetchCnsldtnBaseUnit

@Nullable
public BaseUnit fetchCnsldtnBaseUnit()
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the BaseUnit entity (one to one) associated with this entity. This corresponds to the OData navigation property to_CnsldtnBaseUnit.

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

Returns:

The single associated BaseUnit entity, or null if an entity is not associated.

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.

getCnsldtnBaseUnitOrFetch

@Nullable
public BaseUnit getCnsldtnBaseUnitOrFetch()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BaseUnit entity (one to one). This corresponds to the OData navigation property to_CnsldtnBaseUnit.

If the navigation property to_CnsldtnBaseUnit of a queried BaseUnitText 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 BaseUnit entity.

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.

getCnsldtnBaseUnitIfPresent

@Nonnull
public io.vavr.control.Option<BaseUnit> getCnsldtnBaseUnitIfPresent()

Retrieval of associated BaseUnit entity (one to one). This corresponds to the OData navigation property to_CnsldtnBaseUnit.

If the navigation property for an entity BaseUnitText 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_CnsldtnBaseUnit is already loaded, the result will contain the BaseUnit entity. If not, an Option with result state empty is returned.

setCnsldtnBaseUnit

public void setCnsldtnBaseUnit(BaseUnit value)

Overwrites the associated BaseUnit entity for the loaded navigation property to_CnsldtnBaseUnit.

Parameters:

value - New BaseUnit entity.

builder

public static BaseUnitText.BaseUnitTextBuilder builder()

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getUnitOfMeasure

@Nullable
public String getUnitOfMeasure()

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

Original property name from the Odata EDM: UnitOfMeasure

Returns:

Base Unit

getBaseUnitText

@Nullable
public String getBaseUnitText()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: BaseUnitText

Returns:

Base Unit Description

getUnitOfMeasure_E

@Nullable
public String getUnitOfMeasure_E()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: UnitOfMeasure_E

The internal measurement units are automatically converted to this format for screen output.This format dependends on the logon language.

Returns:

Commercial measurement unit format.

toString

public String toString()

Overrides:

toString in class VdmObject<BaseUnitText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BaseUnitText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BaseUnitText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BaseUnitText>