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

Class ControllingAreaText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.masterdataforgroupreporting.ControllingAreaText

public class ControllingAreaText
extends VdmEntity<ControllingAreaText>

Consolidation - Combined Controlling Area Text

Original entity name from the Odata EDM: ControllingAreaTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ControllingAreaTextSelectable	ALL_FIELDS Selector for all available fields of ControllingAreaText.
static ControllingAreaTextField<String>	CONTROLLING_AREA Use with available fluent helpers to apply the ControllingArea field to query operations.
static ControllingAreaTextField<String>	CONTROLLING_AREA_TEXT Use with available fluent helpers to apply the ControllingAreaText field to query operations.
static ControllingAreaTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static ControllingAreaTextOneToOneLink<ControllingArea>	TO_CNSLDTN_CONTROLLING_AREA Use with available fluent helpers to apply the to_CnsldtnControllingArea navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ControllingAreaText()
ControllingAreaText(String language, String controllingArea, String controllingAreaText, ControllingArea toCnsldtnControllingArea)

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 ControllingAreaText.ControllingAreaTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ControllingArea	fetchCnsldtnControllingArea() Fetches the ControllingArea entity (one to one) associated with this entity.
static <T> ControllingAreaTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ControllingAreaTextField<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)
io.vavr.control.Option<ControllingArea>	getCnsldtnControllingAreaIfPresent() Retrieval of associated ControllingArea entity (one to one).
ControllingArea	getCnsldtnControllingAreaOrFetch() Retrieval of associated ControllingArea entity (one to one).
String	getControllingArea() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getControllingAreaText() Constraints: Not nullable, Maximum length: 25
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.
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
Class<ControllingAreaText>	getType()
int	hashCode()
void	setCnsldtnControllingArea(ControllingArea value) Overwrites the associated ControllingArea entity for the loaded navigation property to_CnsldtnControllingArea.
void	setControllingArea(String controllingArea) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setControllingAreaText(String controllingAreaText) 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 ControllingAreaTextSelectable ALL_FIELDS

Selector for all available fields of ControllingAreaText.

LANGUAGE

public static final ControllingAreaTextField<String> LANGUAGE

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

CONTROLLING_AREA

public static final ControllingAreaTextField<String> CONTROLLING_AREA

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

CONTROLLING_AREA_TEXT

public static final ControllingAreaTextField<String> CONTROLLING_AREA_TEXT

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

TO_CNSLDTN_CONTROLLING_AREA

public static final ControllingAreaTextOneToOneLink<ControllingArea> TO_CNSLDTN_CONTROLLING_AREA

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

Constructor Detail

ControllingAreaText

public ControllingAreaText()

ControllingAreaText

public ControllingAreaText(@Nullable
                           String language,
                           @Nullable
                           String controllingArea,
                           @Nullable
                           String controllingAreaText,
                           @Nullable
                           ControllingArea toCnsldtnControllingArea)

Method Detail

getType

@Nonnull
public Class<ControllingAreaText> getType()

Specified by:

getType in class VdmObject<ControllingAreaText>

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

Parameters:

language - The language to set.

setControllingArea

public void setControllingArea(@Nullable
                               String controllingArea)

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

Original property name from the Odata EDM: ControllingArea

Parameters:

controllingArea - Controlling Area

setControllingAreaText

public void setControllingAreaText(@Nullable
                                   String controllingAreaText)

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: ControllingAreaText

Parameters:

controllingAreaText - Controlling Area Description

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ControllingAreaText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ControllingAreaText>

fromMap

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

Overrides:

fromMap in class VdmObject<ControllingAreaText>

field

@Nonnull
public static <T> ControllingAreaTextField<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> ControllingAreaTextField<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<ControllingAreaText>

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

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

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

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

fetchCnsldtnControllingArea

@Nullable
public ControllingArea fetchCnsldtnControllingArea()
                                                      throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnControllingAreaOrFetch

@Nullable
public ControllingArea getCnsldtnControllingAreaOrFetch()
                                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ControllingArea entity (one to one). This corresponds to the OData navigation property to_CnsldtnControllingArea.

If the navigation property to_CnsldtnControllingArea of a queried ControllingAreaText 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 ControllingArea 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.

getCnsldtnControllingAreaIfPresent

@Nonnull
public io.vavr.control.Option<ControllingArea> getCnsldtnControllingAreaIfPresent()

Retrieval of associated ControllingArea entity (one to one). This corresponds to the OData navigation property to_CnsldtnControllingArea.

If the navigation property for an entity ControllingAreaText 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_CnsldtnControllingArea is already loaded, the result will contain the ControllingArea entity. If not, an Option with result state empty is returned.

setCnsldtnControllingArea

public void setCnsldtnControllingArea(ControllingArea value)

Overwrites the associated ControllingArea entity for the loaded navigation property to_CnsldtnControllingArea.

Parameters:

value - New ControllingArea entity.

builder

public static ControllingAreaText.ControllingAreaTextBuilder builder()

getLanguage

@Nullable
public String getLanguage()

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

Original property name from the Odata EDM: Language

Returns:

The language contained in this entity.

getControllingArea

@Nullable
public String getControllingArea()

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

Original property name from the Odata EDM: ControllingArea

Returns:

Controlling Area

getControllingAreaText

@Nullable
public String getControllingAreaText()

Constraints: Not nullable, Maximum length: 25

Original property name from the Odata EDM: ControllingAreaText

Returns:

Controlling Area Description

toString

public String toString()

Overrides:

toString in class VdmObject<ControllingAreaText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ControllingAreaText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ControllingAreaText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ControllingAreaText>