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

Class BillOfMaterialUsage

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialsv2.BillOfMaterialUsage

public class BillOfMaterialUsage
extends VdmEntity<BillOfMaterialUsage>

API View for Bill Of Material Usage

Original entity name from the Odata EDM: A_BillOfMaterialUsageType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BillOfMaterialUsageSelectable	ALL_FIELDS Selector for all available fields of BillOfMaterialUsage.
static BillOfMaterialUsageField<String>	BILL_OF_MATERIAL_VARIANT_USAGE Use with available fluent helpers to apply the BillOfMaterialVariantUsage field to query operations.
static BillOfMaterialUsageField<String>	BILL_OF_MATERIAL_VARIANT_USAGE_DESC Use with available fluent helpers to apply the BillOfMaterialVariantUsageDesc field to query operations.
static BillOfMaterialUsageOneToOneLink<BillOfMaterialUsageText>	TO_BILL_OF_MATERIAL_USAGE_TEXT Use with available fluent helpers to apply the to_BillOfMaterialUsageText navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BillOfMaterialUsage()
BillOfMaterialUsage(String billOfMaterialVariantUsage, String billOfMaterialVariantUsageDesc, BillOfMaterialUsageText toBillOfMaterialUsageText)

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 BillOfMaterialUsage.BillOfMaterialUsageBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BillOfMaterialUsageText	fetchBillOfMaterialUsageText() Fetches the BillOfMaterialUsageText entity (one to one) associated with this entity.
static <T> BillOfMaterialUsageField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BillOfMaterialUsageField<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<BillOfMaterialUsageText>	getBillOfMaterialUsageTextIfPresent() Retrieval of associated BillOfMaterialUsageText entity (one to one).
BillOfMaterialUsageText	getBillOfMaterialUsageTextOrFetch() Retrieval of associated BillOfMaterialUsageText entity (one to one).
String	getBillOfMaterialVariantUsage() (Key Field) Constraints: Not nullable, Maximum length: 1
String	getBillOfMaterialVariantUsageDesc() Constraints: Not nullable, Maximum length: 30
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<BillOfMaterialUsage>	getType()
int	hashCode()
void	setBillOfMaterialUsageText(BillOfMaterialUsageText value) Overwrites the associated BillOfMaterialUsageText entity for the loaded navigation property to_BillOfMaterialUsageText.
void	setBillOfMaterialVariantUsage(String billOfMaterialVariantUsage) (Key Field) Constraints: Not nullable, Maximum length: 1
void	setBillOfMaterialVariantUsageDesc(String billOfMaterialVariantUsageDesc) Constraints: Not nullable, Maximum length: 30
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 BillOfMaterialUsageSelectable ALL_FIELDS

Selector for all available fields of BillOfMaterialUsage.

BILL_OF_MATERIAL_VARIANT_USAGE

public static final BillOfMaterialUsageField<String> BILL_OF_MATERIAL_VARIANT_USAGE

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

BILL_OF_MATERIAL_VARIANT_USAGE_DESC

public static final BillOfMaterialUsageField<String> BILL_OF_MATERIAL_VARIANT_USAGE_DESC

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

TO_BILL_OF_MATERIAL_USAGE_TEXT

public static final BillOfMaterialUsageOneToOneLink<BillOfMaterialUsageText> TO_BILL_OF_MATERIAL_USAGE_TEXT

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

Constructor Detail

BillOfMaterialUsage

public BillOfMaterialUsage()

BillOfMaterialUsage

public BillOfMaterialUsage(@Nullable
                           String billOfMaterialVariantUsage,
                           @Nullable
                           String billOfMaterialVariantUsageDesc,
                           @Nullable
                           BillOfMaterialUsageText toBillOfMaterialUsageText)

Method Detail

getType

@Nonnull
public Class<BillOfMaterialUsage> getType()

Specified by:

getType in class VdmObject<BillOfMaterialUsage>

Returns:

The class of this object.

setBillOfMaterialVariantUsage

public void setBillOfMaterialVariantUsage(@Nullable
                                          String billOfMaterialVariantUsage)

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

Original property name from the Odata EDM: BillOfMaterialVariantUsage

By setting various indicators, you can define the maximum configuration of the item status and define whether an item must be or cannot be processed in a particular area (such as production).A material is used in the areas production and costing in a company. For each area, you maintain a separate BOM with different items:Production BOM:This BOM contains items that are relevant to production. These items are copied to the planned order. Dependent requirements are generated for them, and they are copied to the production order.Costing BOM:This BOM contains items that are relevant to determining the material costs of a product.When you calculate production costs using a quantity structure, the system automatically determines the BOM and all the BOM items that are relevant to costing, in order to calculate manufacturing costs.

Parameters:

billOfMaterialVariantUsage - This key defines the area (such as engineering/design or production) where a BOM can be used.

setBillOfMaterialVariantUsageDesc

public void setBillOfMaterialVariantUsageDesc(@Nullable
                                              String billOfMaterialVariantUsageDesc)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BillOfMaterialVariantUsageDesc

Parameters:

billOfMaterialVariantUsageDesc - This text describes the key for the BOM usage, which represents the specific company organizational area in which the BOM is used (eg. engineering or production).

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BillOfMaterialUsage>

getKey

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

Overrides:

getKey in class VdmObject<BillOfMaterialUsage>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BillOfMaterialUsage>

fromMap

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

Overrides:

fromMap in class VdmObject<BillOfMaterialUsage>

field

@Nonnull
public static <T> BillOfMaterialUsageField<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> BillOfMaterialUsageField<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<BillOfMaterialUsage>

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<BillOfMaterialUsage>

fetchBillOfMaterialUsageText

@Nullable
public BillOfMaterialUsageText fetchBillOfMaterialUsageText()
                                                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBillOfMaterialUsageTextOrFetch

@Nullable
public BillOfMaterialUsageText getBillOfMaterialUsageTextOrFetch()
                                                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BillOfMaterialUsageText entity (one to one). This corresponds to the OData navigation property to_BillOfMaterialUsageText.

If the navigation property to_BillOfMaterialUsageText of a queried BillOfMaterialUsage 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 BillOfMaterialUsageText 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.

getBillOfMaterialUsageTextIfPresent

@Nonnull
public io.vavr.control.Option<BillOfMaterialUsageText> getBillOfMaterialUsageTextIfPresent()

Retrieval of associated BillOfMaterialUsageText entity (one to one). This corresponds to the OData navigation property to_BillOfMaterialUsageText.

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

setBillOfMaterialUsageText

public void setBillOfMaterialUsageText(BillOfMaterialUsageText value)

Overwrites the associated BillOfMaterialUsageText entity for the loaded navigation property to_BillOfMaterialUsageText.

Parameters:

value - New BillOfMaterialUsageText entity.

builder

public static BillOfMaterialUsage.BillOfMaterialUsageBuilder builder()

getBillOfMaterialVariantUsage

@Nullable
public String getBillOfMaterialVariantUsage()

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

Original property name from the Odata EDM: BillOfMaterialVariantUsage

By setting various indicators, you can define the maximum configuration of the item status and define whether an item must be or cannot be processed in a particular area (such as production).A material is used in the areas production and costing in a company. For each area, you maintain a separate BOM with different items:Production BOM:This BOM contains items that are relevant to production. These items are copied to the planned order. Dependent requirements are generated for them, and they are copied to the production order.Costing BOM:This BOM contains items that are relevant to determining the material costs of a product.When you calculate production costs using a quantity structure, the system automatically determines the BOM and all the BOM items that are relevant to costing, in order to calculate manufacturing costs.

Returns:

This key defines the area (such as engineering/design or production) where a BOM can be used.

getBillOfMaterialVariantUsageDesc

@Nullable
public String getBillOfMaterialVariantUsageDesc()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BillOfMaterialVariantUsageDesc

Returns:

This text describes the key for the BOM usage, which represents the specific company organizational area in which the BOM is used (eg. engineering or production).

toString

public String toString()

Overrides:

toString in class VdmObject<BillOfMaterialUsage>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BillOfMaterialUsage>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BillOfMaterialUsage>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BillOfMaterialUsage>