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

Class ConsolidationUnitText

java.lang.Object

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

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

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

public class ConsolidationUnitText
extends VdmEntity<ConsolidationUnitText>

Consolidation Unit - Text

Original entity name from the Odata EDM: ConsolidationUnitTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConsolidationUnitTextSelectable	ALL_FIELDS Selector for all available fields of ConsolidationUnitText.
static ConsolidationUnitTextField<String>	CONSOLIDATION_UNIT Use with available fluent helpers to apply the ConsolidationUnit field to query operations.
static ConsolidationUnitTextField<String>	CONSOLIDATION_UNIT_TEXT Use with available fluent helpers to apply the ConsolidationUnitText field to query operations.
static ConsolidationUnitTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static ConsolidationUnitTextOneToOneLink<ConsolidationUnit>	TO_CNSLDTN_UNIT Use with available fluent helpers to apply the to_CnsldtnUnit navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ConsolidationUnitText()
ConsolidationUnitText(String consolidationUnit, String language, String consolidationUnitText, ConsolidationUnit toCnsldtnUnit)

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 ConsolidationUnitText.ConsolidationUnitTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ConsolidationUnit	fetchCnsldtnUnit() Fetches the ConsolidationUnit entity (one to one) associated with this entity.
static <T> ConsolidationUnitTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ConsolidationUnitTextField<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<ConsolidationUnit>	getCnsldtnUnitIfPresent() Retrieval of associated ConsolidationUnit entity (one to one).
ConsolidationUnit	getCnsldtnUnitOrFetch() Retrieval of associated ConsolidationUnit entity (one to one).
String	getConsolidationUnit() (Key Field) Constraints: Not nullable, Maximum length: 18
String	getConsolidationUnitText() Constraints: Not nullable, Maximum length: 40
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<ConsolidationUnitText>	getType()
int	hashCode()
void	setCnsldtnUnit(ConsolidationUnit value) Overwrites the associated ConsolidationUnit entity for the loaded navigation property to_CnsldtnUnit.
void	setConsolidationUnit(String consolidationUnit) (Key Field) Constraints: Not nullable, Maximum length: 18
void	setConsolidationUnitText(String consolidationUnitText) Constraints: Not nullable, Maximum length: 40
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 ConsolidationUnitTextSelectable ALL_FIELDS

Selector for all available fields of ConsolidationUnitText.

CONSOLIDATION_UNIT

public static final ConsolidationUnitTextField<String> CONSOLIDATION_UNIT

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

LANGUAGE

public static final ConsolidationUnitTextField<String> LANGUAGE

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

CONSOLIDATION_UNIT_TEXT

public static final ConsolidationUnitTextField<String> CONSOLIDATION_UNIT_TEXT

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

TO_CNSLDTN_UNIT

public static final ConsolidationUnitTextOneToOneLink<ConsolidationUnit> TO_CNSLDTN_UNIT

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

Constructor Detail

ConsolidationUnitText

public ConsolidationUnitText()

ConsolidationUnitText

public ConsolidationUnitText(@Nullable
                             String consolidationUnit,
                             @Nullable
                             String language,
                             @Nullable
                             String consolidationUnitText,
                             @Nullable
                             ConsolidationUnit toCnsldtnUnit)

Method Detail

getType

@Nonnull
public Class<ConsolidationUnitText> getType()

Specified by:

getType in class VdmObject<ConsolidationUnitText>

Returns:

The class of this object.

setConsolidationUnit

public void setConsolidationUnit(@Nullable
                                 String consolidationUnit)

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

Original property name from the Odata EDM: ConsolidationUnit

Parameters:

consolidationUnit - Enter aConsolidation Unit

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

setConsolidationUnitText

public void setConsolidationUnitText(@Nullable
                                     String consolidationUnitText)

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: ConsolidationUnitText

Parameters:

consolidationUnitText - Consolidation Unit 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<ConsolidationUnitText>

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ConsolidationUnitText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ConsolidationUnitText>

fromMap

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

Overrides:

fromMap in class VdmObject<ConsolidationUnitText>

field

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

Overrides:

getDestinationForFetch in class VdmEntity<ConsolidationUnitText>

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

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

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

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

fetchCnsldtnUnit

@Nullable
public ConsolidationUnit fetchCnsldtnUnit()
                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getCnsldtnUnitOrFetch

@Nullable
public ConsolidationUnit getCnsldtnUnitOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ConsolidationUnit entity (one to one). This corresponds to the OData navigation property to_CnsldtnUnit.

If the navigation property to_CnsldtnUnit of a queried ConsolidationUnitText 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 ConsolidationUnit 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.

getCnsldtnUnitIfPresent

@Nonnull
public io.vavr.control.Option<ConsolidationUnit> getCnsldtnUnitIfPresent()

Retrieval of associated ConsolidationUnit entity (one to one). This corresponds to the OData navigation property to_CnsldtnUnit.

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

setCnsldtnUnit

public void setCnsldtnUnit(ConsolidationUnit value)

Overwrites the associated ConsolidationUnit entity for the loaded navigation property to_CnsldtnUnit.

Parameters:

value - New ConsolidationUnit entity.

builder

@Nonnull
public static ConsolidationUnitText.ConsolidationUnitTextBuilder builder()

getConsolidationUnit

@Nullable
public String getConsolidationUnit()

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

Original property name from the Odata EDM: ConsolidationUnit

Returns:

Enter aConsolidation Unit

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

getConsolidationUnitText

@Nullable
public String getConsolidationUnitText()

Constraints: Not nullable, Maximum length: 40

Original property name from the Odata EDM: ConsolidationUnitText

Returns:

Consolidation Unit Description

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<ConsolidationUnitText>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<ConsolidationUnitText>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<ConsolidationUnitText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ConsolidationUnitText>