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

Class FunctionalAreaText

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.VdmEntity<FunctionalAreaText>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.functionalarea.FunctionalAreaText

public class FunctionalAreaText
extends VdmEntity<FunctionalAreaText>

API Function Area Text

Original entity name from the Odata EDM: A_FunctionalAreaTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionalAreaTextSelectable	ALL_FIELDS Selector for all available fields of FunctionalAreaText.
static FunctionalAreaTextField<String>	FUNCTIONAL_AREA Use with available fluent helpers to apply the FunctionalArea field to query operations.
static FunctionalAreaTextField<String>	FUNCTIONAL_AREA_NAME Use with available fluent helpers to apply the FunctionalAreaName field to query operations.
static FunctionalAreaTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static FunctionalAreaTextOneToOneLink<FunctionalArea>	TO_FUNCTIONAL_AREA Use with available fluent helpers to apply the to_FunctionalArea navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
FunctionalAreaText()
FunctionalAreaText(String language, String functionalArea, String functionalAreaName, FunctionalArea toFunctionalArea)

Method Summary

Modifier and Type	Method and Description
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static FunctionalAreaText.FunctionalAreaTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FunctionalArea	fetchFunctionalArea() Fetches the FunctionalArea entity (one to one) associated with this entity.
static <T> FunctionalAreaTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> FunctionalAreaTextField<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() Used by fluent helpers and navigation property methods to construct OData queries.
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
String	getFunctionalArea() (Key Field) Constraints: Not nullable, Maximum length: 16
io.vavr.control.Option<FunctionalArea>	getFunctionalAreaIfPresent() Retrieval of associated FunctionalArea entity (one to one).
String	getFunctionalAreaName() Constraints: Not nullable, Maximum length: 25
FunctionalArea	getFunctionalAreaOrFetch() Retrieval of associated FunctionalArea entity (one to one).
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
Class<FunctionalAreaText>	getType()
int	hashCode()
void	setFunctionalArea(FunctionalArea value) Overwrites the associated FunctionalArea entity for the loaded navigation property to_FunctionalArea.
void	setFunctionalArea(String functionalArea) (Key Field) Constraints: Not nullable, Maximum length: 16
void	setFunctionalAreaName(String functionalAreaName) Constraints: Not nullable, Maximum length: 25
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
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.datamodel.odata.helper.VdmEntity

getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.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 FunctionalAreaTextSelectable ALL_FIELDS

Selector for all available fields of FunctionalAreaText.

LANGUAGE

public static final FunctionalAreaTextField<String> LANGUAGE

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

FUNCTIONAL_AREA

public static final FunctionalAreaTextField<String> FUNCTIONAL_AREA

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

FUNCTIONAL_AREA_NAME

public static final FunctionalAreaTextField<String> FUNCTIONAL_AREA_NAME

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

TO_FUNCTIONAL_AREA

public static final FunctionalAreaTextOneToOneLink<FunctionalArea> TO_FUNCTIONAL_AREA

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

Constructor Detail

FunctionalAreaText

public FunctionalAreaText()

FunctionalAreaText

public FunctionalAreaText(@Nullable
                          String language,
                          @Nullable
                          String functionalArea,
                          @Nullable
                          String functionalAreaName,
                          @Nullable
                          FunctionalArea toFunctionalArea)

Method Detail

getType

@Nonnull
public Class<FunctionalAreaText> getType()

Specified by:

getType in class VdmObject<FunctionalAreaText>

Returns:

The class of this object.

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

setFunctionalArea

public void setFunctionalArea(@Nullable
                              String functionalArea)

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

Original property name from the Odata EDM: FunctionalArea

Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements.

Parameters:

functionalArea - Structure criterion for an enterprise or government based on functional aspects.

setFunctionalAreaName

public void setFunctionalAreaName(@Nullable
                                  String functionalAreaName)

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: FunctionalAreaName

Parameters:

functionalAreaName - Name of the Functional Area

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Specified by:

getEntityCollection in class VdmEntity<FunctionalAreaText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<FunctionalAreaText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<FunctionalAreaText>

fromMap

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

Overrides:

fromMap in class VdmObject<FunctionalAreaText>

field

@Nonnull
public static <T> FunctionalAreaTextField<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> FunctionalAreaTextField<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.

getDestinationForFetch

@Nullable
public HttpDestinationProperties getDestinationForFetch()

Description copied from class: VdmEntity

Convienence field for reusing the same destination with multiple queries (e.g. fetching associated entities). New destination to apply to this entity

Overrides:

getDestinationForFetch in class VdmEntity<FunctionalAreaText>

Returns:

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

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nonnull
                            HttpDestinationProperties destination)

Description copied from class: VdmEntity

Sets the service path and destination for the fetch commands of this entity. 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<FunctionalAreaText>

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.

destination - New destination to apply to this entity and any associated entities that were previously fetched.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by fluent helpers and navigation property methods to construct OData queries.

Overrides:

getDefaultServicePath in class VdmEntity<FunctionalAreaText>

Returns:

Default context path to the OData service. In other words, everything in between the protocol://hostname:port and the OData resource name (entity set, $metadata, etc.)

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<FunctionalAreaText>

fetchFunctionalArea

@Nullable
public FunctionalArea fetchFunctionalArea()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getFunctionalAreaOrFetch

@Nullable
public FunctionalArea getFunctionalAreaOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated FunctionalArea entity (one to one). This corresponds to the OData navigation property to_FunctionalArea.

If the navigation property to_FunctionalArea of a queried FunctionalAreaText 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 FunctionalArea 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.

getFunctionalAreaIfPresent

@Nonnull
public io.vavr.control.Option<FunctionalArea> getFunctionalAreaIfPresent()

Retrieval of associated FunctionalArea entity (one to one). This corresponds to the OData navigation property to_FunctionalArea.

If the navigation property for an entity FunctionalAreaText has not been resolved yet, this method will not query further information. Instead its Option result state will be empty.

Returns:

If the information for navigation property to_FunctionalArea is already loaded, the result will contain the FunctionalArea entity. If not, an Option with result state empty is returned.

setFunctionalArea

public void setFunctionalArea(FunctionalArea value)

Overwrites the associated FunctionalArea entity for the loaded navigation property to_FunctionalArea.

Parameters:

value - New FunctionalArea entity.

builder

public static FunctionalAreaText.FunctionalAreaTextBuilder builder()

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

getFunctionalArea

@Nullable
public String getFunctionalArea()

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

Original property name from the Odata EDM: FunctionalArea

Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements.

Returns:

Structure criterion for an enterprise or government based on functional aspects.

getFunctionalAreaName

@Nullable
public String getFunctionalAreaName()

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: FunctionalAreaName

Returns:

Name of the Functional Area

toString

public String toString()

Overrides:

toString in class VdmObject<FunctionalAreaText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<FunctionalAreaText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<FunctionalAreaText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<FunctionalAreaText>