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

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.chartofaccounts.ChartOfAccounts

public class ChartOfAccounts
extends VdmEntity<ChartOfAccounts>

API Chart Of Accounts

Original entity name from the Odata EDM: A_ChartOfAccountsType

Nested Class Summary

Nested Classes

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

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.

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

changedOriginalFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addText(ChartOfAccountsText... entity) Adds elements to the list of associated ChartOfAccountsText entities.
void	attachToService(String servicePath, ErpConfigContext configContext) Sets the service path and ERP configuration context for the fetch commands of this entity.
static ChartOfAccounts.ChartOfAccountsBuilder	builder()
protected boolean	canEqual(Object other)
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.
static <T,DomainT> ChartOfAccountsField<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)
String	getChartOfAccounts() (Key Field) Constraints: Not nullable, Maximum length: 4
Boolean	getChartOfAcctsIsBlocked() Constraints: none
String	getCorporateGroupChartOfAccounts() Constraints: Not nullable, Maximum length: 4
protected String	getDefaultServicePath()
protected String	getEntityCollection()
ErpConfigContext	getErpConfigContext() Convienence field for reusing the same ERP system context with multiple queries (e.g.
protected Map<String,Object>	getKey()
String	getMaintenanceLanguage() Constraints: Not nullable, Maximum length: 2
Optional<List<ChartOfAccountsText>>	getTextIfPresent() Retrieval of associated ChartOfAccountsText entities (one to many).
List<ChartOfAccountsText>	getTextOrFetch() 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) Deprecated. Use attachToService(String, ErpConfigContext) instead.
void	setMaintenanceLanguage(String maintenanceLanguage) Constraints: Not nullable, Maximum length: 2
protected void	setServicePathForFetch(String servicePathForFetch) The service path only used for the fetch commands of this entity.
void	setText(List<ChartOfAccountsText> value) Overwrites the list of associated ChartOfAccountsText entities for the loaded navigation property to_Text.
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmEntity

getEndpointUrl, getServicePathForFetch, getVersionIdentifier, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.s4hana.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 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

public ChartOfAccounts()

ChartOfAccounts

public ChartOfAccounts(@Nullable
                       String chartOfAccounts,
                       @Nullable
                       String corporateGroupChartOfAccounts,
                       @Nullable
                       Boolean chartOfAcctsIsBlocked,
                       @Nullable
                       String maintenanceLanguage,
                       List<ChartOfAccountsText> toText)

Method Detail

getType

@Nonnull
public Class<ChartOfAccounts> getType()

Specified by:

getType in class VdmObject<ChartOfAccounts>

Returns:

The class of this object.

setChartOfAccounts

public void setChartOfAccounts(@Nullable
                               String chartOfAccounts)

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

Original property name from the Odata EDM: ChartOfAccounts

Parameters:

chartOfAccounts - Chart of Accounts

setCorporateGroupChartOfAccounts

public void setCorporateGroupChartOfAccounts(@Nullable
                                             String corporateGroupChartOfAccounts)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: CorporateGroupChartOfAccounts

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 - Chart of accounts which is used in the corporate group.

setChartOfAcctsIsBlocked

public void setChartOfAcctsIsBlocked(@Nullable
                                     Boolean chartOfAcctsIsBlocked)

Constraints: none

Original property name from the Odata EDM: ChartOfAcctsIsBlocked

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

setMaintenanceLanguage

public void setMaintenanceLanguage(@Nullable
                                   String maintenanceLanguage)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: MaintenanceLanguage

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 - Language in which the chart of accounts is created.

getEntityCollection

protected String getEntityCollection()

Specified by:

getEntityCollection in class VdmEntity<ChartOfAccounts>

getKey

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

Overrides:

getKey in class VdmObject<ChartOfAccounts>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ChartOfAccounts>

fromMap

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

Overrides:

fromMap in class VdmObject<ChartOfAccounts>

field

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

getErpConfigContext

@Nullable
public ErpConfigContext getErpConfigContext()

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities). New ERP configuration context to apply to this entity

Overrides:

getErpConfigContext in class VdmEntity<ChartOfAccounts>

Returns:

The stored ERP system context for executing queries, or null if no such context has been set.

setErpConfigContext

@Deprecated
public void setErpConfigContext(@Nullable
                                            ErpConfigContext erpConfigContext)

Deprecated. Use attachToService(String, ErpConfigContext) instead.

Description copied from class: VdmEntity

Convienence field for reusing the same ERP system context with multiple queries (e.g. fetching associated entities).

Overrides:

setErpConfigContext in class VdmEntity<ChartOfAccounts>

Parameters:

erpConfigContext - New ERP configuration context to apply to this entity

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

attachToService

public void attachToService(@Nullable
                            String servicePath,
                            @Nullable
                            ErpConfigContext configContext)

Description copied from class: VdmEntity

Sets the service path and ERP configuration context for the fetch commands of this entity. Ensures that both are set to some value by using defaults if null values are provided in the arguments. Existing values are preserved if null values are provided in the arguments. 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<ChartOfAccounts>

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.

configContext - Optional parameter. New ERP configuration context to apply to this entity and any associated entities that were previously fetched. If a null value is provided and the ERP configuration context has never been set, then the ERP configuration context will be set to a new instance of ErpConfigContext.

getDefaultServicePath

protected String getDefaultServicePath()

Overrides:

getDefaultServicePath in class VdmEntity<ChartOfAccounts>

toMapOfNavigationProperties

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

Overrides:

toMapOfNavigationProperties in class VdmObject<ChartOfAccounts>

fetchText

@Nonnull
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

@Nonnull
public List<ChartOfAccountsText> getTextOrFetch()
                                                  throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Retrieval of associated ChartOfAccountsText entities (one to many). This corresponds to the OData 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.

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.

getTextIfPresent

@Nonnull
public Optional<List<ChartOfAccountsText>> getTextIfPresent()

Retrieval of associated ChartOfAccountsText entities (one to many). This corresponds to the OData navigation property to_Text.

If the navigation property for an entity ChartOfAccounts has not been resolved yet, this method will not query further information. Instead its Optional result state will be empty.

Returns:

If the information for navigation property to_Text is already loaded, the result will contain the ChartOfAccountsText entities. If not, an Optional with result state empty 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. This corresponds to the OData 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:

entity - Array of ChartOfAccountsText entities.

builder

public static ChartOfAccounts.ChartOfAccountsBuilder builder()

getChartOfAccounts

@Nullable
public String getChartOfAccounts()

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

Original property name from the Odata EDM: ChartOfAccounts

Returns:

Chart of Accounts

getCorporateGroupChartOfAccounts

@Nullable
public String getCorporateGroupChartOfAccounts()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: CorporateGroupChartOfAccounts

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
public Boolean getChartOfAcctsIsBlocked()

Constraints: none

Original property name from the Odata EDM: ChartOfAcctsIsBlocked

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
public String getMaintenanceLanguage()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: MaintenanceLanguage

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.

toString

public String toString()

Overrides:

toString in class VdmObject<ChartOfAccounts>

equals

public boolean equals(Object o)

Overrides:

equals in class VdmObject<ChartOfAccounts>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class VdmObject<ChartOfAccounts>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ChartOfAccounts>