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

Class SalesDistrict

java.lang.Object

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

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

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

public class SalesDistrict
extends VdmEntity<SalesDistrict>

API Sales District

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SalesDistrict.SalesDistrictBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static SalesDistrictSelectable	ALL_FIELDS Selector for all available fields of SalesDistrict.
static SalesDistrictField<String>	SALES_DISTRICT Use with available fluent helpers to apply the SalesDistrict field to query operations.
static SalesDistrictLink<SalesDistrictText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
SalesDistrict()
SalesDistrict(String salesDistrict, ErpConfigContext erpConfigContext, List<SalesDistrictText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(SalesDistrictText... entity) Adds elements to the list of associated SalesDistrictText entities.
static SalesDistrict.SalesDistrictBuilder	builder()
boolean	equals(Object o)
List<SalesDistrictText>	fetchText() Fetches the SalesDistrictText entities (one to many) associated with this entity.
static <T> SalesDistrictField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
String	getSalesDistrict() (Key Field) Constraints: Not nullable, Maximum length: 6 Each customer can be assigned to a sales district.
List<SalesDistrictText>	getTextOrFetch() Retrieval of associated SalesDistrictText entities (one to many).
com.google.common.base.Optional<List<SalesDistrictText>>	getTextOrNull() Retrieval of associated SalesDistrictText entities (one to many).
Class<SalesDistrict>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setSalesDistrict(String salesDistrict) (Key Field) Constraints: Not nullable, Maximum length: 6 Each customer can be assigned to a sales district.
void	setText(List<SalesDistrictText> value) Overwrites the list of associated SalesDistrictText entities for the loaded navigation property to_Text.
String	toString()

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

getCustomField, getCustomField, getCustomFieldNames, getCustomFields, hasCustomField, hasCustomField, setCustomField, setCustomField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL_FIELDS

public static final SalesDistrictSelectable ALL_FIELDS

Selector for all available fields of SalesDistrict.

SALES_DISTRICT

public static final SalesDistrictField<String> SALES_DISTRICT

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

TO_TEXT

public static final SalesDistrictLink<SalesDistrictText> TO_TEXT

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

Constructor Detail

SalesDistrict

public SalesDistrict()

SalesDistrict

public SalesDistrict(@Nullable
                     String salesDistrict,
                     @Nullable
                     ErpConfigContext erpConfigContext,
                     List<SalesDistrictText> toText)

Method Detail

getType

public Class<SalesDistrict> getType()

Specified by:

getType in class VdmObject<SalesDistrict>

Returns:

The class of this object.

field

public static <T> SalesDistrictField<T> field(String fieldName,
                                              Class<T> fieldType)

Use with available fluent helpers to apply an extension field to query operations.

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.

fetchText

public List<SalesDistrictText> fetchText()
                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

public List<SalesDistrictText> getTextOrFetch()
                                       throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated SalesDistrictText entities (one to many).

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

getTextOrNull

public com.google.common.base.Optional<List<SalesDistrictText>> getTextOrNull()

Retrieval of associated SalesDistrictText entities (one to many).

If the navigation property to_Text for an entity SalesDistrict has not been resolved yet, this method will not query further information. Instead its Optional result state will be null.

Returns:

If the information for navigation property to_Text is already loaded, the result will contain the SalesDistrictText entities. If not, a null value state is returned.

setText

public void setText(@NonNull
                    List<SalesDistrictText> value)

Overwrites the list of associated SalesDistrictText entities for the loaded navigation property to_Text.

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

addText

public void addText(SalesDistrictText... entity)

Adds elements to the list of associated SalesDistrictText entities.

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

builder

public static SalesDistrict.SalesDistrictBuilder builder()

getSalesDistrict

@Nullable
public String getSalesDistrict()

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

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.

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setSalesDistrict

public void setSalesDistrict(@Nullable
                             String salesDistrict)

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

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 -

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<SalesDistrict>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<SalesDistrict>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<SalesDistrict>