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

Class ConsolidationDocumentType

java.lang.Object

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

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

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

public class ConsolidationDocumentType
extends VdmEntity<ConsolidationDocumentType>

Consolidation Document Type

Original entity name from the Odata EDM: ConsolidationDocumentTypeType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ConsolidationDocumentTypeSelectable	ALL_FIELDS Selector for all available fields of ConsolidationDocumentType.
static ConsolidationDocumentTypeField<String>	CONSOLIDATION_BALANCE_CHECK Use with available fluent helpers to apply the ConsolidationBalanceCheck field to query operations.
static ConsolidationDocumentTypeField<String>	CONSOLIDATION_BALANCE_CHECK_TEXT Use with available fluent helpers to apply the ConsolidationBalanceCheck_Text field to query operations.
static ConsolidationDocumentTypeField<String>	CONSOLIDATION_DOCUMENT_TYPE Use with available fluent helpers to apply the ConsolidationDocumentType field to query operations.
static ConsolidationDocumentTypeField<String>	CONSOLIDATION_DOCUMENT_TYPE_TEXT Use with available fluent helpers to apply the ConsolidationDocumentType_Text field to query operations.
static ConsolidationDocumentTypeField<Boolean>	CONSOLIDATION_POSTG_ITEM_AUTO_FLAG Use with available fluent helpers to apply the ConsolidationPostgItemAutoFlag field to query operations.
static ConsolidationDocumentTypeField<Boolean>	DOC_HAS_CREDIT_DEFERRED_TAX Use with available fluent helpers to apply the DocHasCreditDeferredTax field to query operations.
static ConsolidationDocumentTypeField<Boolean>	DOC_HAS_DEBIT_DEFERRED_TAX Use with available fluent helpers to apply the DocHasDebitDeferredTax field to query operations.
static ConsolidationDocumentTypeField<String>	DOCUMENT_TYPE_BUSINESS_APPL Use with available fluent helpers to apply the DocumentTypeBusinessAppl field to query operations.
static ConsolidationDocumentTypeField<String>	DOCUMENT_TYPE_BUSINESS_APPL_TEXT Use with available fluent helpers to apply the DocumentTypeBusinessAppl_Text field to query operations.
static ConsolidationDocumentTypeField<Boolean>	IS_DOCUMENT_POST_IN_GROUP_CURRENCY Use with available fluent helpers to apply the IsDocumentPostInGroupCurrency field to query operations.
static ConsolidationDocumentTypeField<Boolean>	IS_DOCUMENT_POST_IN_LOCAL_CURRENCY Use with available fluent helpers to apply the IsDocumentPostInLocalCurrency field to query operations.
static ConsolidationDocumentTypeField<Boolean>	IS_DOCUMENT_POST_IN_TRANS_CURRENCY Use with available fluent helpers to apply the IsDocumentPostInTransCurrency field to query operations.
static ConsolidationDocumentTypeField<String>	POSTING_LEVEL Use with available fluent helpers to apply the PostingLevel field to query operations.
static ConsolidationDocumentTypeField<String>	POSTING_LEVEL_TEXT Use with available fluent helpers to apply the PostingLevel_Text field to query operations.
static ConsolidationDocumentTypeLink<DocumentTypeHier>	TO_CNSLDTN_DOCUMENT_TYPE_HIER Use with available fluent helpers to apply the to_CnsldtnDocumentTypeHier navigation property to query operations.
static ConsolidationDocumentTypeLink<ConsolidationDocTypeText>	TO_CNSLDTN_DOCUMENT_TYPE_T Use with available fluent helpers to apply the to_CnsldtnDocumentTypeT navigation property to query operations.

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

changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
ConsolidationDocumentType()
ConsolidationDocumentType(String consolidationDocumentType, String consolidationDocumentType_Text, String postingLevel, String postingLevel_Text, String consolidationBalanceCheck, String consolidationBalanceCheck_Text, Boolean consolidationPostgItemAutoFlag, Boolean isDocumentPostInTransCurrency, Boolean isDocumentPostInLocalCurrency, Boolean isDocumentPostInGroupCurrency, Boolean docHasCreditDeferredTax, Boolean docHasDebitDeferredTax, String documentTypeBusinessAppl, String documentTypeBusinessAppl_Text, List<DocumentTypeHier> toCnsldtnDocumentTypeHier, List<ConsolidationDocTypeText> toCnsldtnDocumentTypeT)

Method Summary

Modifier and Type	Method and Description
void	addCnsldtnDocumentTypeHier(DocumentTypeHier... entity) Adds elements to the list of associated DocumentTypeHier entities.
void	addCnsldtnDocumentTypeT(ConsolidationDocTypeText... entity) Adds elements to the list of associated ConsolidationDocTypeText entities.
void	attachToService(String servicePath, HttpDestinationProperties destination) Sets the service path and destination for the fetch commands of this entity.
static ConsolidationDocumentType.ConsolidationDocumentTypeBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<DocumentTypeHier>	fetchCnsldtnDocumentTypeHier() Fetches the DocumentTypeHier entities (one to many) associated with this entity.
List<ConsolidationDocTypeText>	fetchCnsldtnDocumentTypeT() Fetches the ConsolidationDocTypeText entities (one to many) associated with this entity.
static <T> ConsolidationDocumentTypeField<T>	field(String fieldName, Class<T> fieldType) Use with available fluent helpers to apply an extension field to query operations.
static <T,DomainT> ConsolidationDocumentTypeField<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<List<DocumentTypeHier>>	getCnsldtnDocumentTypeHierIfPresent() Retrieval of associated DocumentTypeHier entities (one to many).
List<DocumentTypeHier>	getCnsldtnDocumentTypeHierOrFetch() Retrieval of associated DocumentTypeHier entities (one to many).
io.vavr.control.Option<List<ConsolidationDocTypeText>>	getCnsldtnDocumentTypeTIfPresent() Retrieval of associated ConsolidationDocTypeText entities (one to many).
List<ConsolidationDocTypeText>	getCnsldtnDocumentTypeTOrFetch() Retrieval of associated ConsolidationDocTypeText entities (one to many).
String	getConsolidationBalanceCheck_Text() Constraints: Not nullable, Maximum length: 60
String	getConsolidationBalanceCheck() Constraints: Not nullable, Maximum length: 1
String	getConsolidationDocumentType_Text() Constraints: Not nullable, Maximum length: 30
String	getConsolidationDocumentType() (Key Field) Constraints: Not nullable, Maximum length: 2
Boolean	getConsolidationPostgItemAutoFlag() Constraints: none
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.
Boolean	getDocHasCreditDeferredTax() Constraints: none
Boolean	getDocHasDebitDeferredTax() Constraints: none
String	getDocumentTypeBusinessAppl_Text() Constraints: Not nullable, Maximum length: 60
String	getDocumentTypeBusinessAppl() Constraints: Not nullable, Maximum length: 1
protected String	getEntityCollection() Used by fluent helpers and navigation property methods to construct OData queries.
Boolean	getIsDocumentPostInGroupCurrency() Constraints: none
Boolean	getIsDocumentPostInLocalCurrency() Constraints: none
Boolean	getIsDocumentPostInTransCurrency() Constraints: none
protected Map<String,Object>	getKey()
String	getPostingLevel_Text() Constraints: Not nullable, Maximum length: 30
String	getPostingLevel() Constraints: Not nullable, Maximum length: 2
Class<ConsolidationDocumentType>	getType()
int	hashCode()
void	setCnsldtnDocumentTypeHier(List<DocumentTypeHier> value) Overwrites the list of associated DocumentTypeHier entities for the loaded navigation property to_CnsldtnDocumentTypeHier.
void	setCnsldtnDocumentTypeT(List<ConsolidationDocTypeText> value) Overwrites the list of associated ConsolidationDocTypeText entities for the loaded navigation property to_CnsldtnDocumentTypeT.
void	setConsolidationBalanceCheck_Text(String consolidationBalanceCheck_Text) Constraints: Not nullable, Maximum length: 60
void	setConsolidationBalanceCheck(String consolidationBalanceCheck) Constraints: Not nullable, Maximum length: 1
void	setConsolidationDocumentType_Text(String consolidationDocumentType_Text) Constraints: Not nullable, Maximum length: 30
void	setConsolidationDocumentType(String consolidationDocumentType) (Key Field) Constraints: Not nullable, Maximum length: 2
void	setConsolidationPostgItemAutoFlag(Boolean consolidationPostgItemAutoFlag) Constraints: none
void	setDocHasCreditDeferredTax(Boolean docHasCreditDeferredTax) Constraints: none
void	setDocHasDebitDeferredTax(Boolean docHasDebitDeferredTax) Constraints: none
void	setDocumentTypeBusinessAppl_Text(String documentTypeBusinessAppl_Text) Constraints: Not nullable, Maximum length: 60
void	setDocumentTypeBusinessAppl(String documentTypeBusinessAppl) Constraints: Not nullable, Maximum length: 1
void	setIsDocumentPostInGroupCurrency(Boolean isDocumentPostInGroupCurrency) Constraints: none
void	setIsDocumentPostInLocalCurrency(Boolean isDocumentPostInLocalCurrency) Constraints: none
void	setIsDocumentPostInTransCurrency(Boolean isDocumentPostInTransCurrency) Constraints: none
void	setPostingLevel_Text(String postingLevel_Text) Constraints: Not nullable, Maximum length: 30
void	setPostingLevel(String postingLevel) 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 ConsolidationDocumentTypeSelectable ALL_FIELDS

Selector for all available fields of ConsolidationDocumentType.

CONSOLIDATION_DOCUMENT_TYPE

public static final ConsolidationDocumentTypeField<String> CONSOLIDATION_DOCUMENT_TYPE

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

CONSOLIDATION_DOCUMENT_TYPE_TEXT

public static final ConsolidationDocumentTypeField<String> CONSOLIDATION_DOCUMENT_TYPE_TEXT

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

POSTING_LEVEL

public static final ConsolidationDocumentTypeField<String> POSTING_LEVEL

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

POSTING_LEVEL_TEXT

public static final ConsolidationDocumentTypeField<String> POSTING_LEVEL_TEXT

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

CONSOLIDATION_BALANCE_CHECK

public static final ConsolidationDocumentTypeField<String> CONSOLIDATION_BALANCE_CHECK

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

CONSOLIDATION_BALANCE_CHECK_TEXT

public static final ConsolidationDocumentTypeField<String> CONSOLIDATION_BALANCE_CHECK_TEXT

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

CONSOLIDATION_POSTG_ITEM_AUTO_FLAG

public static final ConsolidationDocumentTypeField<Boolean> CONSOLIDATION_POSTG_ITEM_AUTO_FLAG

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

IS_DOCUMENT_POST_IN_TRANS_CURRENCY

public static final ConsolidationDocumentTypeField<Boolean> IS_DOCUMENT_POST_IN_TRANS_CURRENCY

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

IS_DOCUMENT_POST_IN_LOCAL_CURRENCY

public static final ConsolidationDocumentTypeField<Boolean> IS_DOCUMENT_POST_IN_LOCAL_CURRENCY

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

IS_DOCUMENT_POST_IN_GROUP_CURRENCY

public static final ConsolidationDocumentTypeField<Boolean> IS_DOCUMENT_POST_IN_GROUP_CURRENCY

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

DOC_HAS_CREDIT_DEFERRED_TAX

public static final ConsolidationDocumentTypeField<Boolean> DOC_HAS_CREDIT_DEFERRED_TAX

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

DOC_HAS_DEBIT_DEFERRED_TAX

public static final ConsolidationDocumentTypeField<Boolean> DOC_HAS_DEBIT_DEFERRED_TAX

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

DOCUMENT_TYPE_BUSINESS_APPL

public static final ConsolidationDocumentTypeField<String> DOCUMENT_TYPE_BUSINESS_APPL

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

DOCUMENT_TYPE_BUSINESS_APPL_TEXT

public static final ConsolidationDocumentTypeField<String> DOCUMENT_TYPE_BUSINESS_APPL_TEXT

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

TO_CNSLDTN_DOCUMENT_TYPE_HIER

public static final ConsolidationDocumentTypeLink<DocumentTypeHier> TO_CNSLDTN_DOCUMENT_TYPE_HIER

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

TO_CNSLDTN_DOCUMENT_TYPE_T

public static final ConsolidationDocumentTypeLink<ConsolidationDocTypeText> TO_CNSLDTN_DOCUMENT_TYPE_T

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

Constructor Detail

ConsolidationDocumentType

public ConsolidationDocumentType()

ConsolidationDocumentType

public ConsolidationDocumentType(@Nullable
                                 String consolidationDocumentType,
                                 @Nullable
                                 String consolidationDocumentType_Text,
                                 @Nullable
                                 String postingLevel,
                                 @Nullable
                                 String postingLevel_Text,
                                 @Nullable
                                 String consolidationBalanceCheck,
                                 @Nullable
                                 String consolidationBalanceCheck_Text,
                                 @Nullable
                                 Boolean consolidationPostgItemAutoFlag,
                                 @Nullable
                                 Boolean isDocumentPostInTransCurrency,
                                 @Nullable
                                 Boolean isDocumentPostInLocalCurrency,
                                 @Nullable
                                 Boolean isDocumentPostInGroupCurrency,
                                 @Nullable
                                 Boolean docHasCreditDeferredTax,
                                 @Nullable
                                 Boolean docHasDebitDeferredTax,
                                 @Nullable
                                 String documentTypeBusinessAppl,
                                 @Nullable
                                 String documentTypeBusinessAppl_Text,
                                 List<DocumentTypeHier> toCnsldtnDocumentTypeHier,
                                 List<ConsolidationDocTypeText> toCnsldtnDocumentTypeT)

Method Detail

getType

@Nonnull
public Class<ConsolidationDocumentType> getType()

Specified by:

getType in class VdmObject<ConsolidationDocumentType>

Returns:

The class of this object.

setConsolidationDocumentType

public void setConsolidationDocumentType(@Nullable
                                         String consolidationDocumentType)

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

Original property name from the Odata EDM: ConsolidationDocumentType

Parameters:

consolidationDocumentType - Enter a document type

setConsolidationDocumentType_Text

public void setConsolidationDocumentType_Text(@Nullable
                                              String consolidationDocumentType_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: ConsolidationDocumentType_Text

Parameters:

consolidationDocumentType_Text - Document Type Description

setPostingLevel

public void setPostingLevel(@Nullable
                            String postingLevel)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: PostingLevel

Parameters:

postingLevel - Enter a posting level.

setPostingLevel_Text

public void setPostingLevel_Text(@Nullable
                                 String postingLevel_Text)

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: PostingLevel_Text

Parameters:

postingLevel_Text - Document Type Description

setConsolidationBalanceCheck

public void setConsolidationBalanceCheck(@Nullable
                                         String consolidationBalanceCheck)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: ConsolidationBalanceCheck

Error message when balance not equal to zeroWarning message when balance not equal to zeroNo balance checkWhen at least one balance sheet or income statement item is posted, the system always displays an error message if the balance does not equal zero, regardless of the setting of this field.

Parameters:

consolidationBalanceCheck - This field determines the type of balance check to be used when posting to statistical items:

setConsolidationBalanceCheck_Text

public void setConsolidationBalanceCheck_Text(@Nullable
                                              String consolidationBalanceCheck_Text)

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: ConsolidationBalanceCheck_Text

SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains

Parameters:

consolidationBalanceCheck_Text - This text appears when fixed values are displayed in the F4 help. It explains the possible input values.

setConsolidationPostgItemAutoFlag

public void setConsolidationPostgItemAutoFlag(@Nullable
                                              Boolean consolidationPostgItemAutoFlag)

Constraints: none

Original property name from the Odata EDM: ConsolidationPostgItemAutoFlag

This document type is thereby excluded from use in the automatic consolidation functions.If the indicator is not set, the document type can only be used for automatic posting, and not for manual posting.

Parameters:

consolidationPostgItemAutoFlag - Set this indicator if you want to use the document type for manual posting only.

setIsDocumentPostInTransCurrency

public void setIsDocumentPostInTransCurrency(@Nullable
                                             Boolean isDocumentPostInTransCurrency)

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInTransCurrency

Parameters:

isDocumentPostInTransCurrency - Set this indicator to specify that the document type can post in transaction currency.

setIsDocumentPostInLocalCurrency

public void setIsDocumentPostInLocalCurrency(@Nullable
                                             Boolean isDocumentPostInLocalCurrency)

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInLocalCurrency

Parameters:

isDocumentPostInLocalCurrency - Set this indicator to specify that the document type can post in local currency.

setIsDocumentPostInGroupCurrency

public void setIsDocumentPostInGroupCurrency(@Nullable
                                             Boolean isDocumentPostInGroupCurrency)

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInGroupCurrency

Parameters:

isDocumentPostInGroupCurrency - Set this indicator to specify that the document type can post in group currency.

setDocHasCreditDeferredTax

public void setDocHasCreditDeferredTax(@Nullable
                                       Boolean docHasCreditDeferredTax)

Constraints: none

Original property name from the Odata EDM: DocHasCreditDeferredTax

Parameters:

docHasCreditDeferredTax - Set this indicator if you want this document type to automatically credit deferred taxes during posting.

setDocHasDebitDeferredTax

public void setDocHasDebitDeferredTax(@Nullable
                                      Boolean docHasDebitDeferredTax)

Constraints: none

Original property name from the Odata EDM: DocHasDebitDeferredTax

Parameters:

docHasDebitDeferredTax - Set this indicator if you want this document type to automatically debit deferred taxes during posting.

setDocumentTypeBusinessAppl

public void setDocumentTypeBusinessAppl(@Nullable
                                        String documentTypeBusinessAppl)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: DocumentTypeBusinessAppl

This enables the system to check consolidation tasks by document type.

Parameters:

documentTypeBusinessAppl - You use this field to classify document types according to their application in the consolidation component.

setDocumentTypeBusinessAppl_Text

public void setDocumentTypeBusinessAppl_Text(@Nullable
                                             String documentTypeBusinessAppl_Text)

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: DocumentTypeBusinessAppl_Text

SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains

Parameters:

documentTypeBusinessAppl_Text - This text appears when fixed values are displayed in the F4 help. It explains the possible input values.

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

Returns:

EDMX name of the entity collection identifier.

getKey

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

Overrides:

getKey in class VdmObject<ConsolidationDocumentType>

Returns:

The compound key of this object.

toMapOfFields

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

Overrides:

toMapOfFields in class VdmObject<ConsolidationDocumentType>

fromMap

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

Overrides:

fromMap in class VdmObject<ConsolidationDocumentType>

field

@Nonnull
public static <T> ConsolidationDocumentTypeField<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> ConsolidationDocumentTypeField<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<ConsolidationDocumentType>

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

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

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

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

fetchCnsldtnDocumentTypeHier

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

Fetches the DocumentTypeHier entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnDocumentTypeHier.

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

Returns:

List containing one or more associated DocumentTypeHier 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.

getCnsldtnDocumentTypeHierOrFetch

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

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

If the navigation property to_CnsldtnDocumentTypeHier of a queried ConsolidationDocumentType 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 DocumentTypeHier 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.

getCnsldtnDocumentTypeHierIfPresent

@Nonnull
public io.vavr.control.Option<List<DocumentTypeHier>> getCnsldtnDocumentTypeHierIfPresent()

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

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

setCnsldtnDocumentTypeHier

public void setCnsldtnDocumentTypeHier(@Nonnull
                                       List<DocumentTypeHier> value)

Overwrites the list of associated DocumentTypeHier entities for the loaded navigation property to_CnsldtnDocumentTypeHier.

If the navigation property to_CnsldtnDocumentTypeHier of a queried ConsolidationDocumentType 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 DocumentTypeHier entities.

addCnsldtnDocumentTypeHier

public void addCnsldtnDocumentTypeHier(DocumentTypeHier... entity)

Adds elements to the list of associated DocumentTypeHier entities. This corresponds to the OData navigation property to_CnsldtnDocumentTypeHier.

If the navigation property to_CnsldtnDocumentTypeHier of a queried ConsolidationDocumentType 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 DocumentTypeHier entities.

fetchCnsldtnDocumentTypeT

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

Fetches the ConsolidationDocTypeText entities (one to many) associated with this entity. This corresponds to the OData navigation property to_CnsldtnDocumentTypeT.

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

Returns:

List containing one or more associated ConsolidationDocTypeText 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.

getCnsldtnDocumentTypeTOrFetch

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

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

If the navigation property to_CnsldtnDocumentTypeT of a queried ConsolidationDocumentType 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 ConsolidationDocTypeText 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.

getCnsldtnDocumentTypeTIfPresent

@Nonnull
public io.vavr.control.Option<List<ConsolidationDocTypeText>> getCnsldtnDocumentTypeTIfPresent()

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

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

setCnsldtnDocumentTypeT

public void setCnsldtnDocumentTypeT(@Nonnull
                                    List<ConsolidationDocTypeText> value)

Overwrites the list of associated ConsolidationDocTypeText entities for the loaded navigation property to_CnsldtnDocumentTypeT.

If the navigation property to_CnsldtnDocumentTypeT of a queried ConsolidationDocumentType 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 ConsolidationDocTypeText entities.

addCnsldtnDocumentTypeT

public void addCnsldtnDocumentTypeT(ConsolidationDocTypeText... entity)

Adds elements to the list of associated ConsolidationDocTypeText entities. This corresponds to the OData navigation property to_CnsldtnDocumentTypeT.

If the navigation property to_CnsldtnDocumentTypeT of a queried ConsolidationDocumentType 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 ConsolidationDocTypeText entities.

builder

@Nonnull
public static ConsolidationDocumentType.ConsolidationDocumentTypeBuilder builder()

getConsolidationDocumentType

@Nullable
public String getConsolidationDocumentType()

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

Original property name from the Odata EDM: ConsolidationDocumentType

Returns:

Enter a document type

getConsolidationDocumentType_Text

@Nullable
public String getConsolidationDocumentType_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: ConsolidationDocumentType_Text

Returns:

Document Type Description

getPostingLevel

@Nullable
public String getPostingLevel()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: PostingLevel

Returns:

Enter a posting level.

getPostingLevel_Text

@Nullable
public String getPostingLevel_Text()

Constraints: Not nullable, Maximum length: 30

Original property name from the Odata EDM: PostingLevel_Text

Returns:

Document Type Description

getConsolidationBalanceCheck

@Nullable
public String getConsolidationBalanceCheck()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: ConsolidationBalanceCheck

Error message when balance not equal to zeroWarning message when balance not equal to zeroNo balance checkWhen at least one balance sheet or income statement item is posted, the system always displays an error message if the balance does not equal zero, regardless of the setting of this field.

Returns:

This field determines the type of balance check to be used when posting to statistical items:

getConsolidationBalanceCheck_Text

@Nullable
public String getConsolidationBalanceCheck_Text()

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: ConsolidationBalanceCheck_Text

SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains

Returns:

This text appears when fixed values are displayed in the F4 help. It explains the possible input values.

getConsolidationPostgItemAutoFlag

@Nullable
public Boolean getConsolidationPostgItemAutoFlag()

Constraints: none

Original property name from the Odata EDM: ConsolidationPostgItemAutoFlag

This document type is thereby excluded from use in the automatic consolidation functions.If the indicator is not set, the document type can only be used for automatic posting, and not for manual posting.

Returns:

Set this indicator if you want to use the document type for manual posting only.

getIsDocumentPostInTransCurrency

@Nullable
public Boolean getIsDocumentPostInTransCurrency()

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInTransCurrency

Returns:

Set this indicator to specify that the document type can post in transaction currency.

getIsDocumentPostInLocalCurrency

@Nullable
public Boolean getIsDocumentPostInLocalCurrency()

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInLocalCurrency

Returns:

Set this indicator to specify that the document type can post in local currency.

getIsDocumentPostInGroupCurrency

@Nullable
public Boolean getIsDocumentPostInGroupCurrency()

Constraints: none

Original property name from the Odata EDM: IsDocumentPostInGroupCurrency

Returns:

Set this indicator to specify that the document type can post in group currency.

getDocHasCreditDeferredTax

@Nullable
public Boolean getDocHasCreditDeferredTax()

Constraints: none

Original property name from the Odata EDM: DocHasCreditDeferredTax

Returns:

Set this indicator if you want this document type to automatically credit deferred taxes during posting.

getDocHasDebitDeferredTax

@Nullable
public Boolean getDocHasDebitDeferredTax()

Constraints: none

Original property name from the Odata EDM: DocHasDebitDeferredTax

Returns:

Set this indicator if you want this document type to automatically debit deferred taxes during posting.

getDocumentTypeBusinessAppl

@Nullable
public String getDocumentTypeBusinessAppl()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: DocumentTypeBusinessAppl

This enables the system to check consolidation tasks by document type.

Returns:

You use this field to classify document types according to their application in the consolidation component.

getDocumentTypeBusinessAppl_Text

@Nullable
public String getDocumentTypeBusinessAppl_Text()

Constraints: Not nullable, Maximum length: 60

Original property name from the Odata EDM: DocumentTypeBusinessAppl_Text

SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains

Returns:

This text appears when fixed values are displayed in the F4 help. It explains the possible input values.

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<ConsolidationDocumentType>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmObject<ConsolidationDocumentType>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmObject<ConsolidationDocumentType>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmObject<ConsolidationDocumentType>