com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ConditionContractTypeService

All Superinterfaces:

BatchService<ConditionContractTypeServiceBatch>

All Known Implementing Classes:

DefaultConditionContractTypeService

public interface ConditionContractTypeService
extends BatchService<ConditionContractTypeServiceBatch>

This inbound service enables you to read the data defined for different types of condition contracts in SAP S/4HANA Cloud, which determines the behavior and layout of a condition contract. It is based on the OData protocol and can be consumed in SAP Fiori apps and in other user interfaces. In every API call, you can make use of the following operations: - You can retrieve condition contract types. - You can retrieve business volume field combinations based on a contract type. - You can retrieve field name assignments to business volume field combination types used in condition contract settlement processes..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CONDITION_CONTRACT_TYPE
API Version:	1
Communication Scenario:	Logistics - Condition Contract Integration (SAP_COM_0335)
Scope Items:	Sales Rebate Processing (1B6), Purchasing Rebate Processing (2R7), Sales Commissions - External Sales Representative (2TT)
Authentication Methods:	Basic, x509
Business Object:	ConditionContract

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BusVolFldCombnSetTypeAssgmtFluentHelper	getAllBusVolFldCombnSetTypeAssgmt() Fetch multiple BusVolFldCombnSetTypeAssgmt entities.
CndnContrTypeFluentHelper	getAllCndnContrType() Fetch multiple CndnContrType entities.
BusVolFldCombnSetTypeAssgmtByKeyFluentHelper	getBusVolFldCombnSetTypeAssgmtByKey(String cndnContrType, String busVolFldCombnSet, String busVolFieldCombnType) Fetch a single BusVolFldCombnSetTypeAssgmt entity using key fields.
CndnContrTypeByKeyFluentHelper	getCndnContrTypeByKey(String cndnContrType) Fetch a single CndnContrType entity using key fields.
ConditionContractTypeService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
ConditionContractTypeService withServicePath(@Nonnull
                                                      String servicePath)

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

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllBusVolFldCombnSetTypeAssgmt

@Nonnull
BusVolFldCombnSetTypeAssgmtFluentHelper getAllBusVolFldCombnSetTypeAssgmt()

Fetch multiple BusVolFldCombnSetTypeAssgmt entities.

Returns:

A fluent helper to fetch multiple BusVolFldCombnSetTypeAssgmt 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 fluent helper object.

getBusVolFldCombnSetTypeAssgmtByKey

@Nonnull
BusVolFldCombnSetTypeAssgmtByKeyFluentHelper getBusVolFldCombnSetTypeAssgmtByKey(String cndnContrType,
                                                                                          String busVolFldCombnSet,
                                                                                          String busVolFieldCombnType)

Fetch a single BusVolFldCombnSetTypeAssgmt entity using key fields.

Parameters:

busVolFldCombnSet - The set of field combinations groups single field combinations to allow a flexible configuration of selection criteria for the business volume selection in the condition contract settlement process.

Constraints: Not nullable, Maximum length: 4

busVolFieldCombnType - Contains one or multiple fields that serve as selection criteria for the business volume data selection from the business volume table.

Constraints: Not nullable, Maximum length: 4

cndnContrType - Classification used to differentiate between different types of condition contracts.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single BusVolFldCombnSetTypeAssgmt 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 fluent helper object.

getAllCndnContrType

@Nonnull
CndnContrTypeFluentHelper getAllCndnContrType()

Fetch multiple CndnContrType entities.

Returns:

A fluent helper to fetch multiple CndnContrType 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 fluent helper object.

getCndnContrTypeByKey

@Nonnull
CndnContrTypeByKeyFluentHelper getCndnContrTypeByKey(String cndnContrType)

Fetch a single CndnContrType entity using key fields.

Parameters:

cndnContrType - Classification used to differentiate between different types of condition contracts.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single CndnContrType 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 fluent helper object.