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

Class MaterialText

java.lang.Object

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

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

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

public class MaterialText
extends VdmEntity<MaterialText>

Consolidation - Combined Material Text

Original entity name from the Odata EDM: MaterialTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialTextSelectable	ALL_FIELDS Selector for all available fields of MaterialText.
static MaterialTextField<String>	CNSLDTN_MATERIAL_TEXT Use with available fluent helpers to apply the CnsldtnMaterialText field to query operations.
static MaterialTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static MaterialTextField<String>	MATERIAL Use with available fluent helpers to apply the Material field to query operations.
static MaterialTextOneToOneLink<Material>	TO_CNSLDTN_MATERIAL Use with available fluent helpers to apply the to_CnsldtnMaterial navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
MaterialText()
MaterialText(String language, String material, String cnsldtnMaterialText, Material toCnsldtnMaterial)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination)
static MaterialText.MaterialTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Material	fetchCnsldtnMaterial() Fetches the Material entity (one to one) associated with this entity.
static <T> MaterialTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> MaterialTextField<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<Material>	getCnsldtnMaterialIfPresent() Retrieval of associated Material entity (one to one).
Material	getCnsldtnMaterialOrFetch() Retrieval of associated Material entity (one to one).
String	getCnsldtnMaterialText() Constraints: Not nullable, Maximum length: 40
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()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 40
Class<MaterialText>	getType()
int	hashCode()
void	setCnsldtnMaterial(Material value) Overwrites the associated Material entity for the loaded navigation property to_CnsldtnMaterial.
void	setCnsldtnMaterialText(String cnsldtnMaterialText) Constraints: Not nullable, Maximum length: 40
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setMaterial(String material) (Key Field) Constraints: Not nullable, Maximum length: 40
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
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 MaterialTextSelectable ALL_FIELDS

Selector for all available fields of MaterialText.

LANGUAGE

public static final MaterialTextField<String> LANGUAGE

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

MATERIAL

public static final MaterialTextField<String> MATERIAL

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

CNSLDTN_MATERIAL_TEXT

public static final MaterialTextField<String> CNSLDTN_MATERIAL_TEXT

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

TO_CNSLDTN_MATERIAL

public static final MaterialTextOneToOneLink<Material> TO_CNSLDTN_MATERIAL

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

Constructor Detail

MaterialText

public MaterialText()

MaterialText

public MaterialText(@Nullable
                    String language,
                    @Nullable
                    String material,
                    @Nullable
                    String cnsldtnMaterialText,
                    @Nullable
                    Material toCnsldtnMaterial)

Method Detail

getType

@Nonnull
public Class<MaterialText> getType()

Specified by:

getType in class VdmObject<MaterialText>

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

setMaterial

public void setMaterial(@Nullable
                        String material)

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

Original property name from the Odata EDM: Material

Parameters:

material - Alphanumeric key uniquely identifying the material.

setCnsldtnMaterialText

public void setCnsldtnMaterialText(@Nullable
                                   String cnsldtnMaterialText)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: CnsldtnMaterialText

You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen.

Parameters:

cnsldtnMaterialText - Text containing up to 40 characters that describes the material in more detail.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<MaterialText>

getKey

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

Overrides:

getKey in class VdmObject<MaterialText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<MaterialText>

fromMap

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

Overrides:

fromMap in class VdmObject<MaterialText>

field

@Nonnull
public static <T> MaterialTextField<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> MaterialTextField<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<MaterialText>

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

attachToService

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

Overrides:

attachToService in class VdmEntity<MaterialText>

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<MaterialText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<MaterialText>

fetchCnsldtnMaterial

@Nullable
public Material fetchCnsldtnMaterial()
                                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

The single associated Material 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.

getCnsldtnMaterialOrFetch

@Nullable
public Material getCnsldtnMaterialOrFetch()
                                              throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Material entity (one to one). This corresponds to the OData navigation property to_CnsldtnMaterial.

If the navigation property to_CnsldtnMaterial of a queried MaterialText 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 Material 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.

getCnsldtnMaterialIfPresent

@Nonnull
public io.vavr.control.Option<Material> getCnsldtnMaterialIfPresent()

Retrieval of associated Material entity (one to one). This corresponds to the OData navigation property to_CnsldtnMaterial.

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

setCnsldtnMaterial

public void setCnsldtnMaterial(Material value)

Overwrites the associated Material entity for the loaded navigation property to_CnsldtnMaterial.

Parameters:

value - New Material entity.

builder

public static MaterialText.MaterialTextBuilder 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

getMaterial

@Nullable
public String getMaterial()

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

Original property name from the Odata EDM: Material

Returns:

Alphanumeric key uniquely identifying the material.

getCnsldtnMaterialText

@Nullable
public String getCnsldtnMaterialText()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: CnsldtnMaterialText

You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen.

Returns:

Text containing up to 40 characters that describes the material in more detail.

toString

public String toString()

Overrides:

toString in class VdmObject<MaterialText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaterialText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<MaterialText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaterialText>