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

Class MaterialStock

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialstockdisplay.MaterialStock

public class MaterialStock
extends VdmEntity<MaterialStock>

API view by consuming Material Stock

Original entity name from the Odata EDM: A_MaterialStockType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialStockSelectable	ALL_FIELDS Selector for all available fields of MaterialStock.
static MaterialStockField<String>	MATERIAL Use with available fluent helpers to apply the Material field to query operations.
static MaterialStockField<String>	MATERIAL_BASE_UNIT Use with available fluent helpers to apply the MaterialBaseUnit field to query operations.
static MaterialStockLink<MatlStkInAcctMod>	TO_MATL_STK_IN_ACCT_MOD Use with available fluent helpers to apply the to_MatlStkInAcctMod navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
MaterialStock()
MaterialStock(String material, String materialBaseUnit, List<MatlStkInAcctMod> toMatlStkInAcctMod)

Method Summary

Modifier and Type	Method and Description
void	addMatlStkInAcctMod(MatlStkInAcctMod... entity) Adds elements to the list of associated MatlStkInAcctMod entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static MaterialStock.MaterialStockBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<MatlStkInAcctMod>	fetchMatlStkInAcctMod() Fetches the MatlStkInAcctMod entities (one to many) associated with this entity.
static <T> MaterialStockField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> MaterialStockField<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)
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	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 40
String	getMaterialBaseUnit() Constraints: Not nullable, Maximum length: 3
io.vavr.control.Option<List<MatlStkInAcctMod>>	getMatlStkInAcctModIfPresent() Retrieval of associated MatlStkInAcctMod entities (one to many).
List<MatlStkInAcctMod>	getMatlStkInAcctModOrFetch() Retrieval of associated MatlStkInAcctMod entities (one to many).
Class<MaterialStock>	getType()
int	hashCode()
void	setMaterial(String material) (Key Field) Constraints: Not nullable, Maximum length: 40
void	setMaterialBaseUnit(String materialBaseUnit) Constraints: Not nullable, Maximum length: 3
void	setMatlStkInAcctMod(List<MatlStkInAcctMod> value) Overwrites the list of associated MatlStkInAcctMod entities for the loaded navigation property to_MatlStkInAcctMod.
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 MaterialStockSelectable ALL_FIELDS

Selector for all available fields of MaterialStock.

MATERIAL

public static final MaterialStockField<String> MATERIAL

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

MATERIAL_BASE_UNIT

public static final MaterialStockField<String> MATERIAL_BASE_UNIT

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

TO_MATL_STK_IN_ACCT_MOD

public static final MaterialStockLink<MatlStkInAcctMod> TO_MATL_STK_IN_ACCT_MOD

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

Constructor Detail

MaterialStock

public MaterialStock()

MaterialStock

public MaterialStock(@Nullable
                     String material,
                     @Nullable
                     String materialBaseUnit,
                     List<MatlStkInAcctMod> toMatlStkInAcctMod)

Method Detail

getType

@Nonnull
public Class<MaterialStock> getType()

Specified by:

getType in class VdmObject<MaterialStock>

Returns:

The class of this object.

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.

setMaterialBaseUnit

public void setMaterialBaseUnit(@Nullable
                                String materialBaseUnit)

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: MaterialBaseUnit

You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified.

Parameters:

materialBaseUnit - Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<MaterialStock>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<MaterialStock>

fromMap

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

Overrides:

fromMap in class VdmObject<MaterialStock>

field

@Nonnull
public static <T> MaterialStockField<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> MaterialStockField<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<MaterialStock>

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

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

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

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

fetchMatlStkInAcctMod

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

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

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

Returns:

List containing one or more associated MatlStkInAcctMod 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.

getMatlStkInAcctModOrFetch

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

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

If the navigation property to_MatlStkInAcctMod of a queried MaterialStock 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 MatlStkInAcctMod 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.

getMatlStkInAcctModIfPresent

@Nonnull
public io.vavr.control.Option<List<MatlStkInAcctMod>> getMatlStkInAcctModIfPresent()

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

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

setMatlStkInAcctMod

public void setMatlStkInAcctMod(@Nonnull
                                List<MatlStkInAcctMod> value)

Overwrites the list of associated MatlStkInAcctMod entities for the loaded navigation property to_MatlStkInAcctMod.

If the navigation property to_MatlStkInAcctMod of a queried MaterialStock 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 MatlStkInAcctMod entities.

addMatlStkInAcctMod

public void addMatlStkInAcctMod(MatlStkInAcctMod... entity)

Adds elements to the list of associated MatlStkInAcctMod entities. This corresponds to the OData navigation property to_MatlStkInAcctMod.

If the navigation property to_MatlStkInAcctMod of a queried MaterialStock 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 MatlStkInAcctMod entities.

builder

public static MaterialStock.MaterialStockBuilder builder()

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.

getMaterialBaseUnit

@Nullable
public String getMaterialBaseUnit()

Constraints: Not nullable, Maximum length: 3

Original property name from the Odata EDM: MaterialBaseUnit

You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified.

Returns:

Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure.

toString

public String toString()

Overrides:

toString in class VdmObject<MaterialStock>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaterialStock>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<MaterialStock>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaterialStock>