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

Class MaterialStock

java.lang.Object

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

com.sap.cloud.sdk.s4hana.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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MaterialStock.MaterialStockBuilder

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addMatlStkInAcctMod(MatlStkInAcctMod... entity) Adds elements to the list of associated MatlStkInAcctMod entities.
static MaterialStock.MaterialStockBuilder	builder()
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.
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
String	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 40
String	getMaterialBaseUnit() Constraints: Not nullable, Maximum length: 3
List<MatlStkInAcctMod>	getMatlStkInAcctModOrFetch() Retrieval of associated MatlStkInAcctMod entities (one to many).
com.google.common.base.Optional<List<MatlStkInAcctMod>>	getMatlStkInAcctModOrNull() Retrieval of associated MatlStkInAcctMod entities (one to many).
Class<MaterialStock>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
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.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

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,
                     @Nullable
                     ErpConfigContext erpConfigContext,
                     List<MatlStkInAcctMod> toMatlStkInAcctMod)

Method Detail

getType

public Class<MaterialStock> getType()

Specified by:

getType in class VdmObject<MaterialStock>

Returns:

The class of this object.

field

public static <T> MaterialStockField<T> field(String fieldName,
                                              Class<T> fieldType)

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

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.

fetchMatlStkInAcctMod

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

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

Retrieval of associated MatlStkInAcctMod entities (one to many).

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.

getMatlStkInAcctModOrNull

public com.google.common.base.Optional<List<MatlStkInAcctMod>> getMatlStkInAcctModOrNull()

Retrieval of associated MatlStkInAcctMod entities (one to many).

If the navigation property to_MatlStkInAcctMod for an entity MaterialStock has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_MatlStkInAcctMod is already loaded, the result will contain the MatlStkInAcctMod entities. If not, a null value state 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.

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

Returns:

Material Number

getMaterialBaseUnit

@Nullable
public String getMaterialBaseUnit()

Constraints: Not nullable, Maximum length: 3

Returns:

Base Unit of Measure

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

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

setMaterial

public void setMaterial(@Nullable
                        String material)

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

Parameters:

material -

setMaterialBaseUnit

public void setMaterialBaseUnit(@Nullable
                                String materialBaseUnit)

Constraints: Not nullable, Maximum length: 3

Parameters:

materialBaseUnit -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<MaterialStock>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaterialStock>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaterialStock>