
com.sap.cloud.sdk.s4hana.datamodel.odata.services.PricingProcedureInPurchasingService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionTypeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionTypeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.batch.PricingProcedureInPurchasingServiceBatch;
/**
*
* This inbound service enables external applications to read pricing procedure data in Purchasing through API calls.
* The service contains pricing procedure, pricing procedure item data, condition type, and description entities.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_PURGPRICINGPROCEDURE_SRV";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
PricingProcedureInPurchasingService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeText
* PurgPrcgCndnTypeText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeText
* PurgPrcgCndnTypeText} entities. This fluent helper allows methods which modify the underlying query to be
* called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPrcgCndnTypeTextFluentHelper getAllPurgPrcgCndnTypeText();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeText
* PurgPrcgCndnTypeText} entity using key fields.
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @param conditionType
* The condition type is used for different functions. In pricing, for example, the condition type lets
* you differentiate between different kinds of discount; in output determination, between different
* output types such as order confirmation or delivery note; in batch determination, between different
* strategy types.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeText
* PurgPrcgCndnTypeText} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgCndnTypeTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPrcgCndnTypeTextByKeyFluentHelper getPurgPrcgCndnTypeTextByKey(
final String language,
final String conditionUsage,
final String conditionApplication,
final String conditionType );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemText
* PurgPrcgProcedItemText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemText
* PurgPrcgProcedItemText} entities. This fluent helper allows methods which modify the underlying query to
* be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPrcgProcedItemTextFluentHelper getAllPurgPrcgProcedItemText();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemText
* PurgPrcgProcedItemText} entity using key fields.
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @param pricingProcedure
* Specifies the conditions that are allowed for a document and defines the sequence in which they are
* used.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemText
* PurgPrcgProcedItemText} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPrcgProcedItemTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPrcgProcedItemTextByKeyFluentHelper getPurgPrcgProcedItemTextByKey(
final String language,
final String conditionUsage,
final String conditionApplication,
final String pricingProcedure,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionType
* PurgPricingConditionType} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionType
* PurgPricingConditionType} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionTypeFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingConditionTypeFluentHelper getAllPurgPricingConditionType();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionType
* PurgPricingConditionType} entity using key fields.
*
* @param conditionType
* The condition type is used for different functions. In pricing, for example, the condition type lets
* you differentiate between different kinds of discount; in output determination, between different
* output types such as order confirmation or delivery note; in batch determination, between different
* strategy types.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionType
* PurgPricingConditionType} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingConditionTypeByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingConditionTypeByKeyFluentHelper getPurgPricingConditionTypeByKey(
final String conditionUsage,
final String conditionApplication,
final String conditionType );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedure
* PurgPricingProcedure} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedure
* PurgPricingProcedure} entities. This fluent helper allows methods which modify the underlying query to be
* called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureFluentHelper getAllPurgPricingProcedure();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedure
* PurgPricingProcedure} entity using key fields.
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @param pricingProcedure
* Specifies the conditions that are allowed for a document and defines the sequence in which they are
* used.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedure
* PurgPricingProcedure} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureByKeyFluentHelper getPurgPricingProcedureByKey(
final String conditionUsage,
final String conditionApplication,
final String pricingProcedure );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItem
* PurgPricingProcedureItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItem
* PurgPricingProcedureItem} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureItemFluentHelper getAllPurgPricingProcedureItem();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItem
* PurgPricingProcedureItem} entity using key fields.
*
* @param pricingProcedureCounter
* Access number of the conditions within a step in the pricing procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param pricingProcedureStep
* Number that determines the sequence of the condition within a procedure.
*
* Constraints: Not nullable, Maximum length: 3
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @param pricingProcedure
* Specifies the conditions that are allowed for a document and defines the sequence in which they are
* used.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItem
* PurgPricingProcedureItem} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureItemByKeyFluentHelper getPurgPricingProcedureItemByKey(
final String conditionUsage,
final String conditionApplication,
final String pricingProcedure,
final String pricingProcedureStep,
final String pricingProcedureCounter );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureText
* PurgPricingProcedureText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureText
* PurgPricingProcedureText} entities. This fluent helper allows methods which modify the underlying query
* to be called before executing the query itself. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureTextFluentHelper getAllPurgPricingProcedureText();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureText
* PurgPricingProcedureText} entity using key fields.
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @param conditionUsage
* Determines for which area the condition is used (for example, pricing or output).
*
* Constraints: Not nullable, Maximum length: 1
*
* @param conditionApplication
* Subdivides the usage of a condition (for example, pricing) for use in different application areas (for
* example, sales & distribution or purchasing).
*
* Constraints: Not nullable, Maximum length: 2
*
* @param pricingProcedure
* Specifies the conditions that are allowed for a document and defines the sequence in which they are
* used.
*
* Constraints: Not nullable, Maximum length: 6
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureText
* PurgPricingProcedureText} 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.pricingprocedureinpurchasing.PurgPricingProcedureTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
PurgPricingProcedureTextByKeyFluentHelper getPurgPricingProcedureTextByKey(
final String language,
final String conditionUsage,
final String conditionApplication,
final String pricingProcedure );
}