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

Class SoldProduct

java.lang.Object

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

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity<SoldProduct>

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

public class SoldProduct
extends VdmEntity<SoldProduct>

Consolidation - Combined Product Sold

Original entity name from the Odata EDM: SoldProductType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SoldProductField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static SoldProductSelectable	ALL_FIELDS Selector for all available fields of SoldProduct.
static SoldProductField<String>	MATERIAL Use with available fluent helpers to apply the Material field to query operations.
static SoldProductField<String>	MATERIAL_TEXT Use with available fluent helpers to apply the Material_Text field to query operations.
static SoldProductLink<SoldProductHier>	TO_CNSLDTN_PRODUCT_SOLD_HIER Use with available fluent helpers to apply the to_CnsldtnProductSoldHier navigation property to query operations.
static SoldProductLink<SoldProductText>	TO_CNSLDTN_PRODUCT_SOLD_T Use with available fluent helpers to apply the to_CnsldtnProductSoldT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
SoldProduct()
SoldProduct(String material, String material_Text, String additionalMasterDataSource, List<SoldProductHier> toCnsldtnProductSoldHier, List<SoldProductText> toCnsldtnProductSoldT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnProductSoldHier(SoldProductHier... entity) Adds elements to the list of associated SoldProductHier entities.
void	addCnsldtnProductSoldT(SoldProductText... entity) Adds elements to the list of associated SoldProductText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static SoldProduct.SoldProductBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<SoldProductHier>	fetchCnsldtnProductSoldHier() Fetches the SoldProductHier entities (one to many) associated with this entity.
List<SoldProductText>	fetchCnsldtnProductSoldT() Fetches the SoldProductText entities (one to many) associated with this entity.
static <T> SoldProductField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SoldProductField<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
Optional<List<SoldProductHier>>	getCnsldtnProductSoldHierIfPresent() Retrieval of associated SoldProductHier entities (one to many).
List<SoldProductHier>	getCnsldtnProductSoldHierOrFetch() Retrieval of associated SoldProductHier entities (one to many).
Optional<List<SoldProductText>>	getCnsldtnProductSoldTIfPresent() Retrieval of associated SoldProductText entities (one to many).
List<SoldProductText>	getCnsldtnProductSoldTOrFetch() Retrieval of associated SoldProductText entities (one to many).
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
String	getMaterial_Text() Constraints: Not nullable, Maximum length: 40
String	getMaterial() (Key Field) Constraints: Not nullable, Maximum length: 40
Class<SoldProduct>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnProductSoldHier(List<SoldProductHier> value) Overwrites the list of associated SoldProductHier entities for the loaded navigation property to_CnsldtnProductSoldHier.
void	setCnsldtnProductSoldT(List<SoldProductText> value) Overwrites the list of associated SoldProductText entities for the loaded navigation property to_CnsldtnProductSoldT.
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setMaterial_Text(String material_Text) Constraints: Not nullable, Maximum length: 40
void	setMaterial(String material) (Key Field) Constraints: Not nullable, Maximum length: 40
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.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 SoldProductSelectable ALL_FIELDS

Selector for all available fields of SoldProduct.

MATERIAL

public static final SoldProductField<String> MATERIAL

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

MATERIAL_TEXT

public static final SoldProductField<String> MATERIAL_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final SoldProductField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_PRODUCT_SOLD_HIER

public static final SoldProductLink<SoldProductHier> TO_CNSLDTN_PRODUCT_SOLD_HIER

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

TO_CNSLDTN_PRODUCT_SOLD_T

public static final SoldProductLink<SoldProductText> TO_CNSLDTN_PRODUCT_SOLD_T

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

Constructor Detail

SoldProduct

public SoldProduct()

SoldProduct

public SoldProduct(@Nullable
                   String material,
                   @Nullable
                   String material_Text,
                   @Nullable
                   String additionalMasterDataSource,
                   List<SoldProductHier> toCnsldtnProductSoldHier,
                   List<SoldProductText> toCnsldtnProductSoldT)

Method Detail

getType

@Nonnull
public Class<SoldProduct> getType()

Specified by:

getType in class VdmObject<SoldProduct>

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.

setMaterial_Text

public void setMaterial_Text(@Nullable
                             String material_Text)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Material_Text

You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen.

Parameters:

material_Text - Text containing up to 40 characters that describes the material in more detail.

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()

Specified by:

getEntityCollection in class VdmEntity<SoldProduct>

getKey

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

Overrides:

getKey in class VdmObject<SoldProduct>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SoldProduct>

fromMap

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

Overrides:

fromMap in class VdmObject<SoldProduct>

field

@Nonnull
public static <T> SoldProductField<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> SoldProductField<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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<SoldProduct>

Returns:

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

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

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

Overrides:

setErpConfigContext in class VdmEntity<SoldProduct>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<SoldProduct>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<SoldProduct>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SoldProduct>

fetchCnsldtnProductSoldHier

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

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

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

Returns:

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

getCnsldtnProductSoldHierOrFetch

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

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

If the navigation property to_CnsldtnProductSoldHier of a queried SoldProduct 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 SoldProductHier 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.

getCnsldtnProductSoldHierIfPresent

@Nonnull
public Optional<List<SoldProductHier>> getCnsldtnProductSoldHierIfPresent()

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

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

Returns:

If the information for navigation property to_CnsldtnProductSoldHier is already loaded, the result will contain the SoldProductHier entities. If not, an Optional with result state empty is returned.

setCnsldtnProductSoldHier

public void setCnsldtnProductSoldHier(@Nonnull
                                      List<SoldProductHier> value)

Overwrites the list of associated SoldProductHier entities for the loaded navigation property to_CnsldtnProductSoldHier.

If the navigation property to_CnsldtnProductSoldHier of a queried SoldProduct 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 SoldProductHier entities.

addCnsldtnProductSoldHier

public void addCnsldtnProductSoldHier(SoldProductHier... entity)

Adds elements to the list of associated SoldProductHier entities. This corresponds to the OData navigation property to_CnsldtnProductSoldHier.

If the navigation property to_CnsldtnProductSoldHier of a queried SoldProduct 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 SoldProductHier entities.

fetchCnsldtnProductSoldT

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

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

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

Returns:

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

getCnsldtnProductSoldTOrFetch

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

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

If the navigation property to_CnsldtnProductSoldT of a queried SoldProduct 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 SoldProductText 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.

getCnsldtnProductSoldTIfPresent

@Nonnull
public Optional<List<SoldProductText>> getCnsldtnProductSoldTIfPresent()

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

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

Returns:

If the information for navigation property to_CnsldtnProductSoldT is already loaded, the result will contain the SoldProductText entities. If not, an Optional with result state empty is returned.

setCnsldtnProductSoldT

public void setCnsldtnProductSoldT(@Nonnull
                                   List<SoldProductText> value)

Overwrites the list of associated SoldProductText entities for the loaded navigation property to_CnsldtnProductSoldT.

If the navigation property to_CnsldtnProductSoldT of a queried SoldProduct 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 SoldProductText entities.

addCnsldtnProductSoldT

public void addCnsldtnProductSoldT(SoldProductText... entity)

Adds elements to the list of associated SoldProductText entities. This corresponds to the OData navigation property to_CnsldtnProductSoldT.

If the navigation property to_CnsldtnProductSoldT of a queried SoldProduct 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 SoldProductText entities.

builder

public static SoldProduct.SoldProductBuilder 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.

getMaterial_Text

@Nullable
public String getMaterial_Text()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: Material_Text

You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen.

Returns:

Text containing up to 40 characters that describes the material in more detail.

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

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SoldProduct>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SoldProduct>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SoldProduct>