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

Class LedgerText

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.ledger.LedgerText

public class LedgerText
extends VdmEntity<LedgerText>

API Ledger Text

Original entity name from the Odata EDM: A_LedgerTextType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static LedgerTextSelectable	ALL_FIELDS Selector for all available fields of LedgerText.
static LedgerTextField<String>	LANGUAGE Use with available fluent helpers to apply the Language field to query operations.
static LedgerTextField<String>	LEDGER Use with available fluent helpers to apply the Ledger field to query operations.
static LedgerTextField<String>	LEDGER_NAME Use with available fluent helpers to apply the LedgerName field to query operations.
static LedgerTextOneToOneLink<Ledger>	TO_LEDGER Use with available fluent helpers to apply the to_Ledger navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
LedgerText()
LedgerText(String ledger, String language, String ledgerName, Ledger toLedger)

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 LedgerText.LedgerTextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Ledger	fetchLedger() Fetches the Ledger entity (one to one) associated with this entity.
static <T> LedgerTextField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> LedgerTextField<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()
HttpDestinationProperties	getDestinationForFetch() Convienence field for reusing the same destination with multiple queries (e.g.
protected String	getEntityCollection()
protected Map<String,Object>	getKey()
String	getLanguage() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getLedger() (Key Field) Constraints: Not nullable, Maximum length: 2
io.vavr.control.Option<Ledger>	getLedgerIfPresent() Retrieval of associated Ledger entity (one to one).
String	getLedgerName() Constraints: Not nullable, Maximum length: 30
Ledger	getLedgerOrFetch() Retrieval of associated Ledger entity (one to one).
Class<LedgerText>	getType()
int	hashCode()
void	setLanguage(String language) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setLedger(Ledger value) Overwrites the associated Ledger entity for the loaded navigation property to_Ledger.
void	setLedger(String ledger) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setLedgerName(String ledgerName) Constraints: Not nullable, Maximum length: 30
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 LedgerTextSelectable ALL_FIELDS

Selector for all available fields of LedgerText.

LEDGER

public static final LedgerTextField<String> LEDGER

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

LANGUAGE

public static final LedgerTextField<String> LANGUAGE

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

LEDGER_NAME

public static final LedgerTextField<String> LEDGER_NAME

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

TO_LEDGER

public static final LedgerTextOneToOneLink<Ledger> TO_LEDGER

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

Constructor Detail

LedgerText

public LedgerText()

LedgerText

public LedgerText(@Nullable
                  String ledger,
                  @Nullable
                  String language,
                  @Nullable
                  String ledgerName,
                  @Nullable
                  Ledger toLedger)

Method Detail

getType

@Nonnull
public Class<LedgerText> getType()

Specified by:

getType in class VdmObject<LedgerText>

Returns:

The class of this object.

setLedger

public void setLedger(@Nullable
                      String ledger)

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

Original property name from the Odata EDM: Ledger

Parameters:

ledger - Identifies a ledger in General Ledger Accounting.

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

setLedgerName

public void setLedgerName(@Nullable
                          String ledgerName)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: LedgerName

Parameters:

ledgerName - Ledger Name

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<LedgerText>

getKey

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

Overrides:

getKey in class VdmObject<LedgerText>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<LedgerText>

fromMap

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

Overrides:

fromMap in class VdmObject<LedgerText>

field

@Nonnull
public static <T> LedgerTextField<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> LedgerTextField<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<LedgerText>

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

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

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()

Overrides:

getDefaultServicePath in class VdmEntity<LedgerText>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<LedgerText>

fetchLedger

@Nullable
public Ledger fetchLedger()
                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

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

Returns:

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

getLedgerOrFetch

@Nullable
public Ledger getLedgerOrFetch()
                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated Ledger entity (one to one). This corresponds to the OData navigation property to_Ledger.

If the navigation property to_Ledger of a queried LedgerText 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 Ledger 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.

getLedgerIfPresent

@Nonnull
public io.vavr.control.Option<Ledger> getLedgerIfPresent()

Retrieval of associated Ledger entity (one to one). This corresponds to the OData navigation property to_Ledger.

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

setLedger

public void setLedger(Ledger value)

Overwrites the associated Ledger entity for the loaded navigation property to_Ledger.

Parameters:

value - New Ledger entity.

builder

public static LedgerText.LedgerTextBuilder builder()

getLedger

@Nullable
public String getLedger()

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

Original property name from the Odata EDM: Ledger

Returns:

Identifies a ledger in General Ledger Accounting.

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

getLedgerName

@Nullable
public String getLedgerName()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: LedgerName

Returns:

Ledger Name

toString

public String toString()

Overrides:

toString in class VdmObject<LedgerText>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<LedgerText>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<LedgerText>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<LedgerText>