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

Class BusinessAreaText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.businessarea.BusinessAreaText

public class BusinessAreaText
extends VdmEntity<BusinessAreaText>

API Business Area Text

Original entity name from the Odata EDM: A_BusinessAreaTextType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessAreaText.BusinessAreaTextBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessAreaTextSelectable	ALL_FIELDS Selector for all available fields of BusinessAreaText.
static BusinessAreaTextField<String>	BUSINESS_AREA Use with available fluent helpers to apply the BusinessArea field to query operations.
static BusinessAreaTextField<String>	BUSINESS_AREA_NAME Use with available fluent helpers to apply the BusinessAreaName field to query operations.
static BusinessAreaTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static BusinessAreaTextLink<BusinessArea>	TO_BUSINESS_AREA Use with available fluent helpers to apply the to_BusinessArea 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
BusinessAreaText()
BusinessAreaText(String businessArea, String language, String businessAreaName, ErpConfigContext erpConfigContext, BusinessArea toBusinessArea)

Method Summary

Modifier and Type	Method and Description
static BusinessAreaText.BusinessAreaTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BusinessArea	fetchBusinessArea() Fetches the BusinessArea entity (one to one) associated with this entity.
static <T> BusinessAreaTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
protected void	fromMap(Map<String,Object> inputValues)
String	getBusinessArea() (Key Field) Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: BusinessArea
Optional<BusinessArea>	getBusinessAreaIfPresent() Retrieval of associated BusinessArea entity (one to one).
String	getBusinessAreaName() Constraints: Not nullable, Maximum length: 30 Original property name from the Odata EDM: BusinessAreaName
BusinessArea	getBusinessAreaOrFetch() Retrieval of associated BusinessArea entity (one to one).
protected String	getEndpointUrl()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
protected Map<String,Object>	getKey()
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.
Class<BusinessAreaText>	getType()
int	hashCode()
void	setBusinessArea(BusinessArea value) Overwrites the associated BusinessArea entity for the loaded navigation property to_BusinessArea.
void	setBusinessArea(String businessArea) (Key Field) Constraints: Not nullable, Maximum length: 4 Original property name from the Odata EDM: BusinessArea
void	setBusinessAreaName(String businessAreaName) Constraints: Not nullable, Maximum length: 30 Original property name from the Odata EDM: BusinessAreaName
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setLanguage(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.
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

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 BusinessAreaTextSelectable ALL_FIELDS

Selector for all available fields of BusinessAreaText.

BUSINESS_AREA

public static final BusinessAreaTextField<String> BUSINESS_AREA

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

LANGUAGE

public static final BusinessAreaTextField<String> LANGUAGE

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

BUSINESS_AREA_NAME

public static final BusinessAreaTextField<String> BUSINESS_AREA_NAME

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

TO_BUSINESS_AREA

public static final BusinessAreaTextLink<BusinessArea> TO_BUSINESS_AREA

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

Constructor Detail

BusinessAreaText

public BusinessAreaText()

BusinessAreaText

public BusinessAreaText(@Nullable
                        String businessArea,
                        @Nullable
                        String language,
                        @Nullable
                        String businessAreaName,
                        @Nullable
                        ErpConfigContext erpConfigContext,
                        @Nullable
                        BusinessArea toBusinessArea)

Method Detail

getType

public Class<BusinessAreaText> getType()

Specified by:

getType in class VdmObject<BusinessAreaText>

Returns:

The class of this object.

setBusinessArea

public void setBusinessArea(@Nullable
                            String businessArea)

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

Original property name from the Odata EDM: BusinessArea

Parameters:

businessArea - Key that uniquely identifies a business area.

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

setBusinessAreaName

public void setBusinessAreaName(@Nullable
                                String businessAreaName)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BusinessAreaName

Parameters:

businessAreaName - Business Area Description

getEndpointUrl

protected String getEndpointUrl()

Specified by:

getEndpointUrl in class VdmEntity<BusinessAreaText>

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<BusinessAreaText>

getKey

protected Map<String,Object> getKey()

Overrides:

getKey in class VdmObject<BusinessAreaText>

Returns:

The compound key of this object.

toMapOfFields

protected Map<String,Object> toMapOfFields()

Overrides:

toMapOfFields in class VdmObject<BusinessAreaText>

fromMap

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

Overrides:

fromMap in class VdmObject<BusinessAreaText>

field

public static <T> BusinessAreaTextField<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.

toMapOfNavigationProperties

protected Map<String,Object> toMapOfNavigationProperties()

Overrides:

toMapOfNavigationProperties in class VdmObject<BusinessAreaText>

fetchBusinessArea

public BusinessArea fetchBusinessArea()
                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getBusinessAreaOrFetch

public BusinessArea getBusinessAreaOrFetch()
                                    throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BusinessArea entity (one to one). This corresponds to the OData navigation property to_BusinessArea.

If the navigation property to_BusinessArea of a queried BusinessAreaText 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 BusinessArea 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.

getBusinessAreaIfPresent

public Optional<BusinessArea> getBusinessAreaIfPresent()

Retrieval of associated BusinessArea entity (one to one). This corresponds to the OData navigation property to_BusinessArea.

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

setBusinessArea

public void setBusinessArea(BusinessArea value)

Overwrites the associated BusinessArea entity for the loaded navigation property to_BusinessArea.

Parameters:

value - New BusinessArea entity.

builder

public static BusinessAreaText.BusinessAreaTextBuilder builder()

getBusinessArea

@Nullable
public String getBusinessArea()

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

Original property name from the Odata EDM: BusinessArea

Returns:

Key that uniquely identifies a business area.

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

getBusinessAreaName

@Nullable
public String getBusinessAreaName()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: BusinessAreaName

Returns:

Business Area Description

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.

setErpConfigContext

public void setErpConfigContext(@Nullable
                                ErpConfigContext erpConfigContext)

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

Overrides:

setErpConfigContext in class VdmEntity<BusinessAreaText>

Parameters:

erpConfigContext -

toString

public String toString()

Overrides:

toString in class VdmObject<BusinessAreaText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<BusinessAreaText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<BusinessAreaText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessAreaText>