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

Class BOMItemCategory

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.orderbillofmaterial.BOMItemCategory

public class BOMItemCategory
extends VdmEntity<BOMItemCategory>

Item Category

Original entity name from the Odata EDM: A_BOMItemCategoryType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static BOMItemCategorySelectable	ALL_FIELDS Selector for all available fields of BOMItemCategory.
static BOMItemCategoryField<String>	BILL_OF_MATERIAL_ITEM_CATEGORY Use with available fluent helpers to apply the BillOfMaterialItemCategory field to query operations.
static BOMItemCategoryField<String>	BILL_OF_MATERIAL_ITEM_CATEGORY_DESC Use with available fluent helpers to apply the BillOfMaterialItemCategoryDesc field to query operations.
static BOMItemCategoryField<String>	FIXED_ITEM_CATEGORY Use with available fluent helpers to apply the FixedItemCategory field to query operations.
static BOMItemCategoryOneToOneLink<BOMItemCategoryText>	TO_BOM_ITEM_CATEGORY_TEXT Use with available fluent helpers to apply the to_BOMItemCategoryText navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
BOMItemCategory()
BOMItemCategory(String billOfMaterialItemCategory, String fixedItemCategory, String billOfMaterialItemCategoryDesc, BOMItemCategoryText toBOMItemCategoryText)

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 BOMItemCategory.BOMItemCategoryBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BOMItemCategoryText	fetchBOMItemCategoryText() Fetches the BOMItemCategoryText entity (one to one) associated with this entity.
static <T> BOMItemCategoryField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> BOMItemCategoryField<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	getBillOfMaterialItemCategory() (Key Field) Constraints: Not nullable, Maximum length: 1
String	getBillOfMaterialItemCategoryDesc() Constraints: Not nullable, Maximum length: 30
io.vavr.control.Option<BOMItemCategoryText>	getBOMItemCategoryTextIfPresent() Retrieval of associated BOMItemCategoryText entity (one to one).
BOMItemCategoryText	getBOMItemCategoryTextOrFetch() Retrieval of associated BOMItemCategoryText 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.
String	getFixedItemCategory() Constraints: Not nullable, Maximum length: 1
protected Map<String,Object>	getKey()
Class<BOMItemCategory>	getType()
int	hashCode()
void	setBillOfMaterialItemCategory(String billOfMaterialItemCategory) (Key Field) Constraints: Not nullable, Maximum length: 1
void	setBillOfMaterialItemCategoryDesc(String billOfMaterialItemCategoryDesc) Constraints: Not nullable, Maximum length: 30
void	setBOMItemCategoryText(BOMItemCategoryText value) Overwrites the associated BOMItemCategoryText entity for the loaded navigation property to_BOMItemCategoryText.
void	setFixedItemCategory(String fixedItemCategory) Constraints: Not nullable, Maximum length: 1
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 BOMItemCategorySelectable ALL_FIELDS

Selector for all available fields of BOMItemCategory.

BILL_OF_MATERIAL_ITEM_CATEGORY

public static final BOMItemCategoryField<String> BILL_OF_MATERIAL_ITEM_CATEGORY

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

FIXED_ITEM_CATEGORY

public static final BOMItemCategoryField<String> FIXED_ITEM_CATEGORY

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

BILL_OF_MATERIAL_ITEM_CATEGORY_DESC

public static final BOMItemCategoryField<String> BILL_OF_MATERIAL_ITEM_CATEGORY_DESC

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

TO_BOM_ITEM_CATEGORY_TEXT

public static final BOMItemCategoryOneToOneLink<BOMItemCategoryText> TO_BOM_ITEM_CATEGORY_TEXT

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

Constructor Detail

BOMItemCategory

public BOMItemCategory()

BOMItemCategory

public BOMItemCategory(@Nullable
                       String billOfMaterialItemCategory,
                       @Nullable
                       String fixedItemCategory,
                       @Nullable
                       String billOfMaterialItemCategoryDesc,
                       @Nullable
                       BOMItemCategoryText toBOMItemCategoryText)

Method Detail

getType

@Nonnull
public Class<BOMItemCategory> getType()

Specified by:

getType in class VdmObject<BOMItemCategory>

Returns:

The class of this object.

setBillOfMaterialItemCategory

public void setBillOfMaterialItemCategory(@Nullable
                                          String billOfMaterialItemCategory)

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

Original property name from the Odata EDM: BillOfMaterialItemCategory

This categorization allows you to process data that is relevant to the individual items in a BOM. The item category is used to control field selection, default values for BOM maintenance, triggering of specific system activities, and so on.Stock itemThis item category is used to manage material data that allows an item to be kept in stock.Document itemThis item category is used to manage document data that allows you to process original application data (for example, graphics created with a graphics program).Class item (for configurable BOMs)In configurable material BOMs, you can enter a class as a placeholder for selectable items. The class can contain either materials or documents.When you assign characteristic values while configuring the BOM, the system replaces the node with an object that has the same values as those assigned to the characteristic of the configuration. This makes BOMs with a larger number of variants easier to maintain, as you do not have to enter all items manually and assign a selection condition to them.Class items can be relevant to MRP.PM structure elementThis item is used to structure an equipment (PM assembly) for design purposes only.If you want to maintain a material for use as a PM structure element, use material type IBAU.

Parameters:

billOfMaterialItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

setFixedItemCategory

public void setFixedItemCategory(@Nullable
                                 String fixedItemCategory)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: FixedItemCategory

This categorization allows you to process data that is relevant to the individual items in a BOM. The item category is used to control field selection, default values for BOM maintenance, triggering of specific system activities, and so on.Stock itemThis item category is used to manage material data that allows an item to be kept in stock.Document itemThis item category is used to manage document data that allows you to process original application data (for example, graphics created with a graphics program).Class item (for configurable BOMs)In configurable material BOMs, you can enter a class as a placeholder for selectable items. The class can contain either materials or documents.When you assign characteristic values while configuring the BOM, the system replaces the node with an object that has the same values as those assigned to the characteristic of the configuration. This makes BOMs with a larger number of variants easier to maintain, as you do not have to enter all items manually and assign a selection condition to them.Class items can be relevant to MRP.PM structure elementThis item is used to structure an equipment (PM assembly) for design purposes only.If you want to maintain a material for use as a PM structure element, use material type IBAU.

Parameters:

fixedItemCategory - Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

setBillOfMaterialItemCategoryDesc

public void setBillOfMaterialItemCategoryDesc(@Nullable
                                              String billOfMaterialItemCategoryDesc)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BillOfMaterialItemCategoryDesc

Example:L - Stock itemR - Variable-size item

Parameters:

billOfMaterialItemCategoryDesc - Description of the item category.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<BOMItemCategory>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<BOMItemCategory>

fromMap

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

Overrides:

fromMap in class VdmObject<BOMItemCategory>

field

@Nonnull
public static <T> BOMItemCategoryField<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> BOMItemCategoryField<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<BOMItemCategory>

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

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

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

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

fetchBOMItemCategoryText

@Nullable
public BOMItemCategoryText fetchBOMItemCategoryText()
                                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBOMItemCategoryTextOrFetch

@Nullable
public BOMItemCategoryText getBOMItemCategoryTextOrFetch()
                                                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BOMItemCategoryText entity (one to one). This corresponds to the OData navigation property to_BOMItemCategoryText.

If the navigation property to_BOMItemCategoryText of a queried BOMItemCategory 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 BOMItemCategoryText 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.

getBOMItemCategoryTextIfPresent

@Nonnull
public io.vavr.control.Option<BOMItemCategoryText> getBOMItemCategoryTextIfPresent()

Retrieval of associated BOMItemCategoryText entity (one to one). This corresponds to the OData navigation property to_BOMItemCategoryText.

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

setBOMItemCategoryText

public void setBOMItemCategoryText(BOMItemCategoryText value)

Overwrites the associated BOMItemCategoryText entity for the loaded navigation property to_BOMItemCategoryText.

Parameters:

value - New BOMItemCategoryText entity.

builder

@Nonnull
public static BOMItemCategory.BOMItemCategoryBuilder builder()

getBillOfMaterialItemCategory

@Nullable
public String getBillOfMaterialItemCategory()

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

Original property name from the Odata EDM: BillOfMaterialItemCategory

This categorization allows you to process data that is relevant to the individual items in a BOM. The item category is used to control field selection, default values for BOM maintenance, triggering of specific system activities, and so on.Stock itemThis item category is used to manage material data that allows an item to be kept in stock.Document itemThis item category is used to manage document data that allows you to process original application data (for example, graphics created with a graphics program).Class item (for configurable BOMs)In configurable material BOMs, you can enter a class as a placeholder for selectable items. The class can contain either materials or documents.When you assign characteristic values while configuring the BOM, the system replaces the node with an object that has the same values as those assigned to the characteristic of the configuration. This makes BOMs with a larger number of variants easier to maintain, as you do not have to enter all items manually and assign a selection condition to them.Class items can be relevant to MRP.PM structure elementThis item is used to structure an equipment (PM assembly) for design purposes only.If you want to maintain a material for use as a PM structure element, use material type IBAU.

Returns:

Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

getFixedItemCategory

@Nullable
public String getFixedItemCategory()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: FixedItemCategory

This categorization allows you to process data that is relevant to the individual items in a BOM. The item category is used to control field selection, default values for BOM maintenance, triggering of specific system activities, and so on.Stock itemThis item category is used to manage material data that allows an item to be kept in stock.Document itemThis item category is used to manage document data that allows you to process original application data (for example, graphics created with a graphics program).Class item (for configurable BOMs)In configurable material BOMs, you can enter a class as a placeholder for selectable items. The class can contain either materials or documents.When you assign characteristic values while configuring the BOM, the system replaces the node with an object that has the same values as those assigned to the characteristic of the configuration. This makes BOMs with a larger number of variants easier to maintain, as you do not have to enter all items manually and assign a selection condition to them.Class items can be relevant to MRP.PM structure elementThis item is used to structure an equipment (PM assembly) for design purposes only.If you want to maintain a material for use as a PM structure element, use material type IBAU.

Returns:

Categorization of the items in a BOM according to set criteria, such as whether they refer to an object (for example, material master or document info record) or whether they are kept in stock.

getBillOfMaterialItemCategoryDesc

@Nullable
public String getBillOfMaterialItemCategoryDesc()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BillOfMaterialItemCategoryDesc

Example:L - Stock itemR - Variable-size item

Returns:

Description of the item category.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<BOMItemCategory>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<BOMItemCategory>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<BOMItemCategory>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BOMItemCategory>