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

Interface SchedulingAgreementService

All Superinterfaces:

BatchService<SchedulingAgreementServiceBatch>

All Known Implementing Classes:

DefaultSchedulingAgreementService

public interface SchedulingAgreementService
extends BatchService<SchedulingAgreementServiceBatch>

This service enables you to read and create purchase scheduling agreements through an API call from a source system outside SAP S/4HANA Cloud or SAP S/4HANA. # .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SCHED_AGRMT_PROCESS_SRV
API Version:	1
Communication Scenario:	Purchase Scheduling Agreement Integration (SAP_COM_0103)
Scope Items:	Scheduling Agreements in Procurement (BMR), Consumable Purchasing (BNX), Procurement of Direct Materials (J45)
Authentication Methods:	Basic, x509

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
SchAgrmtHeaderCreateFluentHelper	createSchAgrmtHeader(SchAgrmtHeader schAgrmtHeader) Create a new SchAgrmtHeader entity and save it to the S/4HANA system.
SchAgrmtAcCntFluentHelper	getAllSchAgrmtAcCnt() Fetch multiple SchAgrmtAcCnt entities.
SchAgrmtHeaderFluentHelper	getAllSchAgrmtHeader() Fetch multiple SchAgrmtHeader entities.
SchAgrmtItemFluentHelper	getAllSchAgrmtItem() Fetch multiple SchAgrmtItem entities.
SchAgrmtPartnerFluentHelper	getAllSchAgrmtPartner() Fetch multiple SchAgrmtPartner entities.
SchAgrmtSchLineFluentHelper	getAllSchAgrmtSchLine() Fetch multiple SchAgrmtSchLine entities.
SchAgrmtAcCntByKeyFluentHelper	getSchAgrmtAcCntByKey(String accountAssignmentNumber, String schedulingAgreementItem, String schedulingAgreement) Fetch a single SchAgrmtAcCnt entity using key fields.
SchAgrmtHeaderByKeyFluentHelper	getSchAgrmtHeaderByKey(String schedulingAgreement) Fetch a single SchAgrmtHeader entity using key fields.
SchAgrmtItemByKeyFluentHelper	getSchAgrmtItemByKey(String schedulingAgreement, String schedulingAgreementItem) Fetch a single SchAgrmtItem entity using key fields.
SchAgrmtPartnerByKeyFluentHelper	getSchAgrmtPartnerByKey(String schedulingAgreement, String schedulingAgreementItem, String purchasingOrganization, String supplierSubrange, String plant, String partnerFunction, String partnerCounter) Fetch a single SchAgrmtPartner entity using key fields.
SchAgrmtSchLineByKeyFluentHelper	getSchAgrmtSchLineByKey(String schedulingAgreement, String schedulingAgreementItem, String scheduleLine) Fetch a single SchAgrmtSchLine entity using key fields.
SchedulingAgreementService	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
SchedulingAgreementService 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.

getAllSchAgrmtAcCnt

@Nonnull
SchAgrmtAcCntFluentHelper getAllSchAgrmtAcCnt()

Fetch multiple SchAgrmtAcCnt entities.

Returns:

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

getSchAgrmtAcCntByKey

@Nonnull
SchAgrmtAcCntByKeyFluentHelper getSchAgrmtAcCntByKey(String accountAssignmentNumber,
                                                              String schedulingAgreementItem,
                                                              String schedulingAgreement)

Fetch a single SchAgrmtAcCnt entity using key fields.

Parameters:

schedulingAgreement - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

accountAssignmentNumber - Number uniquely defining the account assignment of a purchase document item.

Constraints: Not nullable, Maximum length: 2

schedulingAgreementItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllSchAgrmtHeader

@Nonnull
SchAgrmtHeaderFluentHelper getAllSchAgrmtHeader()

Fetch multiple SchAgrmtHeader entities.

Returns:

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

getSchAgrmtHeaderByKey

@Nonnull
SchAgrmtHeaderByKeyFluentHelper getSchAgrmtHeaderByKey(String schedulingAgreement)

Fetch a single SchAgrmtHeader entity using key fields.

Parameters:

schedulingAgreement - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSchAgrmtHeader

@Nonnull
SchAgrmtHeaderCreateFluentHelper createSchAgrmtHeader(@Nonnull
                                                               SchAgrmtHeader schAgrmtHeader)

Create a new SchAgrmtHeader entity and save it to the S/4HANA system.

Parameters:

schAgrmtHeader - SchAgrmtHeader entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new SchAgrmtHeader entity. To perform execution, call the execute method on the fluent helper object.

getAllSchAgrmtItem

@Nonnull
SchAgrmtItemFluentHelper getAllSchAgrmtItem()

Fetch multiple SchAgrmtItem entities.

Returns:

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

getSchAgrmtItemByKey

@Nonnull
SchAgrmtItemByKeyFluentHelper getSchAgrmtItemByKey(String schedulingAgreement,
                                                            String schedulingAgreementItem)

Fetch a single SchAgrmtItem entity using key fields.

Parameters:

schedulingAgreement - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

schedulingAgreementItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllSchAgrmtPartner

@Nonnull
SchAgrmtPartnerFluentHelper getAllSchAgrmtPartner()

Fetch multiple SchAgrmtPartner entities.

Returns:

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

getSchAgrmtPartnerByKey

@Nonnull
SchAgrmtPartnerByKeyFluentHelper getSchAgrmtPartnerByKey(String schedulingAgreement,
                                                                  String schedulingAgreementItem,
                                                                  String purchasingOrganization,
                                                                  String supplierSubrange,
                                                                  String plant,
                                                                  String partnerFunction,
                                                                  String partnerCounter)

Fetch a single SchAgrmtPartner entity using key fields.

Parameters:

schedulingAgreement - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

purchasingOrganization - Denotes the purchasing organization.

Constraints: Not nullable, Maximum length: 4

partnerCounter - The sequential number that the system applies when there is more than one partner for a particular partner function.

Constraints: Not nullable, Maximum length: 3

supplierSubrange - Subdivision of a supplier's overall product range according to various criteria.

Constraints: Not nullable, Maximum length: 6

schedulingAgreementItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllSchAgrmtSchLine

@Nonnull
SchAgrmtSchLineFluentHelper getAllSchAgrmtSchLine()

Fetch multiple SchAgrmtSchLine entities.

Returns:

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

getSchAgrmtSchLineByKey

@Nonnull
SchAgrmtSchLineByKeyFluentHelper getSchAgrmtSchLineByKey(String schedulingAgreement,
                                                                  String schedulingAgreementItem,
                                                                  String scheduleLine)

Fetch a single SchAgrmtSchLine entity using key fields.

Parameters:

schedulingAgreement - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

scheduleLine - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 4

schedulingAgreementItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

Returns:

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