Package com.sap.cloud.sdk.s4hana.datamodel.odatav4.services

Class DefaultSettlementDocumentTypeService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, SettlementDocumentTypeService

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

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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 Business Accelerator Hub

Details:

OData Service:	SETTLMTDOCTYPE_0001
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Logistics - Settlement Document Type Integration(SAP_COM_0709)
Scope Items:	Sales Rebate Processing(1B6), Purchasing Rebate Processing(2R7), Sales Commissions - External Sales Representative(2TT), Internal Commissions Settlement with SAP Sales Cloud(3TD)
Authentication Methods:	x509
Service Group Name:	API_SETTLMT_DOC_TYPE
Business Object:	Settlement Document Type

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	countSetlMgmtHdrTxtObjTypeAssgmt()	Deprecated. Fetch the number of entries from the SetlMgmtHdrTxtObjTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	countSetlMgmtItmTxtObjTypeAssgmt()	Deprecated. Fetch the number of entries from the SetlMgmtItmTxtObjTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocType>	countSettlmtDocType()	Deprecated. Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.
GetAllRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getAllSetlMgmtHdrTxtObjTypeAssgmt()	Deprecated. Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getAllSetlMgmtItmTxtObjTypeAssgmt()	Deprecated. Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.
GetAllRequestBuilder<SettlmtDocType>	getAllSettlmtDocType()	Deprecated. Fetch multiple SettlmtDocType entities.
String	getServicePath()	Deprecated.
GetByKeyRequestBuilder<SetlMgmtHdrTxtObjTypeAssgmt>	getSetlMgmtHdrTxtObjTypeAssgmtByKey(String settlmtHdrTxtDetnProced, String settlmtMgmtHdrTxtObjType)	Deprecated. Fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SetlMgmtItmTxtObjTypeAssgmt>	getSetlMgmtItmTxtObjTypeAssgmtByKey(String settlmtItmTxtDetnProced, String settlmtMgmtItmTxtObjType)	Deprecated. Fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocType>	getSettlmtDocTypeByKey(String settlmtDocType)	Deprecated. Fetch a single SettlmtDocType entity using key fields.
DefaultSettlementDocumentTypeService	withServicePath(String servicePath)	Deprecated. 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

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultSettlementDocumentTypeService

public DefaultSettlementDocumentTypeService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultSettlementDocumentTypeService withServicePath(@Nonnull
 String servicePath)

Deprecated.

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

Deprecated.

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

Deprecated.

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities.

Specified by:

getAllSetlMgmtHdrTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A request builder to fetch multiple SetlMgmtHdrTxtObjTypeAssgmt entities. This request builder 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()

Deprecated.

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 request builder to fetch the count of SetlMgmtHdrTxtObjTypeAssgmt entities. This request builder 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(String settlmtHdrTxtDetnProced,
 String settlmtMgmtHdrTxtObjType)

Deprecated.

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 request builder to fetch a single SetlMgmtHdrTxtObjTypeAssgmt entity using key fields. This request builder 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()

Deprecated.

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities.

Specified by:

getAllSetlMgmtItmTxtObjTypeAssgmt in interface SettlementDocumentTypeService

Returns:

A request builder to fetch multiple SetlMgmtItmTxtObjTypeAssgmt entities. This request builder 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()

Deprecated.

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 request builder to fetch the count of SetlMgmtItmTxtObjTypeAssgmt entities. This request builder 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(String settlmtItmTxtDetnProced,
 String settlmtMgmtItmTxtObjType)

Deprecated.

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 request builder to fetch a single SetlMgmtItmTxtObjTypeAssgmt entity using key fields. This request builder 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()

Deprecated.

Description copied from interface: SettlementDocumentTypeService

Fetch multiple SettlmtDocType entities.

Specified by:

getAllSettlmtDocType in interface SettlementDocumentTypeService

Returns:

A request builder to fetch multiple SettlmtDocType entities. This request builder 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()

Deprecated.

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 request builder to fetch the count of SettlmtDocType entities. This request builder 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(String settlmtDocType)

Deprecated.

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 request builder to fetch a single SettlmtDocType entity using key fields. This request builder 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()

Deprecated.

Specified by:

getServicePath in interface ServiceWithNavigableEntities