com.sap.cloud.sdk.s4hana.datamodel.odata.services.BankDetailService Maven / Gradle / Ivy

Go to download
/*
 * 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.bankdetail.BankDetailByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.BankDetailFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.batch.BankDetailServiceBatch;

/**
 * 
 * This service can be consumed by external applications in order to integrate with bank master data in SAP S/4HANA
 * Cloud. It enables you to read bank data from SAP S/4HANA Cloud.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_BANKDETAIL_SRV
API Version: 1
Communication Scenario: Finance - Bank Integration (SAP_COM_0127)
Scope Items: Advanced Bank Account Management (J77)
Authentication Methods: Basic, x509
 * 
 */
public interface BankDetailService extends BatchService
{

    /**
     * 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_BANKDETAIL_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
    BankDetailService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.BankDetail BankDetail}
     * entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.BankDetail BankDetail} 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.bankdetail.BankDetailFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BankDetailFluentHelper getAllBankDetail();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.BankDetail BankDetail}
     * entity using key fields.
     * 
     * @param bankInternalID
     *            In this field, you specify the bank key under which bank data from the respective country is stored.
     *            
     *            Constraints: Not nullable, Maximum length: 15
     *            
     * @param bankCountry
     *            Identifies the country in which the bank is located.
     *            
     *            Constraints: Not nullable, Maximum length: 3
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bankdetail.BankDetail BankDetail} 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.bankdetail.BankDetailByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    BankDetailByKeyFluentHelper getBankDetailByKey( final String bankCountry, final String bankInternalID );

}
OData Service:	API_BANKDETAIL_SRV
API Version:	1
Communication Scenario:	Finance - Bank Integration (SAP_COM_0127)
Scope Items:	Advanced Bank Account Management (J77)
Authentication Methods:	Basic, x509