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

Class Customer

java.lang.Object

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

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

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

public class Customer
extends VdmEntity<Customer>

Consolidation - Combined Customer

Original entity name from the Odata EDM: CustomerType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CustomerField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static CustomerSelectable	ALL_FIELDS Selector for all available fields of Customer.
static CustomerField<String>	CUSTOMER Use with available fluent helpers to apply the Customer field to query operations.
static CustomerField<String>	CUSTOMER_TEXT Use with available fluent helpers to apply the Customer_Text field to query operations.
static CustomerLink<CustomerHier>	TO_CNSLDTN_CUSTOMER_HIER Use with available fluent helpers to apply the to_CnsldtnCustomerHier navigation property to query operations.
static CustomerLink<CustomerText>	TO_CNSLDTN_CUSTOMER_T Use with available fluent helpers to apply the to_CnsldtnCustomerT 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
Customer()
Customer(String customer, String customer_Text, String additionalMasterDataSource, List<CustomerHier> toCnsldtnCustomerHier, List<CustomerText> toCnsldtnCustomerT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnCustomerHier(CustomerHier... entity) Adds elements to the list of associated CustomerHier entities.
void	addCnsldtnCustomerT(CustomerText... entity) Adds elements to the list of associated CustomerText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static Customer.CustomerBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<CustomerHier>	fetchCnsldtnCustomerHier() Fetches the CustomerHier entities (one to many) associated with this entity.
List<CustomerText>	fetchCnsldtnCustomerT() Fetches the CustomerText entities (one to many) associated with this entity.
static <T> CustomerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CustomerField<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<CustomerHier>>	getCnsldtnCustomerHierIfPresent() Retrieval of associated CustomerHier entities (one to many).
List<CustomerHier>	getCnsldtnCustomerHierOrFetch() Retrieval of associated CustomerHier entities (one to many).
Optional<List<CustomerText>>	getCnsldtnCustomerTIfPresent() Retrieval of associated CustomerText entities (one to many).
List<CustomerText>	getCnsldtnCustomerTOrFetch() Retrieval of associated CustomerText entities (one to many).
String	getCustomer_Text() Constraints: Not nullable, Maximum length: 80
String	getCustomer() (Key Field) Constraints: Not nullable, Maximum length: 10
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()
Class<Customer>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnCustomerHier(List<CustomerHier> value) Overwrites the list of associated CustomerHier entities for the loaded navigation property to_CnsldtnCustomerHier.
void	setCnsldtnCustomerT(List<CustomerText> value) Overwrites the list of associated CustomerText entities for the loaded navigation property to_CnsldtnCustomerT.
void	setCustomer_Text(String customer_Text) Constraints: Not nullable, Maximum length: 80
void	setCustomer(String customer) (Key Field) Constraints: Not nullable, Maximum length: 10
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
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 CustomerSelectable ALL_FIELDS

Selector for all available fields of Customer.

CUSTOMER

public static final CustomerField<String> CUSTOMER

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

CUSTOMER_TEXT

public static final CustomerField<String> CUSTOMER_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final CustomerField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_CUSTOMER_HIER

public static final CustomerLink<CustomerHier> TO_CNSLDTN_CUSTOMER_HIER

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

TO_CNSLDTN_CUSTOMER_T

public static final CustomerLink<CustomerText> TO_CNSLDTN_CUSTOMER_T

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

Constructor Detail

Customer

public Customer()

Customer

public Customer(@Nullable
                String customer,
                @Nullable
                String customer_Text,
                @Nullable
                String additionalMasterDataSource,
                List<CustomerHier> toCnsldtnCustomerHier,
                List<CustomerText> toCnsldtnCustomerT)

Method Detail

getType

@Nonnull
public Class<Customer> getType()

Specified by:

getType in class VdmObject<Customer>

Returns:

The class of this object.

setCustomer

public void setCustomer(@Nullable
                        String customer)

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

Original property name from the Odata EDM: Customer

Parameters:

customer - Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

setCustomer_Text

public void setCustomer_Text(@Nullable
                             String customer_Text)

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: Customer_Text

Parameters:

customer_Text - Name of Customer

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

getKey

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

Overrides:

getKey in class VdmObject<Customer>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<Customer>

fromMap

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

Overrides:

fromMap in class VdmObject<Customer>

field

@Nonnull
public static <T> CustomerField<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> CustomerField<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<Customer>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<Customer>

fetchCnsldtnCustomerHier

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

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

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

Returns:

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

getCnsldtnCustomerHierOrFetch

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

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

If the navigation property to_CnsldtnCustomerHier of a queried Customer 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 CustomerHier 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.

getCnsldtnCustomerHierIfPresent

@Nonnull
public Optional<List<CustomerHier>> getCnsldtnCustomerHierIfPresent()

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

If the navigation property for an entity Customer 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_CnsldtnCustomerHier is already loaded, the result will contain the CustomerHier entities. If not, an Optional with result state empty is returned.

setCnsldtnCustomerHier

public void setCnsldtnCustomerHier(@Nonnull
                                   List<CustomerHier> value)

Overwrites the list of associated CustomerHier entities for the loaded navigation property to_CnsldtnCustomerHier.

If the navigation property to_CnsldtnCustomerHier of a queried Customer 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 CustomerHier entities.

addCnsldtnCustomerHier

public void addCnsldtnCustomerHier(CustomerHier... entity)

Adds elements to the list of associated CustomerHier entities. This corresponds to the OData navigation property to_CnsldtnCustomerHier.

If the navigation property to_CnsldtnCustomerHier of a queried Customer 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 CustomerHier entities.

fetchCnsldtnCustomerT

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

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

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

Returns:

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

getCnsldtnCustomerTOrFetch

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

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

If the navigation property to_CnsldtnCustomerT of a queried Customer 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 CustomerText 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.

getCnsldtnCustomerTIfPresent

@Nonnull
public Optional<List<CustomerText>> getCnsldtnCustomerTIfPresent()

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

If the navigation property for an entity Customer 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_CnsldtnCustomerT is already loaded, the result will contain the CustomerText entities. If not, an Optional with result state empty is returned.

setCnsldtnCustomerT

public void setCnsldtnCustomerT(@Nonnull
                                List<CustomerText> value)

Overwrites the list of associated CustomerText entities for the loaded navigation property to_CnsldtnCustomerT.

If the navigation property to_CnsldtnCustomerT of a queried Customer 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 CustomerText entities.

addCnsldtnCustomerT

public void addCnsldtnCustomerT(CustomerText... entity)

Adds elements to the list of associated CustomerText entities. This corresponds to the OData navigation property to_CnsldtnCustomerT.

If the navigation property to_CnsldtnCustomerT of a queried Customer 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 CustomerText entities.

builder

public static Customer.CustomerBuilder builder()

getCustomer

@Nullable
public String getCustomer()

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

Original property name from the Odata EDM: Customer

Returns:

Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system.

getCustomer_Text

@Nullable
public String getCustomer_Text()

Constraints: Not nullable, Maximum length: 80

Original property name from the Odata EDM: Customer_Text

Returns:

Name of Customer

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

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Customer>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<Customer>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Customer>