com.sap.cloud.sdk.s4hana.datamodel.odata.services.ServiceEntrySheetService 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.serviceentrysheet.RevokeApprovalFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItemUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignmentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignmentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignmentUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SubmitForApprovalFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.WithdrawFromApprovalFluentHelper;
/**
*
* This synchronous inbound OData service enables a remote system to read and create service entry sheets from or in the
* SAP S/4HANA system. You can use this service to submit a service entry sheet for approval, withdraw it from approval,
* or revoke approval of an already approved service entry sheet.
*
*
*
* Reference: SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_SERVICE_ENTRY_SHEET_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Service Entry Sheet Integration (SAP_COM_0146)
*
*
* Scope Items:
* Procurement of Services (22Z),
* Consumable Purchasing (BNX),
* Service and Material Procurement - Project-Based Services
* (J13)
*
*
* Authentication Methods:
* Basic, x509
*
*
*
*/
public interface ServiceEntrySheetService
{
/**
* 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_SERVICE_ENTRY_SHEET_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
ServiceEntrySheetService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} 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.serviceentrysheet.ServiceEntrySheetFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetFluentHelper getAllServiceEntrySheet();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity using key fields.
*
* @param serviceEntrySheet
* Service Entry Sheet
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} 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.serviceentrysheet.ServiceEntrySheetByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetByKeyFluentHelper getServiceEntrySheetByKey( final String serviceEntrySheet );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity and save it to the S/4HANA system.
*
* @param serviceEntrySheet
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} 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.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetCreateFluentHelper createServiceEntrySheet( @Nonnull final ServiceEntrySheet serviceEntrySheet );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity and save it to the S/4HANA system.
*
* @param serviceEntrySheet
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheet
* ServiceEntrySheet} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetUpdateFluentHelper updateServiceEntrySheet( @Nonnull final ServiceEntrySheet serviceEntrySheet );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} 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.serviceentrysheet.ServiceEntrySheetItemFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetItemFluentHelper getAllServiceEntrySheetItem();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} entity using key fields.
*
* @param serviceEntrySheetItem
* Item Number of Service Entry Sheet
*
* Constraints: Not nullable, Maximum length: 5
*
* @param serviceEntrySheet
* Service Entry Sheet
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} 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.serviceentrysheet.ServiceEntrySheetItemByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetItemByKeyFluentHelper
getServiceEntrySheetItemByKey( final String serviceEntrySheet, final String serviceEntrySheetItem );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} entity and save it to the S/4HANA system.
*
* @param serviceEntrySheetItem
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItem
* ServiceEntrySheetItem} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.ServiceEntrySheetItemUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ServiceEntrySheetItemUpdateFluentHelper
updateServiceEntrySheetItem( @Nonnull final ServiceEntrySheetItem serviceEntrySheetItem );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} 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.serviceentrysheet.SrvcEntrShtAcctAssignmentFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SrvcEntrShtAcctAssignmentFluentHelper getAllSrvcEntrShtAcctAssignment();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} entity using key fields.
*
* @param accountAssignment
* Number uniquely defining the account assignment of a purchase document item.
*
* Constraints: Not nullable, Maximum length: 2
*
* @param serviceEntrySheetItem
* Item Number of Service Entry Sheet
*
* Constraints: Not nullable, Maximum length: 5
*
* @param serviceEntrySheet
* Service Entry Sheet
*
* Constraints: Not nullable, Maximum length: 10
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} 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.serviceentrysheet.SrvcEntrShtAcctAssignmentByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SrvcEntrShtAcctAssignmentByKeyFluentHelper getSrvcEntrShtAcctAssignmentByKey(
final String serviceEntrySheet,
final String serviceEntrySheetItem,
final String accountAssignment );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} entity and save it to the S/4HANA system.
*
* @param srvcEntrShtAcctAssignment
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} entity object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignment
* SrvcEntrShtAcctAssignment} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SrvcEntrShtAcctAssignmentUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SrvcEntrShtAcctAssignmentUpdateFluentHelper
updateSrvcEntrShtAcctAssignment( @Nonnull final SrvcEntrShtAcctAssignment srvcEntrShtAcctAssignment );
/**
* Submit for Approval
*
*
*
* Creates a fluent helper for the SubmitForApproval OData function import.
*
*
* @param serviceEntrySheet
* Service Entry Sheet
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: ServiceEntrySheet
*
* @return A fluent helper object that will execute the SubmitForApproval OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.SubmitForApprovalFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
SubmitForApprovalFluentHelper submitForApproval( final String serviceEntrySheet );
/**
* Revoke Approval
*
*
*
* Creates a fluent helper for the RevokeApproval OData function import.
*
*
* @param serviceEntrySheet
* Service Entry Sheet
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: ServiceEntrySheet
*
* @param postingDate
* Posting Date
*
*
*
* Constraints: Not nullable, Maximum length: 8
*
*
* Original parameter name from the Odata EDM: PostingDate
*
* @return A fluent helper object that will execute the RevokeApproval OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.RevokeApprovalFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
RevokeApprovalFluentHelper revokeApproval( final String postingDate, final String serviceEntrySheet );
/**
* Withdraw from Approval
*
*
*
* Creates a fluent helper for the WithdrawFromApproval OData function import.
*
*
* @param serviceEntrySheet
* Service Entry Sheet
*
*
*
* Constraints: Not nullable, Maximum length: 10
*
*
* Original parameter name from the Odata EDM: ServiceEntrySheet
*
* @return A fluent helper object that will execute the WithdrawFromApproval OData function import with the
* provided parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.serviceentrysheet.WithdrawFromApprovalFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
WithdrawFromApprovalFluentHelper withdrawFromApproval( final String serviceEntrySheet );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy