com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services

Class DefaultSettlementDocumentTypeService

java.lang.Object

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.DefaultSettlementDocumentTypeService

All Implemented Interfaces:

ServiceWithNavigableEntities, SettlementDocumentTypeService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.DefaultSettlementDocumentTypeService")
public class DefaultSettlementDocumentTypeService
extends Object
implements ServiceWithNavigableEntities, SettlementDocumentTypeService

You retrieve the following data using this OData based service: You can read the Settlement Document Types and related information. You can navigate to the Header Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on header level. You can navigate to the Item Text Object Type Assignment for a Settlement Document Type and read the assigned Text Determination Procedure and all the possible Text Object Types linked to it on item level. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SETTLMT_DOC_TYPE_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Settlement Document Type

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.SettlementDocumentTypeService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSettlementDocumentTypeService() Creates a service using SettlementDocumentTypeService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	countSetlMgmtHdrTxtObjTypeAssgmt() Fetch the number of entries from the SetlMgmtHdrTxtObjTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	countSetlMgmtItmTxtObjTypeAssgmt() Fetch the number of entries from the SetlMgmtItmTxtObjTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocType>	countSettlmtDocType() Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.
GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getAllSetlMgmtHdrTxtObjTypeAssgmt() Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getAllSetlMgmtItmTxtObjTypeAssgmt() Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SettlmtDocType>	getAllSettlmtDocType() Fetch multiple SettlmtDocType entities.
String	getServicePath() Getter for the OData service root path.
GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType) Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType) Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocType>	getSettlmtDocTypeByKey(String settlmtDocType) Fetch a single SettlmtDocType entity using key fields.
DefaultSettlementDocumentTypeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultSettlementDocumentTypeService

public DefaultSettlementDocumentTypeService()

Creates a service using SettlementDocumentTypeService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultSettlementDocumentTypeService withServicePath(@Nonnull
                                                                     String servicePath)

Description copied from interface: SettlementDocumentTypeService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface SettlementDocumentTypeService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: SettlementDocumentTypeService

Creates a batch request builder object.

Specified by:

batch in interface SettlementDocumentTypeService

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllSetlMgmtHdrTxtObjTypeAssgmt

@Nonnull
public GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getAllSetlMgmtHdrTxtObjTypeAssgmt()

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.

Specified by:

getAllSetlMgmtHdrTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSetlMgmtHdrTxtObjTypeAssgmt

@Nonnull
public CountRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> countSetlMgmtHdrTxtObjTypeAssgmt()

Description copied from interface: SettlementDocumentTypeService

Fetch the number of entries from the SetlMgmtHdrTxtObjTypeAssgmt entity collection matching the filter and search expressions.

Specified by:

countSetlMgmtHdrTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch the count of SetlMgmtHdrTxtObjTypeAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSetlMgmtHdrTxtObjTypeAssgmtByKey

@Nonnull
public GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt> getSetlMgmtHdrTxtObjTypeAssgmtByKey(@Nonnull
                                                                                                        String settlmtHdrTxtDetnProced,
                                                                                                        @Nonnull
                                                                                                        String settlmtMgmtHdrTxtObjType)

Description copied from interface: SettlementDocumentTypeService

Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.

Specified by:

getSetlMgmtHdrTxtObjTypeAssgmtByKey in interface SettlementDocumentTypeService

Parameters:

settlmtHdrTxtDetnProced - Text Determination Procedure for Header

Constraints: Not nullable, Maximum length: 2

settlmtMgmtHdrTxtObjType - Specific Text ID for a Settlement Management Document Header

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllSetlMgmtItmTxtObjTypeAssgmt

@Nonnull
public GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getAllSetlMgmtItmTxtObjTypeAssgmt()

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.

Specified by:

getAllSetlMgmtItmTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSetlMgmtItmTxtObjTypeAssgmt

@Nonnull
public CountRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> countSetlMgmtItmTxtObjTypeAssgmt()

Description copied from interface: SettlementDocumentTypeService

Fetch the number of entries from the SetlMgmtItmTxtObjTypeAssgmt entity collection matching the filter and search expressions.

Specified by:

countSetlMgmtItmTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch the count of SetlMgmtItmTxtObjTypeAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSetlMgmtItmTxtObjTypeAssgmtByKey

@Nonnull
public GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt> getSetlMgmtItmTxtObjTypeAssgmtByKey(@Nonnull
                                                                                                        String settlmtItmTxtDetnProced,
                                                                                                        @Nonnull
                                                                                                        String settlmtMgmtItmTxtObjType)

Description copied from interface: SettlementDocumentTypeService

Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.

Specified by:

getSetlMgmtItmTxtObjTypeAssgmtByKey in interface SettlementDocumentTypeService

Parameters:

settlmtItmTxtDetnProced - Text Determination Procedure for Item

Constraints: Not nullable, Maximum length: 2

settlmtMgmtItmTxtObjType - Specific Text ID for a Settlement Management Document Item

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getAllSettlmtDocType

@Nonnull
public GetAllRequestBuilder<SettlmtDocType> getAllSettlmtDocType()

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SettlmtDocType entities.

Specified by:

getAllSettlmtDocType in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch multiple SettlmtDocType entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countSettlmtDocType

@Nonnull
public CountRequestBuilder<SettlmtDocType> countSettlmtDocType()

Description copied from interface: SettlementDocumentTypeService

Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.

Specified by:

countSettlmtDocType in interface SettlementDocumentTypeService

Returns:

A fluent helper to fetch the count of SettlmtDocType entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getSettlmtDocTypeByKey

@Nonnull
public GetByKeyRequestBuilder<SettlmtDocType> getSettlmtDocTypeByKey(@Nonnull
                                                                              String settlmtDocType)

Description copied from interface: SettlementDocumentTypeService

Fetch a single SettlmtDocType entity using key fields.

Specified by:

getSettlmtDocTypeByKey in interface SettlementDocumentTypeService

Parameters:

settlmtDocType - Settlement Document Type

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SettlmtDocType entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.