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

Class SalesDistrictText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.salesdistrict.SalesDistrictText

public class SalesDistrictText
extends VdmEntity<SalesDistrictText>

API Sales District Text

Original entity name from the Odata EDM: A_SalesDistrictTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SalesDistrictTextSelectable	ALL_FIELDS Selector for all available fields of SalesDistrictText.
static SalesDistrictTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static SalesDistrictTextField<String>	SALES_DISTRICT Use with available fluent helpers to apply the SalesDistrict field to query operations.
static SalesDistrictTextField<String>	SALES_DISTRICT_NAME Use with available fluent helpers to apply the SalesDistrictName field to query operations.
static SalesDistrictTextOneToOneLink<SalesDistrict>	TO_SALES_DISTRICT Use with available fluent helpers to apply the to_SalesDistrict 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
SalesDistrictText()
SalesDistrictText(String salesDistrict, String language, String salesDistrictName, SalesDistrict toSalesDistrict)

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 SalesDistrictText.SalesDistrictTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
SalesDistrict	fetchSalesDistrict() Fetches the SalesDistrict entity (one to one) associated with this entity.
static <T> SalesDistrictTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> SalesDistrictTextField<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)
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	getSalesDistrict() (Key Field) Constraints: Not nullable, Maximum length: 6
Optional<SalesDistrict>	getSalesDistrictIfPresent() Retrieval of associated SalesDistrict entity (one to one).
String	getSalesDistrictName() Constraints: Not nullable, Maximum length: 20
SalesDistrict	getSalesDistrictOrFetch() Retrieval of associated SalesDistrict entity (one to one).
Class<SalesDistrictText>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setSalesDistrict(SalesDistrict value) Overwrites the associated SalesDistrict entity for the loaded navigation property to_SalesDistrict.
void	setSalesDistrict(String salesDistrict) (Key Field) Constraints: Not nullable, Maximum length: 6
void	setSalesDistrictName(String salesDistrictName) Constraints: Not nullable, Maximum length: 20
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 SalesDistrictTextSelectable ALL_FIELDS

Selector for all available fields of SalesDistrictText.

SALES_DISTRICT

public static final SalesDistrictTextField<String> SALES_DISTRICT

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

LANGUAGE

public static final SalesDistrictTextField<String> LANGUAGE

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

SALES_DISTRICT_NAME

public static final SalesDistrictTextField<String> SALES_DISTRICT_NAME

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

TO_SALES_DISTRICT

public static final SalesDistrictTextOneToOneLink<SalesDistrict> TO_SALES_DISTRICT

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

Constructor Detail

SalesDistrictText

public SalesDistrictText()

SalesDistrictText

public SalesDistrictText(@Nullable
                         String salesDistrict,
                         @Nullable
                         String language,
                         @Nullable
                         String salesDistrictName,
                         @Nullable
                         SalesDistrict toSalesDistrict)

Method Detail

getType

@Nonnull
public Class<SalesDistrictText> getType()

Specified by:

getType in class VdmObject<SalesDistrictText>

Returns:

The class of this object.

setSalesDistrict

public void setSalesDistrict(@Nullable
                             String salesDistrict)

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

Original property name from the Odata EDM: SalesDistrict

Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level.

Parameters:

salesDistrict - A geographical sales district or region.

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

setSalesDistrictName

public void setSalesDistrictName(@Nullable
                                 String salesDistrictName)

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SalesDistrictName

Parameters:

salesDistrictName - Name of the district

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<SalesDistrictText>

getKey

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

Overrides:

getKey in class VdmObject<SalesDistrictText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<SalesDistrictText>

fromMap

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

Overrides:

fromMap in class VdmObject<SalesDistrictText>

field

@Nonnull
public static <T> SalesDistrictTextField<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> SalesDistrictTextField<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<SalesDistrictText>

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

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

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

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

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<SalesDistrictText>

fetchSalesDistrict

@Nullable
public SalesDistrict fetchSalesDistrict()
                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

The single associated SalesDistrict 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.

getSalesDistrictOrFetch

@Nullable
public SalesDistrict getSalesDistrictOrFetch()
                                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SalesDistrict entity (one to one). This corresponds to the OData navigation property to_SalesDistrict.

If the navigation property to_SalesDistrict of a queried SalesDistrictText 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 SalesDistrict 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.

getSalesDistrictIfPresent

@Nonnull
public Optional<SalesDistrict> getSalesDistrictIfPresent()

Retrieval of associated SalesDistrict entity (one to one). This corresponds to the OData navigation property to_SalesDistrict.

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

setSalesDistrict

public void setSalesDistrict(SalesDistrict value)

Overwrites the associated SalesDistrict entity for the loaded navigation property to_SalesDistrict.

Parameters:

value - New SalesDistrict entity.

builder

public static SalesDistrictText.SalesDistrictTextBuilder builder()

getSalesDistrict

@Nullable
public String getSalesDistrict()

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

Original property name from the Odata EDM: SalesDistrict

Each customer can be assigned to a sales district. You can use sales districts to apply pricing conditions. When you want to generate sales statistics, you can use sales districts as a selection criteria.The system can propose a value from the customer master record of the sold-to party. You can change the value manually in the document at the header or item level.

Returns:

A geographical sales district or region.

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

getSalesDistrictName

@Nullable
public String getSalesDistrictName()

Constraints: Not nullable, Maximum length: 20

Original property name from the Odata EDM: SalesDistrictName

Returns:

Name of the district

toString

public String toString()

Overrides:

toString in class VdmObject<SalesDistrictText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SalesDistrictText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<SalesDistrictText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SalesDistrictText>