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

Class CustomerSupplierCountry

java.lang.Object

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

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

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

public class CustomerSupplierCountry
extends VdmEntity<CustomerSupplierCountry>

Consolidation - Combined Country

Original entity name from the Odata EDM: CustomerSupplierCountryType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CustomerSupplierCountryField<String>	ADDITIONAL_MASTER_DATA_SOURCE Use with available fluent helpers to apply the AdditionalMasterDataSource field to query operations.
static CustomerSupplierCountrySelectable	ALL_FIELDS Selector for all available fields of CustomerSupplierCountry.
static CustomerSupplierCountryField<String>	COUNTRY Use with available fluent helpers to apply the Country field to query operations.
static CustomerSupplierCountryField<String>	COUNTRY_TEXT Use with available fluent helpers to apply the Country_Text field to query operations.
static CustomerSupplierCountryLink<CustomerSupplierCountryHier>	TO_CNSLDTN_COUNTRY_HIER Use with available fluent helpers to apply the to_CnsldtnCountryHier navigation property to query operations.
static CustomerSupplierCountryLink<CustomerSupplierCountryText>	TO_CNSLDTN_COUNTRY_T Use with available fluent helpers to apply the to_CnsldtnCountryT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
CustomerSupplierCountry()
CustomerSupplierCountry(String country, String country_Text, String additionalMasterDataSource, List<CustomerSupplierCountryHier> toCnsldtnCountryHier, List<CustomerSupplierCountryText> toCnsldtnCountryT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnCountryHier(CustomerSupplierCountryHier... entity) Adds elements to the list of associated CustomerSupplierCountryHier entities.
void	addCnsldtnCountryT(CustomerSupplierCountryText... entity) Adds elements to the list of associated CustomerSupplierCountryText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static CustomerSupplierCountry.CustomerSupplierCountryBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<CustomerSupplierCountryHier>	fetchCnsldtnCountryHier() Fetches the CustomerSupplierCountryHier entities (one to many) associated with this entity.
List<CustomerSupplierCountryText>	fetchCnsldtnCountryT() Fetches the CustomerSupplierCountryText entities (one to many) associated with this entity.
static <T> CustomerSupplierCountryField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CustomerSupplierCountryField<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<CustomerSupplierCountryHier>>	getCnsldtnCountryHierIfPresent() Retrieval of associated CustomerSupplierCountryHier entities (one to many).
List<CustomerSupplierCountryHier>	getCnsldtnCountryHierOrFetch() Retrieval of associated CustomerSupplierCountryHier entities (one to many).
io.vavr.control.Option<List<CustomerSupplierCountryText>>	getCnsldtnCountryTIfPresent() Retrieval of associated CustomerSupplierCountryText entities (one to many).
List<CustomerSupplierCountryText>	getCnsldtnCountryTOrFetch() Retrieval of associated CustomerSupplierCountryText entities (one to many).
String	getCountry_Text() Constraints: Not nullable, Maximum length: 50
String	getCountry() (Key Field) Constraints: Not nullable, Maximum length: 3
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()
Class<CustomerSupplierCountry>	getType()
int	hashCode()
void	setAdditionalMasterDataSource(String additionalMasterDataSource) Constraints: Not nullable, Maximum length: 10
void	setCnsldtnCountryHier(List<CustomerSupplierCountryHier> value) Overwrites the list of associated CustomerSupplierCountryHier entities for the loaded navigation property to_CnsldtnCountryHier.
void	setCnsldtnCountryT(List<CustomerSupplierCountryText> value) Overwrites the list of associated CustomerSupplierCountryText entities for the loaded navigation property to_CnsldtnCountryT.
void	setCountry_Text(String country_Text) Constraints: Not nullable, Maximum length: 50
void	setCountry(String country) (Key Field) Constraints: Not nullable, Maximum length: 3
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 CustomerSupplierCountrySelectable ALL_FIELDS

Selector for all available fields of CustomerSupplierCountry.

COUNTRY

public static final CustomerSupplierCountryField<String> COUNTRY

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

COUNTRY_TEXT

public static final CustomerSupplierCountryField<String> COUNTRY_TEXT

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

ADDITIONAL_MASTER_DATA_SOURCE

public static final CustomerSupplierCountryField<String> ADDITIONAL_MASTER_DATA_SOURCE

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

TO_CNSLDTN_COUNTRY_HIER

public static final CustomerSupplierCountryLink<CustomerSupplierCountryHier> TO_CNSLDTN_COUNTRY_HIER

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

TO_CNSLDTN_COUNTRY_T

public static final CustomerSupplierCountryLink<CustomerSupplierCountryText> TO_CNSLDTN_COUNTRY_T

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

Constructor Detail

CustomerSupplierCountry

public CustomerSupplierCountry()

CustomerSupplierCountry

public CustomerSupplierCountry(@Nullable
                               String country,
                               @Nullable
                               String country_Text,
                               @Nullable
                               String additionalMasterDataSource,
                               List<CustomerSupplierCountryHier> toCnsldtnCountryHier,
                               List<CustomerSupplierCountryText> toCnsldtnCountryT)

Method Detail

getType

@Nonnull
public Class<CustomerSupplierCountry> getType()

Specified by:

getType in class VdmObject<CustomerSupplierCountry>

Returns:

The class of this object.

setCountry

public void setCountry(@Nullable
                       String country)

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

Original property name from the Odata EDM: Country

The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.

Parameters:

country - The country key contains information which the system uses to check entries such as the length of the postal code or bank account number.

setCountry_Text

public void setCountry_Text(@Nullable
                            String country_Text)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: Country_Text

Parameters:

country_Text - Customer/Supplier Country/Region 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<CustomerSupplierCountry>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<CustomerSupplierCountry>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CustomerSupplierCountry>

fromMap

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

Overrides:

fromMap in class VdmObject<CustomerSupplierCountry>

field

@Nonnull
public static <T> CustomerSupplierCountryField<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> CustomerSupplierCountryField<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<CustomerSupplierCountry>

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

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

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

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

fetchCnsldtnCountryHier

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

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

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

Returns:

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

getCnsldtnCountryHierOrFetch

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

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

If the navigation property to_CnsldtnCountryHier of a queried CustomerSupplierCountry 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 CustomerSupplierCountryHier 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.

getCnsldtnCountryHierIfPresent

@Nonnull
public io.vavr.control.Option<List<CustomerSupplierCountryHier>> getCnsldtnCountryHierIfPresent()

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

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

setCnsldtnCountryHier

public void setCnsldtnCountryHier(@Nonnull
                                  List<CustomerSupplierCountryHier> value)

Overwrites the list of associated CustomerSupplierCountryHier entities for the loaded navigation property to_CnsldtnCountryHier.

If the navigation property to_CnsldtnCountryHier of a queried CustomerSupplierCountry 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 CustomerSupplierCountryHier entities.

addCnsldtnCountryHier

public void addCnsldtnCountryHier(CustomerSupplierCountryHier... entity)

Adds elements to the list of associated CustomerSupplierCountryHier entities. This corresponds to the OData navigation property to_CnsldtnCountryHier.

If the navigation property to_CnsldtnCountryHier of a queried CustomerSupplierCountry 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 CustomerSupplierCountryHier entities.

fetchCnsldtnCountryT

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

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

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

Returns:

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

getCnsldtnCountryTOrFetch

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

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

If the navigation property to_CnsldtnCountryT of a queried CustomerSupplierCountry 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 CustomerSupplierCountryText 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.

getCnsldtnCountryTIfPresent

@Nonnull
public io.vavr.control.Option<List<CustomerSupplierCountryText>> getCnsldtnCountryTIfPresent()

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

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

setCnsldtnCountryT

public void setCnsldtnCountryT(@Nonnull
                               List<CustomerSupplierCountryText> value)

Overwrites the list of associated CustomerSupplierCountryText entities for the loaded navigation property to_CnsldtnCountryT.

If the navigation property to_CnsldtnCountryT of a queried CustomerSupplierCountry 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 CustomerSupplierCountryText entities.

addCnsldtnCountryT

public void addCnsldtnCountryT(CustomerSupplierCountryText... entity)

Adds elements to the list of associated CustomerSupplierCountryText entities. This corresponds to the OData navigation property to_CnsldtnCountryT.

If the navigation property to_CnsldtnCountryT of a queried CustomerSupplierCountry 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 CustomerSupplierCountryText entities.

builder

public static CustomerSupplierCountry.CustomerSupplierCountryBuilder builder()

getCountry

@Nullable
public String getCountry()

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

Original property name from the Odata EDM: Country

The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA.

Returns:

The country key contains information which the system uses to check entries such as the length of the postal code or bank account number.

getCountry_Text

@Nullable
public String getCountry_Text()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: Country_Text

Returns:

Customer/Supplier Country/Region 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<CustomerSupplierCountry>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CustomerSupplierCountry>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CustomerSupplierCountry>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CustomerSupplierCountry>