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

Class BusinessArea

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readbusinessarea.BusinessArea

public class BusinessArea
extends VdmEntity<BusinessArea>

API Business Area

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BusinessArea.BusinessAreaBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static BusinessAreaSelectable	ALL_FIELDS Selector for all available fields of BusinessArea.
static BusinessAreaField<String>	BUSINESS_AREA Use with available fluent helpers to apply the BusinessArea field to query operations.
static BusinessAreaLink<BusinessAreaText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
BusinessArea()
BusinessArea(String businessArea, ErpConfigContext erpConfigContext, List<BusinessAreaText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(BusinessAreaText... entity) Adds elements to the list of associated BusinessAreaText entities.
static BusinessArea.BusinessAreaBuilder	builder()
boolean	equals(Object o)
List<BusinessAreaText>	fetchText() Fetches the BusinessAreaText entities (one to many) associated with this entity.
static <T> BusinessAreaField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getBusinessArea() (Key Field) Constraints: Not nullable, Maximum length: 4
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
List<BusinessAreaText>	getTextOrFetch() Retrieval of associated BusinessAreaText entities (one to many).
com.google.common.base.Optional<List<BusinessAreaText>>	getTextOrNull() Retrieval of associated BusinessAreaText entities (one to many).
Class<BusinessArea>	getType()
int	hashCode()
void	setBusinessArea(String businessArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setText(List<BusinessAreaText> value) Overwrites the list of associated BusinessAreaText 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 BusinessAreaSelectable ALL_FIELDS

Selector for all available fields of BusinessArea.

BUSINESS_AREA

public static final BusinessAreaField<String> BUSINESS_AREA

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

TO_TEXT

public static final BusinessAreaLink<BusinessAreaText> TO_TEXT

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

Constructor Detail

BusinessArea

@Generated(value="lombok")
public BusinessArea()

BusinessArea

@ConstructorProperties(value={"businessArea","erpConfigContext","toText"})
 @Generated(value="lombok")
public BusinessArea(@Nullable
                                                                                                                           String businessArea,
                                                                                                                           @Nullable
                                                                                                                           ErpConfigContext erpConfigContext,
                                                                                                                           List<BusinessAreaText> toText)

Method Detail

getType

public Class<BusinessArea> getType()

Specified by:

getType in class VdmObject<BusinessArea>

Returns:

The class of this object.

field

public static <T> BusinessAreaField<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<BusinessAreaText> fetchText()
                                 throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Fetches the BusinessAreaText 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 BusinessAreaText 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<BusinessAreaText> getTextOrFetch()
                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated BusinessAreaText entities (one to many).

If the navigation property to_Text of a queried BusinessArea 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 BusinessAreaText 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<BusinessAreaText>> getTextOrNull()

Retrieval of associated BusinessAreaText entities (one to many).

If the navigation property to_Text for an entity BusinessArea 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 BusinessAreaText entities. If not, a null value state is returned.

setText

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

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

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

addText

public void addText(BusinessAreaText... entity)

Adds elements to the list of associated BusinessAreaText entities.

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

builder

@Generated(value="lombok")
public static BusinessArea.BusinessAreaBuilder builder()

getBusinessArea

@Nullable
 @Generated(value="lombok")
public String getBusinessArea()

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

Returns:

Key that uniquely identifies a business area.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
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.

setBusinessArea

@Generated(value="lombok")
public void setBusinessArea(@Nullable
                                                       String businessArea)

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

Parameters:

businessArea -

setErpConfigContext

@Generated(value="lombok")
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

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<BusinessArea>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<BusinessArea>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<BusinessArea>