com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.settlementdocumenttype

Class SettlmtDocType

java.lang.Object

com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject<EntityT>

com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity<SettlmtDocType>

com.sap.cloud.sdk.s4hana.datamodel.odatav4.namespaces.settlementdocumenttype.SettlmtDocType

public class SettlmtDocType
extends VdmEntity<SettlmtDocType>

Settlement Document Types

Original entity name from the Odata EDM: SettlmtDocTypeType

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleProperty<SettlmtDocType>	ALL_FIELDS Selector for all available fields of SettlmtDocType.
static SimpleProperty.String<SettlmtDocType>	JOURNAL_ENTRY_TYPE
static SimpleProperty.String<SettlmtDocType>	SETTLMT_BUS_PROC_VAR
static SimpleProperty.String<SettlmtDocType>	SETTLMT_CAT
static SimpleProperty.String<SettlmtDocType>	SETTLMT_DOC_CAT
static SimpleProperty.String<SettlmtDocType>	SETTLMT_DOC_TYPE
static SimpleProperty.String<SettlmtDocType>	SETTLMT_DOC_TYPE_OF_COLLECTION
static SimpleProperty.String<SettlmtDocType>	SETTLMT_MGMT_PRCG_APPL_CAT
static SimpleProperty.String<SettlmtDocType>	SETTLMT_TX_CODE_TX_TYPE_CHK_CAT
static NavigationProperty.Collection<SettlmtDocType,SetlMgmtHdrTxtObjTypeAssgmt>	TO__SETL_MGMT_HDR_TXT_OBJ_TYPE_ASSGMT Use with available request builders to apply the _SetlMgmtHdrTxtObjTypeAssgmt navigation property to query operations.
static NavigationProperty.Collection<SettlmtDocType,SetlMgmtItmTxtObjTypeAssgmt>	TO__SETL_MGMT_ITM_TXT_OBJ_TYPE_ASSGMT Use with available request builders to apply the _SetlMgmtItmTxtObjTypeAssgmt navigation property to query operations.
static NavigationProperty.Single<SettlmtDocType,SettlmtDocType>	TO__SETTLMT_DOC_TYPE_OF_COLLECTION Use with available request builders to apply the _SettlmtDocTypeOfCollection navigation property to query operations.

Fields inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject

changedOriginalFields, ODATA_TYPE_ANNOTATIONS, ODATA_VERSION_ANNOTATIONS

Constructor Summary

Constructors

Constructor and Description
SettlmtDocType()
SettlmtDocType(String settlmtDocType, String settlmtDocCat, String settlmtCat, String settlmtBusProcVar, String settlmtMgmtPrcgApplCat, String settlmtTxCodeTxTypeChkCat, String journalEntryType, String settlmtDocTypeOfCollection, List<SetlMgmtHdrTxtObjTypeAssgmt> to_SetlMgmtHdrTxtObjTypeAssgmt, List<SetlMgmtItmTxtObjTypeAssgmt> to_SetlMgmtItmTxtObjTypeAssgmt, SettlmtDocType to_SettlmtDocTypeOfCollection)

Method Summary

Modifier and Type	Method and Description
void	addSetlMgmtHdrTxtObjTypeAssgmt(SetlMgmtHdrTxtObjTypeAssgmt... entity) Adds elements to the list of associated SetlMgmtHdrTxtObjTypeAssgmt entities.
void	addSetlMgmtItmTxtObjTypeAssgmt(SetlMgmtItmTxtObjTypeAssgmt... entity) Adds elements to the list of associated SetlMgmtItmTxtObjTypeAssgmt entities.
static SettlmtDocType.SettlmtDocTypeBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
protected void	fromMap(Map<String,Object> inputValues) Read entity data from generic map.
protected String	getDefaultServicePath() Used by request builders and navigation property methods to construct OData requests.
protected String	getEntityCollection() Used by request builders and navigation property methods to construct OData requests.
String	getJournalEntryType() Constraints: Not nullable, Maximum length: 2
protected ODataEntityKey	getKey()
String	getOdataType()
io.vavr.control.Option<List<SetlMgmtHdrTxtObjTypeAssgmt>>	getSetlMgmtHdrTxtObjTypeAssgmtIfPresent() Retrieval of associated SetlMgmtHdrTxtObjTypeAssgmt entities (one to many).
io.vavr.control.Option<List<SetlMgmtItmTxtObjTypeAssgmt>>	getSetlMgmtItmTxtObjTypeAssgmtIfPresent() Retrieval of associated SetlMgmtItmTxtObjTypeAssgmt entities (one to many).
String	getSettlmtBusProcVar() Constraints: Not nullable, Maximum length: 4
String	getSettlmtCat() Constraints: Not nullable, Maximum length: 1
String	getSettlmtDocCat() Constraints: Not nullable, Maximum length: 2
String	getSettlmtDocType() (Key Field) Constraints: Not nullable, Maximum length: 4
String	getSettlmtDocTypeOfCollection() Constraints: Not nullable, Maximum length: 4
io.vavr.control.Option<SettlmtDocType>	getSettlmtDocTypeOfCollectionIfPresent() Retrieval of associated SettlmtDocType entity (one to one).
String	getSettlmtMgmtPrcgApplCat() Constraints: Not nullable, Maximum length: 2
String	getSettlmtTxCodeTxTypeChkCat() Constraints: Not nullable, Maximum length: 1
Class<SettlmtDocType>	getType()
int	hashCode()
void	setJournalEntryType(String journalEntryType) Constraints: Not nullable, Maximum length: 2
void	setSetlMgmtHdrTxtObjTypeAssgmt(List<SetlMgmtHdrTxtObjTypeAssgmt> value) Overwrites the list of associated SetlMgmtHdrTxtObjTypeAssgmt entities for the loaded navigation property _SetlMgmtHdrTxtObjTypeAssgmt.
void	setSetlMgmtItmTxtObjTypeAssgmt(List<SetlMgmtItmTxtObjTypeAssgmt> value) Overwrites the list of associated SetlMgmtItmTxtObjTypeAssgmt entities for the loaded navigation property _SetlMgmtItmTxtObjTypeAssgmt.
void	setSettlmtBusProcVar(String settlmtBusProcVar) Constraints: Not nullable, Maximum length: 4
void	setSettlmtCat(String settlmtCat) Constraints: Not nullable, Maximum length: 1
void	setSettlmtDocCat(String settlmtDocCat) Constraints: Not nullable, Maximum length: 2
void	setSettlmtDocType(String settlmtDocType) (Key Field) Constraints: Not nullable, Maximum length: 4
void	setSettlmtDocTypeOfCollection(SettlmtDocType value) Overwrites the associated SettlmtDocType entity for the loaded navigation property _SettlmtDocTypeOfCollection.
void	setSettlmtDocTypeOfCollection(String settlmtDocTypeOfCollection) Constraints: Not nullable, Maximum length: 4
void	setSettlmtMgmtPrcgApplCat(String settlmtMgmtPrcgApplCat) Constraints: Not nullable, Maximum length: 2
void	setSettlmtTxCodeTxTypeChkCat(String settlmtTxCodeTxTypeChkCat) Constraints: Not nullable, Maximum length: 1
protected Map<String,Object>	toMapOfFields() Get all fields as map.
protected Map<String,Object>	toMapOfNavigationProperties() Get navigation properties as map.
String	toString()

Methods inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmEntity

all, attachToService, getDestinationForFetch, getServicePathForFetch, getVersionIdentifier, setDestinationForFetch, setServicePathForFetch, setVersionIdentifier

Methods inherited from class com.sap.cloud.sdk.datamodel.odatav4.core.VdmObject

getAnnotationProperties, 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 SimpleProperty<SettlmtDocType> ALL_FIELDS

Selector for all available fields of SettlmtDocType.

SETTLMT_DOC_TYPE

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_DOC_TYPE

SETTLMT_DOC_CAT

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_DOC_CAT

SETTLMT_CAT

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_CAT

SETTLMT_BUS_PROC_VAR

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_BUS_PROC_VAR

SETTLMT_MGMT_PRCG_APPL_CAT

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_MGMT_PRCG_APPL_CAT

SETTLMT_TX_CODE_TX_TYPE_CHK_CAT

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_TX_CODE_TX_TYPE_CHK_CAT

JOURNAL_ENTRY_TYPE

public static final SimpleProperty.String<SettlmtDocType> JOURNAL_ENTRY_TYPE

SETTLMT_DOC_TYPE_OF_COLLECTION

public static final SimpleProperty.String<SettlmtDocType> SETTLMT_DOC_TYPE_OF_COLLECTION

TO__SETL_MGMT_HDR_TXT_OBJ_TYPE_ASSGMT

public static final NavigationProperty.Collection<SettlmtDocType,SetlMgmtHdrTxtObjTypeAssgmt> TO__SETL_MGMT_HDR_TXT_OBJ_TYPE_ASSGMT

Use with available request builders to apply the _SetlMgmtHdrTxtObjTypeAssgmt navigation property to query operations.

TO__SETL_MGMT_ITM_TXT_OBJ_TYPE_ASSGMT

public static final NavigationProperty.Collection<SettlmtDocType,SetlMgmtItmTxtObjTypeAssgmt> TO__SETL_MGMT_ITM_TXT_OBJ_TYPE_ASSGMT

Use with available request builders to apply the _SetlMgmtItmTxtObjTypeAssgmt navigation property to query operations.

TO__SETTLMT_DOC_TYPE_OF_COLLECTION

public static final NavigationProperty.Single<SettlmtDocType,SettlmtDocType> TO__SETTLMT_DOC_TYPE_OF_COLLECTION

Use with available request builders to apply the _SettlmtDocTypeOfCollection navigation property to query operations.

Constructor Detail

SettlmtDocType

public SettlmtDocType()

SettlmtDocType

public SettlmtDocType(@Nullable
                      String settlmtDocType,
                      @Nullable
                      String settlmtDocCat,
                      @Nullable
                      String settlmtCat,
                      @Nullable
                      String settlmtBusProcVar,
                      @Nullable
                      String settlmtMgmtPrcgApplCat,
                      @Nullable
                      String settlmtTxCodeTxTypeChkCat,
                      @Nullable
                      String journalEntryType,
                      @Nullable
                      String settlmtDocTypeOfCollection,
                      List<SetlMgmtHdrTxtObjTypeAssgmt> to_SetlMgmtHdrTxtObjTypeAssgmt,
                      List<SetlMgmtItmTxtObjTypeAssgmt> to_SetlMgmtItmTxtObjTypeAssgmt,
                      @Nullable
                      SettlmtDocType to_SettlmtDocTypeOfCollection)

Method Detail

getType

@Nonnull
public Class<SettlmtDocType> getType()

Specified by:

getType in class VdmObject<SettlmtDocType>

Returns:

The class of this object.

setSettlmtDocType

public void setSettlmtDocType(@Nullable
                              String settlmtDocType)

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

Original property name from the Odata EDM: SettlmtDocType

Parameters:

settlmtDocType - Settlement Document Type

setSettlmtDocCat

public void setSettlmtDocCat(@Nullable
                             String settlmtDocCat)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SettlmtDocCat

Parameters:

settlmtDocCat - Settlement Document Category

setSettlmtCat

public void setSettlmtCat(@Nullable
                          String settlmtCat)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: SettlmtCat

Parameters:

settlmtCat - Settlement Category

setSettlmtBusProcVar

public void setSettlmtBusProcVar(@Nullable
                                 String settlmtBusProcVar)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SettlmtBusProcVar

Parameters:

settlmtBusProcVar - Settlement Management Process Category

setSettlmtMgmtPrcgApplCat

public void setSettlmtMgmtPrcgApplCat(@Nullable
                                      String settlmtMgmtPrcgApplCat)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SettlmtMgmtPrcgApplCat

Parameters:

settlmtMgmtPrcgApplCat - Application for Price Determination

setSettlmtTxCodeTxTypeChkCat

public void setSettlmtTxCodeTxTypeChkCat(@Nullable
                                         String settlmtTxCodeTxTypeChkCat)

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: SettlmtTxCodeTxTypeChkCat

Parameters:

settlmtTxCodeTxTypeChkCat - Control of Tax Type Check for Tax Codes

setJournalEntryType

public void setJournalEntryType(@Nullable
                                String journalEntryType)

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: JournalEntryType

Parameters:

journalEntryType - Journal Entry Type for Settlement Management Document

setSettlmtDocTypeOfCollection

public void setSettlmtDocTypeOfCollection(@Nullable
                                          String settlmtDocTypeOfCollection)

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SettlmtDocTypeOfCollection

Parameters:

settlmtDocTypeOfCollection - Settlement Doc. Type for Collective Settlement

getEntityCollection

protected String getEntityCollection()

Description copied from class: VdmEntity

Used by request builders and navigation property methods to construct OData requests.

Specified by:

getEntityCollection in class VdmEntity<SettlmtDocType>

Returns:

EDMX name of the entity collection identifier.

getKey

@Nonnull
protected ODataEntityKey getKey()

Overrides:

getKey in class VdmObject<SettlmtDocType>

Returns:

The compound key of this object.

toMapOfFields

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

Description copied from class: VdmObject

Get all fields as map.

Overrides:

toMapOfFields in class VdmObject<SettlmtDocType>

Returns:

The fields as map.

fromMap

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

Description copied from class: VdmObject

Read entity data from generic map.

Overrides:

fromMap in class VdmObject<SettlmtDocType>

Parameters:

inputValues - The key-value map.

getDefaultServicePath

protected String getDefaultServicePath()

Description copied from class: VdmEntity

Used by request builders and navigation property methods to construct OData requests.

Overrides:

getDefaultServicePath in class VdmEntity<SettlmtDocType>

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

Description copied from class: VdmObject

Get navigation properties as map.

Overrides:

toMapOfNavigationProperties in class VdmObject<SettlmtDocType>

Returns:

The navigation properties.

getSetlMgmtHdrTxtObjTypeAssgmtIfPresent

@Nonnull
public io.vavr.control.Option<List<SetlMgmtHdrTxtObjTypeAssgmt>> getSetlMgmtHdrTxtObjTypeAssgmtIfPresent()

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

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

setSetlMgmtHdrTxtObjTypeAssgmt

public void setSetlMgmtHdrTxtObjTypeAssgmt(@Nonnull
                                           List<SetlMgmtHdrTxtObjTypeAssgmt> value)

Overwrites the list of associated SetlMgmtHdrTxtObjTypeAssgmt entities for the loaded navigation property _SetlMgmtHdrTxtObjTypeAssgmt.

If the navigation property _SetlMgmtHdrTxtObjTypeAssgmt of a queried SettlmtDocType 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 SetlMgmtHdrTxtObjTypeAssgmt entities.

addSetlMgmtHdrTxtObjTypeAssgmt

public void addSetlMgmtHdrTxtObjTypeAssgmt(SetlMgmtHdrTxtObjTypeAssgmt... entity)

Adds elements to the list of associated SetlMgmtHdrTxtObjTypeAssgmt entities. This corresponds to the OData navigation property _SetlMgmtHdrTxtObjTypeAssgmt.

If the navigation property _SetlMgmtHdrTxtObjTypeAssgmt of a queried SettlmtDocType 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 SetlMgmtHdrTxtObjTypeAssgmt entities.

getSetlMgmtItmTxtObjTypeAssgmtIfPresent

@Nonnull
public io.vavr.control.Option<List<SetlMgmtItmTxtObjTypeAssgmt>> getSetlMgmtItmTxtObjTypeAssgmtIfPresent()

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

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

setSetlMgmtItmTxtObjTypeAssgmt

public void setSetlMgmtItmTxtObjTypeAssgmt(@Nonnull
                                           List<SetlMgmtItmTxtObjTypeAssgmt> value)

Overwrites the list of associated SetlMgmtItmTxtObjTypeAssgmt entities for the loaded navigation property _SetlMgmtItmTxtObjTypeAssgmt.

If the navigation property _SetlMgmtItmTxtObjTypeAssgmt of a queried SettlmtDocType 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 SetlMgmtItmTxtObjTypeAssgmt entities.

addSetlMgmtItmTxtObjTypeAssgmt

public void addSetlMgmtItmTxtObjTypeAssgmt(SetlMgmtItmTxtObjTypeAssgmt... entity)

Adds elements to the list of associated SetlMgmtItmTxtObjTypeAssgmt entities. This corresponds to the OData navigation property _SetlMgmtItmTxtObjTypeAssgmt.

If the navigation property _SetlMgmtItmTxtObjTypeAssgmt of a queried SettlmtDocType 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 SetlMgmtItmTxtObjTypeAssgmt entities.

getSettlmtDocTypeOfCollectionIfPresent

@Nonnull
public io.vavr.control.Option<SettlmtDocType> getSettlmtDocTypeOfCollectionIfPresent()

Retrieval of associated SettlmtDocType entity (one to one). This corresponds to the OData navigation property _SettlmtDocTypeOfCollection.

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

setSettlmtDocTypeOfCollection

public void setSettlmtDocTypeOfCollection(SettlmtDocType value)

Overwrites the associated SettlmtDocType entity for the loaded navigation property _SettlmtDocTypeOfCollection.

Parameters:

value - New SettlmtDocType entity.

builder

@Nonnull
public static SettlmtDocType.SettlmtDocTypeBuilder builder()

getSettlmtDocType

@Nullable
public String getSettlmtDocType()

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

Original property name from the Odata EDM: SettlmtDocType

Returns:

Settlement Document Type

getSettlmtDocCat

@Nullable
public String getSettlmtDocCat()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SettlmtDocCat

Returns:

Settlement Document Category

getSettlmtCat

@Nullable
public String getSettlmtCat()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: SettlmtCat

Returns:

Settlement Category

getSettlmtBusProcVar

@Nullable
public String getSettlmtBusProcVar()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SettlmtBusProcVar

Returns:

Settlement Management Process Category

getSettlmtMgmtPrcgApplCat

@Nullable
public String getSettlmtMgmtPrcgApplCat()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: SettlmtMgmtPrcgApplCat

Returns:

Application for Price Determination

getSettlmtTxCodeTxTypeChkCat

@Nullable
public String getSettlmtTxCodeTxTypeChkCat()

Constraints: Not nullable, Maximum length: 1

Original property name from the Odata EDM: SettlmtTxCodeTxTypeChkCat

Returns:

Control of Tax Type Check for Tax Codes

getJournalEntryType

@Nullable
public String getJournalEntryType()

Constraints: Not nullable, Maximum length: 2

Original property name from the Odata EDM: JournalEntryType

Returns:

Journal Entry Type for Settlement Management Document

getSettlmtDocTypeOfCollection

@Nullable
public String getSettlmtDocTypeOfCollection()

Constraints: Not nullable, Maximum length: 4

Original property name from the Odata EDM: SettlmtDocTypeOfCollection

Returns:

Settlement Doc. Type for Collective Settlement

toString

@Nonnull
public String toString()

Overrides:

toString in class VdmObject<SettlmtDocType>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class VdmEntity<SettlmtDocType>

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class VdmEntity<SettlmtDocType>

hashCode

public int hashCode()

Overrides:

hashCode in class VdmEntity<SettlmtDocType>

getOdataType

public String getOdataType()

Specified by:

getOdataType in class VdmObject<SettlmtDocType>

Returns:

The EDMX type of this entity.