com.sap.cloud.sdk.s4hana.datamodel.bapi.functions.FxOptionGetDetailFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bapi-api Show documentation

Generated classes of the SAP S/4HANA Virtual Data Model (VDM) for BAPIs.

There is a newer version: 2.28.0

/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

package com.sap.cloud.sdk.s4hana.datamodel.bapi.functions;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.connectivity.ErpConfigContext;
import com.sap.cloud.sdk.s4hana.connectivity.exception.QueryExecutionException;
import com.sap.cloud.sdk.s4hana.connectivity.rfc.BapiQuery;

/**
 * Details of an FX Option
 *  *  BAPI_FTR_FXOPTION_GETDETAIL
 * 
 * 
 */
public interface FxOptionGetDetailFunction {


    /**
     * Execute query on an ERP endpoint described by the provided ERP configuration context.
     * 
     * This method allows specifying a custom ERP configuration context, having configurable values for
     * 

     * Destination name, default: {@link com.sap.cloud.sdk.s4hana.connectivity.ErpDestination#getDefaultName() ErpDestination.getDefaultName()}
     * {@link com.sap.cloud.sdk.s4hana.serialization.SapClient SapClient}
     * {@link java.util.Locale Locale}
     * 
     * The usage of this method is recommended, in particular when applying multitenancy.
     * 
     * @param erpConfigContext
     *     Configuration context for ERP query
     * @return
     *     Explorable query result for BAPI_FTR_FXOPTION_GETDETAIL
     */
    @Nonnull
    FxOptionGetDetailFunctionResult execute(ErpConfigContext erpConfigContext)
        throws QueryExecutionException
    ;

    /**
     * Execute query on the default ERP configuration context.
     * 
     * This method is recommended when the application's ERP configuration context settings are unchanged from the defaults.
     * @see ErpConfigContext#ErpConfigContext()
     * 
     * @return
     *     Explorable query result for BAPI_FTR_FXOPTION_GETDETAIL
     */
    @Nonnull
    FxOptionGetDetailFunctionResult execute()
        throws QueryExecutionException
    ;

    /**
     * Prepares a query object from the given query parameters.
     * 
     * @return
     *     Serializable BapiQuery for BAPI_FTR_FXOPTION_GETDETAIL
     */
    @Nonnull
    BapiQuery toQuery();

}