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

Class Ledger

java.lang.Object

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

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

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

public class Ledger
extends VdmEntity<Ledger>

API Ledger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ledger.LedgerBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static LedgerSelectable	ALL_FIELDS Selector for all available fields of Ledger.
static LedgerField<Boolean>	IS_LEADING_LEDGER Use with available fluent helpers to apply the IsLeadingLedger field to query operations.
static LedgerField<String>	LEDGER Use with available fluent helpers to apply the Ledger field to query operations.
static LedgerField<String>	LEDGER_APPLICATION Use with available fluent helpers to apply the LedgerApplication field to query operations.
static LedgerField<String>	LEDGER_SUB_APPLICATION Use with available fluent helpers to apply the LedgerSubApplication field to query operations.
static LedgerLink<LedgerText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
Ledger()
Ledger(String ledger, Boolean isLeadingLedger, String ledgerApplication, String ledgerSubApplication, ErpConfigContext erpConfigContext, List<LedgerText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(LedgerText... entity) Adds elements to the list of associated LedgerText entities.
static Ledger.LedgerBuilder	builder()
boolean	equals(Object o)
List<LedgerText>	fetchText() Fetches the LedgerText entities (one to many) associated with this entity.
static <T> LedgerField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
Boolean	getIsLeadingLedger() Constraints: noneYou must designate one of your ledgers as the leading ledger.
String	getLedger() (Key Field) Constraints: Not nullable, Maximum length: 2
String	getLedgerApplication() Constraints: Not nullable, Maximum length: 2
String	getLedgerSubApplication() Constraints: Not nullable, Maximum length: 3
List<LedgerText>	getTextOrFetch() Retrieval of associated LedgerText entities (one to many).
com.google.common.base.Optional<List<LedgerText>>	getTextOrNull() Retrieval of associated LedgerText entities (one to many).
Class<Ledger>	getType()
int	hashCode()
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).
void	setIsLeadingLedger(Boolean isLeadingLedger) Constraints: noneYou must designate one of your ledgers as the leading ledger.
void	setLedger(String ledger) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setLedgerApplication(String ledgerApplication) Constraints: Not nullable, Maximum length: 2
void	setLedgerSubApplication(String ledgerSubApplication) Constraints: Not nullable, Maximum length: 3
void	setText(List<LedgerText> value) Overwrites the list of associated LedgerText 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 LedgerSelectable ALL_FIELDS

Selector for all available fields of Ledger.

LEDGER

public static final LedgerField<String> LEDGER

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

IS_LEADING_LEDGER

public static final LedgerField<Boolean> IS_LEADING_LEDGER

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

LEDGER_APPLICATION

public static final LedgerField<String> LEDGER_APPLICATION

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

LEDGER_SUB_APPLICATION

public static final LedgerField<String> LEDGER_SUB_APPLICATION

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

TO_TEXT

public static final LedgerLink<LedgerText> TO_TEXT

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

Constructor Detail

Ledger

public Ledger()

Ledger

public Ledger(@Nullable
              String ledger,
              @Nullable
              Boolean isLeadingLedger,
              @Nullable
              String ledgerApplication,
              @Nullable
              String ledgerSubApplication,
              @Nullable
              ErpConfigContext erpConfigContext,
              List<LedgerText> toText)

Method Detail

getType

public Class<Ledger> getType()

Specified by:

getType in class VdmObject<Ledger>

Returns:

The class of this object.

field

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

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

Retrieval of associated LedgerText entities (one to many).

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

Retrieval of associated LedgerText entities (one to many).

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

setText

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

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

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

addText

public void addText(LedgerText... entity)

Adds elements to the list of associated LedgerText entities.

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

builder

public static Ledger.LedgerBuilder builder()

getLedger

@Nullable
public String getLedger()

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

Returns:

Identifies a ledger in General Ledger Accounting.

getIsLeadingLedger

@Nullable
public Boolean getIsLeadingLedger()

Constraints: none

You must designate one of your ledgers as the leading ledger. However, it is not possible to designate more than one ledger as the leading ledger. Caution: As soon as the leading ledger contains transaction data, the Leading indicator can no longer be deselected.

Returns:

Identifies one of your ledgers as the leading ledger.

getLedgerApplication

@Nullable
public String getLedgerApplication()

Constraints: Not nullable, Maximum length: 2

Returns:

Application to which this object (table or ledger) belongs.

getLedgerSubApplication

@Nullable
public String getLedgerSubApplication()

Constraints: Not nullable, Maximum length: 3

Returns:

Subapplication

getErpConfigContext

@Nullable
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.

setLedger

public void setLedger(@Nullable
                      String ledger)

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

Parameters:

ledger -

setIsLeadingLedger

public void setIsLeadingLedger(@Nullable
                               Boolean isLeadingLedger)

Constraints: none

You must designate one of your ledgers as the leading ledger. However, it is not possible to designate more than one ledger as the leading ledger. Caution: As soon as the leading ledger contains transaction data, the Leading indicator can no longer be deselected.

Parameters:

isLeadingLedger -

setLedgerApplication

public void setLedgerApplication(@Nullable
                                 String ledgerApplication)

Constraints: Not nullable, Maximum length: 2

Parameters:

ledgerApplication -

setLedgerSubApplication

public void setLedgerSubApplication(@Nullable
                                    String ledgerSubApplication)

Constraints: Not nullable, Maximum length: 3

Parameters:

ledgerSubApplication -

setErpConfigContext

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

public String toString()

Overrides:

toString in class VdmObject<Ledger>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<Ledger>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<Ledger>