com.sap.cloud.sdk.s4hana.datamodel.odata.services.SchedulingAgreementService 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.namespaces.schedulingagreement.SchAgrmtAcCntByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCntFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartnerByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartnerFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLineByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLineFluentHelper;
/**
*
* 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.
*
* # .
*
*
*
* 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
*
*
*
*/
public interface SchedulingAgreementService
{
/**
* 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_SCHED_AGRMT_PROCESS_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
SchedulingAgreementService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCnt
* SchAgrmtAcCnt} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCntFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtAcCntFluentHelper getAllSchAgrmtAcCnt();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCnt
* SchAgrmtAcCnt} entity using key fields.
*
* @param schedulingAgreement
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param accountAssignmentNumber
* Number uniquely defining the account assignment of a purchase document item.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param schedulingAgreementItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCnt
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtAcCntByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtAcCntByKeyFluentHelper getSchAgrmtAcCntByKey(
final String accountAssignmentNumber,
final String schedulingAgreementItem,
final String schedulingAgreement );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* SchAgrmtHeader} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtHeaderFluentHelper getAllSchAgrmtHeader();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* SchAgrmtHeader} entity using key fields.
*
* @param schedulingAgreement
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtHeaderByKeyFluentHelper getSchAgrmtHeaderByKey( final String schedulingAgreement );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* SchAgrmtHeader} entity and save it to the S/4HANA system.
*
* @param schAgrmtHeader
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* SchAgrmtHeader} entity object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeader
* SchAgrmtHeader} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtHeaderCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtHeaderCreateFluentHelper createSchAgrmtHeader( @Nonnull final SchAgrmtHeader schAgrmtHeader );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItem
* SchAgrmtItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItem 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtItemFluentHelper getAllSchAgrmtItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItem
* SchAgrmtItem} entity using key fields.
*
* @param schedulingAgreement
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param schedulingAgreementItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItem 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtItemByKeyFluentHelper
getSchAgrmtItemByKey( final String schedulingAgreement, final String schedulingAgreementItem );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartner
* SchAgrmtPartner} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartnerFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtPartnerFluentHelper getAllSchAgrmtPartner();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartner
* SchAgrmtPartner} entity using key fields.
*
* @param schedulingAgreement
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param partnerFunction
* The abbreviated form of the name that identifies the partner function.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param plant
* Key uniquely identifying a plant.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param purchasingOrganization
* Denotes the purchasing organization.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param 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
*
* @param supplierSubrange
* Subdivision of a supplier's overall product range according to various criteria.
*
* Constraints: Not nullable, Maximum length: 6
*
* @param schedulingAgreementItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartner
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtPartnerByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtPartnerByKeyFluentHelper getSchAgrmtPartnerByKey(
final String schedulingAgreement,
final String schedulingAgreementItem,
final String purchasingOrganization,
final String supplierSubrange,
final String plant,
final String partnerFunction,
final String partnerCounter );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLine
* SchAgrmtSchLine} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLine
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLineFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtSchLineFluentHelper getAllSchAgrmtSchLine();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLine
* SchAgrmtSchLine} entity using key fields.
*
* @param schedulingAgreement
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 10
*
* @param scheduleLine
* Alphanumeric key uniquely identifying the document.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param schedulingAgreementItem
* Specifies the number that uniquely identifies an item in .
*
* Constraints: Not nullable, Maximum length: 5
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLine
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.schedulingagreement.SchAgrmtSchLineByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SchAgrmtSchLineByKeyFluentHelper getSchAgrmtSchLineByKey(
final String schedulingAgreement,
final String schedulingAgreementItem,
final String scheduleLine );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy