Country (SAP Cloud SDK - Parent POM 3.9.0 API)

java.lang.Object
- com.sap.cloud.sdk.datamodel.odata.helper.VdmObject<EntityT>
- - com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<Country>
  - - com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.country.Country

```
public class Country
extends VdmEntity<Country>
```
API Country

Original entity name from the Odata EDM: A_CountryType

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Country.CountryBuilder
Helper class to allow for fluent creation of Country instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Country.CountryBuilder` Helper class to allow for fluent creation of Country instances.

Field Summary

Fields
Modifier and Type	Field and Description
`static CountrySelectable`	`ALL_FIELDS` Selector for all available fields of Country.
`static CountryField<String>`	`COUNTRY` Use with available fluent helpers to apply the Country field to query operations.
`static CountryField<String>`	`COUNTRY_CURRENCY` Use with available fluent helpers to apply the CountryCurrency field to query operations.
`static CountryField<String>`	`COUNTRY_THREE_DIGIT_ISO_CODE` Use with available fluent helpers to apply the CountryThreeDigitISOCode field to query operations.
`static CountryField<String>`	`COUNTRY_THREE_LETTER_ISO_CODE` Use with available fluent helpers to apply the CountryThreeLetterISOCode field to query operations.
`static CountryField<String>`	`HARD_CURRENCY` Use with available fluent helpers to apply the HardCurrency field to query operations.
`static CountryField<String>`	`INDEX_BASED_CURRENCY` Use with available fluent helpers to apply the IndexBasedCurrency field to query operations.
`static CountryField<String>`	`TAX_CALCULATION_PROCEDURE` Use with available fluent helpers to apply the TaxCalculationProcedure field to query operations.
`static CountryLink<CountryText>`	`TO_TEXT` Use with available fluent helpers to apply the to_Text navigation property to query operations.

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

Constructor Summary

Constructors
Constructor and Description
`Country()`
`Country(String country, String countryCurrency, String indexBasedCurrency, String hardCurrency, String taxCalculationProcedure, String countryThreeLetterISOCode, String countryThreeDigitISOCode, List<CountryText> toText)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addText(CountryText... entity)` Adds elements to the list of associated CountryText entities.
`void`	`attachToService(String servicePath, HttpDestinationProperties destination)` Sets the service path and destination for the fetch commands of this entity.
`static Country.CountryBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`List<CountryText>`	`fetchText()` Fetches the CountryText entities (one to many) associated with this entity.
`static <T> CountryField<T>`	`field(String fieldName, Class<T> fieldType)` Use with available fluent helpers to apply an extension field to query operations.
`static <T,DomainT> CountryField<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`	`getCountry()` (Key Field) Constraints: Not nullable, Maximum length: 3
`String`	`getCountryCurrency()` Constraints: Not nullable, Maximum length: 5
`String`	`getCountryThreeDigitISOCode()` Constraints: Not nullable, Maximum length: 3
`String`	`getCountryThreeLetterISOCode()` Constraints: Not nullable, Maximum length: 3
`protected String`	`getDefaultServicePath()`
`HttpDestinationProperties`	`getDestinationForFetch()` Convienence field for reusing the same destination with multiple queries (e.g.
`protected String`	`getEntityCollection()`
`String`	`getHardCurrency()` Constraints: Not nullable, Maximum length: 5
`String`	`getIndexBasedCurrency()` Constraints: Not nullable, Maximum length: 5
`protected Map<String,Object>`	`getKey()`
`String`	`getTaxCalculationProcedure()` Constraints: Not nullable, Maximum length: 6
`io.vavr.control.Option<List<CountryText>>`	`getTextIfPresent()` Retrieval of associated CountryText entities (one to many).
`List<CountryText>`	`getTextOrFetch()` Retrieval of associated CountryText entities (one to many).
`Class<Country>`	`getType()`
`int`	`hashCode()`
`void`	`setCountry(String country)` (Key Field) Constraints: Not nullable, Maximum length: 3
`void`	`setCountryCurrency(String countryCurrency)` Constraints: Not nullable, Maximum length: 5
`void`	`setCountryThreeDigitISOCode(String countryThreeDigitISOCode)` Constraints: Not nullable, Maximum length: 3
`void`	`setCountryThreeLetterISOCode(String countryThreeLetterISOCode)` Constraints: Not nullable, Maximum length: 3
`void`	`setHardCurrency(String hardCurrency)` Constraints: Not nullable, Maximum length: 5
`void`	`setIndexBasedCurrency(String indexBasedCurrency)` Constraints: Not nullable, Maximum length: 5
`protected void`	`setServicePathForFetch(String servicePathForFetch)` The service path only used for the fetch commands of this entity.
`void`	`setTaxCalculationProcedure(String taxCalculationProcedure)` Constraints: Not nullable, Maximum length: 6
`void`	`setText(List<CountryText> value)` Overwrites the list of associated CountryText entities for the loaded navigation property to_Text.
`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 CountrySelectable ALL_FIELDS
```
    Selector for all available fields of Country.
  - COUNTRY
```
public static final CountryField<String> COUNTRY
```
    Use with available fluent helpers to apply the Country field to query operations.
  - COUNTRY_CURRENCY
```
public static final CountryField<String> COUNTRY_CURRENCY
```
    Use with available fluent helpers to apply the CountryCurrency field to query operations.
  - INDEX_BASED_CURRENCY
```
public static final CountryField<String> INDEX_BASED_CURRENCY
```
    Use with available fluent helpers to apply the IndexBasedCurrency field to query operations.
  - HARD_CURRENCY
```
public static final CountryField<String> HARD_CURRENCY
```
    Use with available fluent helpers to apply the HardCurrency field to query operations.
  - TAX_CALCULATION_PROCEDURE
```
public static final CountryField<String> TAX_CALCULATION_PROCEDURE
```
    Use with available fluent helpers to apply the TaxCalculationProcedure field to query operations.
  - COUNTRY_THREE_LETTER_ISO_CODE
```
public static final CountryField<String> COUNTRY_THREE_LETTER_ISO_CODE
```
    Use with available fluent helpers to apply the CountryThreeLetterISOCode field to query operations.
  - COUNTRY_THREE_DIGIT_ISO_CODE
```
public static final CountryField<String> COUNTRY_THREE_DIGIT_ISO_CODE
```
    Use with available fluent helpers to apply the CountryThreeDigitISOCode field to query operations.
  - TO_TEXT
```
public static final CountryLink<CountryText> TO_TEXT
```
    Use with available fluent helpers to apply the to_Text navigation property to query operations.
- Constructor Detail
  - Country
```
public Country()
```
  - Country
```
public Country(@Nullable
               String country,
               @Nullable
               String countryCurrency,
               @Nullable
               String indexBasedCurrency,
               @Nullable
               String hardCurrency,
               @Nullable
               String taxCalculationProcedure,
               @Nullable
               String countryThreeLetterISOCode,
               @Nullable
               String countryThreeDigitISOCode,
               List<CountryText> toText)
```
- Method Detail
  - getType
```
@Nonnull
public Class<Country> getType()
```
    Specified by:
    
    getType in class VdmObject<Country>
    
    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
    
    Parameters:
    
    country - Here you specify the country key for the customer or vendor.
  - setCountryCurrency
```
public void setCountryCurrency(@Nullable
                               String countryCurrency)
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: CountryCurrency
    
    If the tax amounts for particular codes are reported in a country other than the company code country, then it is necessary to translate them into the corresponding country currency. The currency key specified here is used for this translation.The "Plants abroad" parameter must be active in order to use this field.
    
    Parameters:
    
    countryCurrency - Key for the country currency.
  - setIndexBasedCurrency
```
public void setIndexBasedCurrency(@Nullable
                                  String indexBasedCurrency)
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: IndexBasedCurrency
    
    An index-based currency is stipulated for external reporting (for example, tax returns), in some countries with high inflation.
    
    Parameters:
    
    indexBasedCurrency - Specifies the country-specific, fictitious currency.
  - setHardCurrency
```
public void setHardCurrency(@Nullable
                            String hardCurrency)
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: HardCurrency
    
    A hard currency is used in countries with high inflation.
    
    Parameters:
    
    hardCurrency - Specifies the country-specific second currency.
  - setTaxCalculationProcedure
```
public void setTaxCalculationProcedure(@Nullable
                                       String taxCalculationProcedure)
```
    Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: TaxCalculationProcedure
    
    Procedures are used, for example, in the following applications:Pricing in Sales and DistributionAccount determinationCalculating taxes on sales/purchases
    
    Parameters:
    
    taxCalculationProcedure - Specifies the conditions that are allowed for a document and defines the sequence in which they are used.
  - setCountryThreeLetterISOCode
```
public void setCountryThreeLetterISOCode(@Nullable
                                         String countryThreeLetterISOCode)
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: CountryThreeLetterISOCode
    
    The key is used, e.g. for data exchange with banks via OFX (Open Financial Exchange).It is not the same as the more commonly used 2-character ISO country code or the 3-character numeric INTRASTAT country code.Enter the 3-character ISO country code for all countries if you want to exchange data with banks via OFX.
    
    Parameters:
    
    countryThreeLetterISOCode - International standardized 3-character country key
  - setCountryThreeDigitISOCode
```
public void setCountryThreeDigitISOCode(@Nullable
                                        String countryThreeDigitISOCode)
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: CountryThreeDigitISOCode
    
    This 3-character numeric ISO country code is listed for all countries, for example, in the Internet under the address http://www.un.org/Depts/unsd/methods/m49alpha.htm.The code is not to be confused with the 2-character ISO country code, which is more frequently used, the 3-character numeric INTRASTAT country code, or the 3-character non-numeric ISO country code.The use of this 3-character numeric ISO code is required by law in countries such as Romania and Croatia.
    
    Parameters:
    
    countryThreeDigitISOCode - 3-character numeric ISO country code
  - getEntityCollection
```
protected String getEntityCollection()
```
    Specified by:
    
    getEntityCollection in class VdmEntity<Country>
  - getKey
```
@Nonnull
protected Map<String,Object> getKey()
```
    Overrides:
    
    getKey in class VdmObject<Country>
    
    Returns:
    
    The compound key of this object.
  - toMapOfFields
```
@Nonnull
protected Map<String,Object> toMapOfFields()
```
    Overrides:
    
    toMapOfFields in class VdmObject<Country>
  - fromMap
```
protected void fromMap(Map<String,Object> inputValues)
```
    Overrides:
    
    fromMap in class VdmObject<Country>
  - field
```
@Nonnull
public static <T> CountryField<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> CountryField<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<Country>
    
    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<Country>
  - 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<Country>
    
    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()
```
    Overrides:
    
    getDefaultServicePath in class VdmEntity<Country>
  - toMapOfNavigationProperties
```
@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()
```
    Overrides:
    
    toMapOfNavigationProperties in class VdmObject<Country>
  - fetchText
```
@Nonnull
public List<CountryText> fetchText()
                                     throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Fetches the CountryText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_Text.
    Please note: This method will not cache or persist the query results.
    
    Returns:
    
    List containing one or more associated CountryText 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.
  - getTextOrFetch
```
@Nonnull
public List<CountryText> getTextOrFetch()
                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
```
    Retrieval of associated CountryText entities (one to many). This corresponds to the OData navigation property to_Text.
    If the navigation property to_Text of a queried Country 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 CountryText 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.
  - getTextIfPresent
```
@Nonnull
public io.vavr.control.Option<List<CountryText>> getTextIfPresent()
```
    Retrieval of associated CountryText entities (one to many). This corresponds to the OData navigation property to_Text.
    If the navigation property for an entity Country 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_Text is already loaded, the result will contain the CountryText entities. If not, an Option with result state empty is returned.
  - setText
```
public void setText(@Nonnull
                    List<CountryText> value)
```
    Overwrites the list of associated CountryText entities for the loaded navigation property to_Text.
    If the navigation property to_Text of a queried Country 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 CountryText entities.
  - addText
```
public void addText(CountryText... entity)
```
    Adds elements to the list of associated CountryText entities. This corresponds to the OData navigation property to_Text.
    If the navigation property to_Text of a queried Country 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 CountryText entities.
  - builder
```
public static Country.CountryBuilder builder()
```
  - getCountry
```
@Nullable
public String getCountry()
```
    (Key Field) Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: Country
    
    Returns:
    
    Here you specify the country key for the customer or vendor.
  - getCountryCurrency
```
@Nullable
public String getCountryCurrency()
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: CountryCurrency
    
    If the tax amounts for particular codes are reported in a country other than the company code country, then it is necessary to translate them into the corresponding country currency. The currency key specified here is used for this translation.The "Plants abroad" parameter must be active in order to use this field.
    
    Returns:
    
    Key for the country currency.
  - getIndexBasedCurrency
```
@Nullable
public String getIndexBasedCurrency()
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: IndexBasedCurrency
    
    An index-based currency is stipulated for external reporting (for example, tax returns), in some countries with high inflation.
    
    Returns:
    
    Specifies the country-specific, fictitious currency.
  - getHardCurrency
```
@Nullable
public String getHardCurrency()
```
    Constraints: Not nullable, Maximum length: 5
    Original property name from the Odata EDM: HardCurrency
    
    A hard currency is used in countries with high inflation.
    
    Returns:
    
    Specifies the country-specific second currency.
  - getTaxCalculationProcedure
```
@Nullable
public String getTaxCalculationProcedure()
```
    Constraints: Not nullable, Maximum length: 6
    Original property name from the Odata EDM: TaxCalculationProcedure
    
    Procedures are used, for example, in the following applications:Pricing in Sales and DistributionAccount determinationCalculating taxes on sales/purchases
    
    Returns:
    
    Specifies the conditions that are allowed for a document and defines the sequence in which they are used.
  - getCountryThreeLetterISOCode
```
@Nullable
public String getCountryThreeLetterISOCode()
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: CountryThreeLetterISOCode
    
    The key is used, e.g. for data exchange with banks via OFX (Open Financial Exchange).It is not the same as the more commonly used 2-character ISO country code or the 3-character numeric INTRASTAT country code.Enter the 3-character ISO country code for all countries if you want to exchange data with banks via OFX.
    
    Returns:
    
    International standardized 3-character country key
  - getCountryThreeDigitISOCode
```
@Nullable
public String getCountryThreeDigitISOCode()
```
    Constraints: Not nullable, Maximum length: 3
    Original property name from the Odata EDM: CountryThreeDigitISOCode
    
    This 3-character numeric ISO country code is listed for all countries, for example, in the Internet under the address http://www.un.org/Depts/unsd/methods/m49alpha.htm.The code is not to be confused with the 2-character ISO country code, which is more frequently used, the 3-character numeric INTRASTAT country code, or the 3-character non-numeric ISO country code.The use of this 3-character numeric ISO code is required by law in countries such as Romania and Croatia.
    
    Returns:
    
    3-character numeric ISO country code
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VdmObject<Country>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class VdmObject<Country>
  - canEqual
```
protected boolean canEqual(Object other)
```
    Overrides:
    
    canEqual in class VdmObject<Country>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VdmObject<Country>

Class Country

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity

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

Methods inherited from class java.lang.Object

Field Detail

ALL_FIELDS

COUNTRY

COUNTRY_CURRENCY

INDEX_BASED_CURRENCY

HARD_CURRENCY

TAX_CALCULATION_PROCEDURE

COUNTRY_THREE_LETTER_ISO_CODE

COUNTRY_THREE_DIGIT_ISO_CODE

TO_TEXT

Constructor Detail

Country

Country

Method Detail

getType

setCountry

setCountryCurrency

setIndexBasedCurrency

setHardCurrency

setTaxCalculationProcedure

setCountryThreeLetterISOCode

setCountryThreeDigitISOCode

getEntityCollection

getKey

toMapOfFields

fromMap

field

field

getDestinationForFetch

setServicePathForFetch

attachToService

getDefaultServicePath

toMapOfNavigationProperties

fetchText

getTextOrFetch

getTextIfPresent

setText

addText

builder

getCountry

getCountryCurrency

getIndexBasedCurrency

getHardCurrency

getTaxCalculationProcedure

getCountryThreeLetterISOCode

getCountryThreeDigitISOCode

toString

equals

canEqual

hashCode