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

Class MaterialGroup

java.lang.Object

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

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

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

public class MaterialGroup
extends VdmEntity<MaterialGroup>

Consolidation - Combined Material Group

Original entity name from the Odata EDM: MaterialGroupType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static MaterialGroupField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static MaterialGroupSelectable	ALL_FIELDS Selector for all available fields of MaterialGroup.
static MaterialGroupField<String>	MATERIAL_GROUP Use with available fluent helpers to apply the MaterialGroup field to query operations.
static MaterialGroupField<String>	MATERIAL_GROUP_TEXT Use with available fluent helpers to apply the MaterialGroup_Text field to query operations.
static MaterialGroupLink<MaterialGroupText>	TO_CNSLDTN_MATERIAL_GROUP_T Use with available fluent helpers to apply the to_CnsldtnMaterialGroupT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
MaterialGroup()
MaterialGroup(String materialGroup, String materialGroup_Text, String additionalMasterDataSource, List<MaterialGroupText> toCnsldtnMaterialGroupT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnMaterialGroupT(MaterialGroupText... entity) Adds elements to the list of associated MaterialGroupText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static MaterialGroup.MaterialGroupBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<MaterialGroupText>	fetchCnsldtnMaterialGroupT() Fetches the MaterialGroupText entities (one to many) associated with this entity.
static <T> MaterialGroupField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> MaterialGroupField<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	getAdditionalMasterDataSource() Constraints: Not nullable, Maximum length: 10
io.vavr.control.Option<List<MaterialGroupText>>	getCnsldtnMaterialGroupTIfPresent() Retrieval of associated MaterialGroupText entities (one to many).
List<MaterialGroupText>	getCnsldtnMaterialGroupTOrFetch() Retrieval of associated MaterialGroupText entities (one to many).
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	getMaterialGroup_Text() Constraints: Not nullable, Maximum length: 20
String	getMaterialGroup() (Key Field) Constraints: Not nullable, Maximum length: 9
Class<MaterialGroup>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnMaterialGroupT(List<MaterialGroupText> value) Overwrites the list of associated MaterialGroupText entities for the loaded navigation property to_CnsldtnMaterialGroupT.
void	setMaterialGroup_Text(String materialGroup_Text) Constraints: Not nullable, Maximum length: 20
void	setMaterialGroup(String materialGroup) (Key Field) Constraints: Not nullable, Maximum length: 9
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 MaterialGroupSelectable ALL_FIELDS

Selector for all available fields of MaterialGroup.

MATERIAL_GROUP

public static final MaterialGroupField<String> MATERIAL_GROUP

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

MATERIAL_GROUP_TEXT

public static final MaterialGroupField<String> MATERIAL_GROUP_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final MaterialGroupField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_MATERIAL_GROUP_T

public static final MaterialGroupLink<MaterialGroupText> TO_CNSLDTN_MATERIAL_GROUP_T

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

Constructor Detail

MaterialGroup

public MaterialGroup()

MaterialGroup

public MaterialGroup(@Nullable
                     String materialGroup,
                     @Nullable
                     String materialGroup_Text,
                     @Nullable
                     String additionalMasterDataSource,
                     List<MaterialGroupText> toCnsldtnMaterialGroupT)

Method Detail

getType

@Nonnull
public Class<MaterialGroup> getType()

Specified by:

getType in class VdmObject<MaterialGroup>

Returns:

The class of this object.

setMaterialGroup

public void setMaterialGroup(@Nullable
                             String materialGroup)

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

Original property name from the Odata EDM: MaterialGroup

You can use material groups to:Restrict the scope of analysesSearch specifically for product master records via search helpsIf you have not defined a material group hierarchy using the classification system, you maintain product groups in Customizing for the Material Master in Define material groups.If you have defined a product group hierarchy, which is normally the case in retail, you maintain product groups in Customizing for Material Groups or from the initial Retailing screen by choosing Master data -> Material group.

Parameters:

materialGroup - Key that you use to group together several products or services with the same attributes, and to assign them to a particular product group.

setMaterialGroup_Text

public void setMaterialGroup_Text(@Nullable
                                  String materialGroup_Text)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MaterialGroup_Text

Parameters:

materialGroup_Text - Material Group Description

setAdditionalMasterDataSource

public void setAdditionalMasterDataSource(@Nullable
                                          String additionalMasterDataSource)

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Parameters:

additionalMasterDataSource - Master Data Source

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<MaterialGroup>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<MaterialGroup>

fromMap

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

Overrides:

fromMap in class VdmObject<MaterialGroup>

field

@Nonnull
public static <T> MaterialGroupField<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> MaterialGroupField<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<MaterialGroup>

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

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

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

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

fetchCnsldtnMaterialGroupT

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

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

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

Returns:

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

getCnsldtnMaterialGroupTOrFetch

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

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

If the navigation property to_CnsldtnMaterialGroupT of a queried MaterialGroup 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 MaterialGroupText 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.

getCnsldtnMaterialGroupTIfPresent

@Nonnull
public io.vavr.control.Option<List<MaterialGroupText>> getCnsldtnMaterialGroupTIfPresent()

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

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

setCnsldtnMaterialGroupT

public void setCnsldtnMaterialGroupT(@Nonnull
                                     List<MaterialGroupText> value)

Overwrites the list of associated MaterialGroupText entities for the loaded navigation property to_CnsldtnMaterialGroupT.

If the navigation property to_CnsldtnMaterialGroupT of a queried MaterialGroup 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 MaterialGroupText entities.

addCnsldtnMaterialGroupT

public void addCnsldtnMaterialGroupT(MaterialGroupText... entity)

Adds elements to the list of associated MaterialGroupText entities. This corresponds to the OData navigation property to_CnsldtnMaterialGroupT.

If the navigation property to_CnsldtnMaterialGroupT of a queried MaterialGroup 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 MaterialGroupText entities.

builder

public static MaterialGroup.MaterialGroupBuilder builder()

getMaterialGroup

@Nullable
public String getMaterialGroup()

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

Original property name from the Odata EDM: MaterialGroup

You can use material groups to:Restrict the scope of analysesSearch specifically for product master records via search helpsIf you have not defined a material group hierarchy using the classification system, you maintain product groups in Customizing for the Material Master in Define material groups.If you have defined a product group hierarchy, which is normally the case in retail, you maintain product groups in Customizing for Material Groups or from the initial Retailing screen by choosing Master data -> Material group.

Returns:

Key that you use to group together several products or services with the same attributes, and to assign them to a particular product group.

getMaterialGroup_Text

@Nullable
public String getMaterialGroup_Text()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: MaterialGroup_Text

Returns:

Material Group Description

getAdditionalMasterDataSource

@Nullable
public String getAdditionalMasterDataSource()

Constraints: Not nullable, Maximum length: 10

Original property name from the Odata EDM: AdditionalMasterDataSource

Returns:

Master Data Source

toString

public String toString()

Overrides:

toString in class VdmObject<MaterialGroup>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<MaterialGroup>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<MaterialGroup>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<MaterialGroup>