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

Class CountryText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.country.CountryText

public class CountryText
extends VdmEntity<CountryText>

API Country Text

Original entity name from the Odata EDM: A_CountryTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static CountryTextSelectable	ALL_FIELDS Selector for all available fields of CountryText.
static CountryTextField<String>	COUNTRY Use with available fluent helpers to apply the Country field to query operations.
static CountryTextField<String>	COUNTRY_NAME Use with available fluent helpers to apply the CountryName field to query operations.
static CountryTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static CountryTextField<String>	NATIONALITY_LONG_NAME Use with available fluent helpers to apply the NationalityLongName field to query operations.
static CountryTextField<String>	NATIONALITY_NAME Use with available fluent helpers to apply the NationalityName field to query operations.
static CountryTextOneToOneLink<Country>	TO_COUNTRY Use with available fluent helpers to apply the to_Country 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
CountryText()
CountryText(String country, String language, String countryName, String nationalityName, String nationalityLongName, Country toCountry)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static CountryText.CountryTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Country	fetchCountry() Fetches the Country entity (one to one) associated with this entity.
static <T> CountryTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> CountryTextField<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
Optional<Country>	getCountryIfPresent() Retrieval of associated Country entity (one to one).
String	getCountryName() Constraints: Not nullable, Maximum length: 50
Country	getCountryOrFetch() Retrieval of associated Country entity (one to one).
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	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getNationalityLongName() Constraints: Not nullable, Maximum length: 50
String	getNationalityName() Constraints: Not nullable, Maximum length: 15
Class<CountryText>	getType()
int	hashCode()
void	setCountry(Country value) Overwrites the associated Country entity for the loaded navigation property to_Country.
void	setCountry(String country) (Key Field) Constraints: Not nullable, Maximum length: 3
void	setCountryName(String countryName) Constraints: Not nullable, Maximum length: 50
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setNationalityLongName(String nationalityLongName) Constraints: Not nullable, Maximum length: 50
void	setNationalityName(String nationalityName) Constraints: Not nullable, Maximum length: 15
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 CountryTextSelectable ALL_FIELDS

Selector for all available fields of CountryText.

COUNTRY

public static final CountryTextField<String> COUNTRY

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

LANGUAGE

public static final CountryTextField<String> LANGUAGE

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

COUNTRY_NAME

public static final CountryTextField<String> COUNTRY_NAME

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

NATIONALITY_NAME

public static final CountryTextField<String> NATIONALITY_NAME

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

NATIONALITY_LONG_NAME

public static final CountryTextField<String> NATIONALITY_LONG_NAME

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

TO_COUNTRY

public static final CountryTextOneToOneLink<Country> TO_COUNTRY

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

Constructor Detail

CountryText

public CountryText()

CountryText

public CountryText(@Nullable
                   String country,
                   @Nullable
                   String language,
                   @Nullable
                   String countryName,
                   @Nullable
                   String nationalityName,
                   @Nullable
                   String nationalityLongName,
                   @Nullable
                   Country toCountry)

Method Detail

getType

@Nonnull
public Class<CountryText> getType()

Specified by:

getType in class VdmObject<CountryText>

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.

setLanguage

public void setLanguage(@Nullable
                        String language)

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Parameters:

language - The language key indicates

setCountryName

public void setCountryName(@Nullable
                           String countryName)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: CountryName

Parameters:

countryName - Country Long Name

setNationalityName

public void setNationalityName(@Nullable
                               String nationalityName)

Constraints: Not nullable, Maximum length: 15

Original property name from the Odata EDM: NationalityName

Parameters:

nationalityName - Nationality

setNationalityLongName

public void setNationalityLongName(@Nullable
                                   String nationalityLongName)

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: NationalityLongName

Parameters:

nationalityLongName - Nationality (Max. 50 Characters)

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<CountryText>

getKey

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

Overrides:

getKey in class VdmObject<CountryText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<CountryText>

fromMap

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

Overrides:

fromMap in class VdmObject<CountryText>

field

@Nonnull
public static <T> CountryTextField<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> CountryTextField<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<CountryText>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<CountryText>

fetchCountry

@Nullable
public Country fetchCountry()
                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the Country entity (one to one) associated with this entity. This corresponds to the OData navigation property to_Country.

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

Returns:

The single associated Country entity, or null if an entity is not associated.

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.

getCountryOrFetch

@Nullable
public Country getCountryOrFetch()
                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Country entity (one to one). This corresponds to the OData navigation property to_Country.

If the navigation property to_Country of a queried CountryText 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 Country entity.

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.

getCountryIfPresent

@Nonnull
public Optional<Country> getCountryIfPresent()

Retrieval of associated Country entity (one to one). This corresponds to the OData navigation property to_Country.

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

setCountry

public void setCountry(Country value)

Overwrites the associated Country entity for the loaded navigation property to_Country.

Parameters:

value - New Country entity.

builder

public static CountryText.CountryTextBuilder 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.

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

- the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts.

Returns:

The language key indicates

getCountryName

@Nullable
public String getCountryName()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: CountryName

Returns:

Country Long Name

getNationalityName

@Nullable
public String getNationalityName()

Constraints: Not nullable, Maximum length: 15

Original property name from the Odata EDM: NationalityName

Returns:

Nationality

getNationalityLongName

@Nullable
public String getNationalityLongName()

Constraints: Not nullable, Maximum length: 50

Original property name from the Odata EDM: NationalityLongName

Returns:

Nationality (Max. 50 Characters)

toString

public String toString()

Overrides:

toString in class VdmObject<CountryText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<CountryText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<CountryText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<CountryText>