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

Class ChartOfAccounts

java.lang.Object

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

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

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readchartofaccounts.ChartOfAccounts

public class ChartOfAccounts
extends VdmEntity<ChartOfAccounts>

API Chart Of Accounts

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartOfAccounts.ChartOfAccountsBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static ChartOfAccountsSelectable	ALL_FIELDS Selector for all available fields of ChartOfAccounts.
static ChartOfAccountsField<String>	CHART_OF_ACCOUNTS Use with available fluent helpers to apply the ChartOfAccounts field to query operations.
static ChartOfAccountsField<Boolean>	CHART_OF_ACCTS_IS_BLOCKED Use with available fluent helpers to apply the ChartOfAcctsIsBlocked field to query operations.
static ChartOfAccountsField<String>	CORPORATE_GROUP_CHART_OF_ACCOUNTS Use with available fluent helpers to apply the CorporateGroupChartOfAccounts field to query operations.
static ChartOfAccountsField<String>	MAINTENANCE_LANGUAGE Use with available fluent helpers to apply the MaintenanceLanguage field to query operations.
static ChartOfAccountsLink<ChartOfAccountsText>	TO_TEXT Use with available fluent helpers to apply the to_Text navigation property to query operations.

Constructor Summary

Constructors

Constructor and Description
ChartOfAccounts()
ChartOfAccounts(String chartOfAccounts, String corporateGroupChartOfAccounts, Boolean chartOfAcctsIsBlocked, String maintenanceLanguage, ErpConfigContext erpConfigContext, List<ChartOfAccountsText> toText)

Method Summary

Modifier and Type	Method and Description
void	addText(ChartOfAccountsText... entity) Adds elements to the list of associated ChartOfAccountsText entities.
static ChartOfAccounts.ChartOfAccountsBuilder	builder()
boolean	equals(Object o)
List<ChartOfAccountsText>	fetchText() Fetches the ChartOfAccountsText entities (one to many) associated with this entity.
static <T> ChartOfAccountsField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
String	getChartOfAccounts() (Key Field) Constraints: Not nullable, Maximum length: 4
Boolean	getChartOfAcctsIsBlocked() Constraints: none
String	getCorporateGroupChartOfAccounts() Constraints: Not nullable, Maximum length: 4
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
String	getMaintenanceLanguage() Constraints: Not nullable, Maximum length: 2
List<ChartOfAccountsText>	getTextOrFetch() Retrieval of associated ChartOfAccountsText entities (one to many).
com.google.common.base.Optional<List<ChartOfAccountsText>>	getTextOrNull() Retrieval of associated ChartOfAccountsText entities (one to many).
Class<ChartOfAccounts>	getType()
int	hashCode()
void	setChartOfAccounts(String chartOfAccounts) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setChartOfAcctsIsBlocked(Boolean chartOfAcctsIsBlocked) Constraints: none
void	setCorporateGroupChartOfAccounts(String corporateGroupChartOfAccounts) Constraints: Not nullable, Maximum length: 4
void	setErpConfigContext(ErpConfigContext erpConfigContext) Convienence field for reusing the same ERP system context with multiple queries (e.g.
void	setMaintenanceLanguage(String maintenanceLanguage) Constraints: Not nullable, Maximum length: 2
void	setText(List<ChartOfAccountsText> value) Overwrites the list of associated ChartOfAccountsText 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 ChartOfAccountsSelectable ALL_FIELDS

Selector for all available fields of ChartOfAccounts.

CHART_OF_ACCOUNTS

public static final ChartOfAccountsField<String> CHART_OF_ACCOUNTS

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

CORPORATE_GROUP_CHART_OF_ACCOUNTS

public static final ChartOfAccountsField<String> CORPORATE_GROUP_CHART_OF_ACCOUNTS

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

CHART_OF_ACCTS_IS_BLOCKED

public static final ChartOfAccountsField<Boolean> CHART_OF_ACCTS_IS_BLOCKED

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

MAINTENANCE_LANGUAGE

public static final ChartOfAccountsField<String> MAINTENANCE_LANGUAGE

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

TO_TEXT

public static final ChartOfAccountsLink<ChartOfAccountsText> TO_TEXT

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

Constructor Detail

ChartOfAccounts

@Generated(value="lombok")
public ChartOfAccounts()

ChartOfAccounts

@ConstructorProperties(value={"chartOfAccounts","corporateGroupChartOfAccounts","chartOfAcctsIsBlocked","maintenanceLanguage","erpConfigContext","toText"})
 @Generated(value="lombok")
public ChartOfAccounts(@Nullable
                                                                                                                                                                                                               String chartOfAccounts,
                                                                                                                                                                                                               @Nullable
                                                                                                                                                                                                               String corporateGroupChartOfAccounts,
                                                                                                                                                                                                               @Nullable
                                                                                                                                                                                                               Boolean chartOfAcctsIsBlocked,
                                                                                                                                                                                                               @Nullable
                                                                                                                                                                                                               String maintenanceLanguage,
                                                                                                                                                                                                               @Nullable
                                                                                                                                                                                                               ErpConfigContext erpConfigContext,
                                                                                                                                                                                                               List<ChartOfAccountsText> toText)

Method Detail

getType

public Class<ChartOfAccounts> getType()

Specified by:

getType in class VdmObject<ChartOfAccounts>

Returns:

The class of this object.

field

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

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

Retrieval of associated ChartOfAccountsText entities (one to many).

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

Retrieval of associated ChartOfAccountsText entities (one to many).

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

setText

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

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

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

addText

public void addText(ChartOfAccountsText... entity)

Adds elements to the list of associated ChartOfAccountsText entities.

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

builder

@Generated(value="lombok")
public static ChartOfAccounts.ChartOfAccountsBuilder builder()

getChartOfAccounts

@Nullable
 @Generated(value="lombok")
public String getChartOfAccounts()

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

Returns:

Chart of Accounts

getCorporateGroupChartOfAccounts

@Nullable
 @Generated(value="lombok")
public String getCorporateGroupChartOfAccounts()

Constraints: Not nullable, Maximum length: 4

You can enter a group account number as additional information in the G/L accounts of the chart of accounts you are using. The system checks whether the group account number exists in the corporate chart of accounts. If the structure of the chart of accounts is predetermined by national legal requirements, you can define a corporate chart of accounts. All accounts receive a group account number which is the same for all accounts of that particular type in various different charts of accounts. For consolidation purposes, you can define the balance sheet and P+L by using group account numbers, i.e. they do not need to be defined differently per country.

Returns:

Chart of accounts which is used in the corporate group.

getChartOfAcctsIsBlocked

@Nullable
 @Generated(value="lombok")
public Boolean getChartOfAcctsIsBlocked()

Constraints: none

This is only advisable if charts of accounts are created centrally and accounts are created locally. If this is the case, then the block prevents accounts from being created in the company codes for a chart of accounts that is not yet completed.

Returns:

Indicator which blocks the chart of accounts from being released i.e. no G/L accounts can be created for this chart of accounts in the company codes.

getMaintenanceLanguage

@Nullable
 @Generated(value="lombok")
public String getMaintenanceLanguage()

Constraints: Not nullable, Maximum length: 2

All accounts have a description in this language. Master data can only be displayed or maintained in this language. If you carry out functions with the account, the account name can be displayed both in the maintenance language and in the available alternative languages.

Returns:

Language in which the chart of accounts is created.

getErpConfigContext

@Nullable
 @Generated(value="lombok")
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.

setChartOfAccounts

@Generated(value="lombok")
public void setChartOfAccounts(@Nullable
                                                          String chartOfAccounts)

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

Parameters:

chartOfAccounts -

setCorporateGroupChartOfAccounts

@Generated(value="lombok")
public void setCorporateGroupChartOfAccounts(@Nullable
                                                                        String corporateGroupChartOfAccounts)

Constraints: Not nullable, Maximum length: 4

You can enter a group account number as additional information in the G/L accounts of the chart of accounts you are using. The system checks whether the group account number exists in the corporate chart of accounts. If the structure of the chart of accounts is predetermined by national legal requirements, you can define a corporate chart of accounts. All accounts receive a group account number which is the same for all accounts of that particular type in various different charts of accounts. For consolidation purposes, you can define the balance sheet and P+L by using group account numbers, i.e. they do not need to be defined differently per country.

Parameters:

corporateGroupChartOfAccounts -

setChartOfAcctsIsBlocked

@Generated(value="lombok")
public void setChartOfAcctsIsBlocked(@Nullable
                                                                Boolean chartOfAcctsIsBlocked)

Constraints: none

This is only advisable if charts of accounts are created centrally and accounts are created locally. If this is the case, then the block prevents accounts from being created in the company codes for a chart of accounts that is not yet completed.

Parameters:

chartOfAcctsIsBlocked -

setMaintenanceLanguage

@Generated(value="lombok")
public void setMaintenanceLanguage(@Nullable
                                                              String maintenanceLanguage)

Constraints: Not nullable, Maximum length: 2

All accounts have a description in this language. Master data can only be displayed or maintained in this language. If you carry out functions with the account, the account name can be displayed both in the maintenance language and in the available alternative languages.

Parameters:

maintenanceLanguage -

setErpConfigContext

@Generated(value="lombok")
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

@Generated(value="lombok")
public String toString()

Overrides:

toString in class VdmObject<ChartOfAccounts>

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class VdmObject<ChartOfAccounts>

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class VdmObject<ChartOfAccounts>