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

Go to download
/*
 * Copyright (c) 2018 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;
import com.sap.cloud.sdk.s4hana.serialization.ErpBoolean;

/**
 * Change an FX Option
 *  *  BAPI_FTR_CHANGE_FXOPTIONS
 * 
 * 
 */
public interface FxOptionChangeFunction {


    /**
     * 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_CHANGE_FXOPTIONS
     */
    @Nonnull
    FxOptionChangeFunctionResult 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_CHANGE_FXOPTIONS
     */
    @Nonnull
    FxOptionChangeFunctionResult execute()
        throws QueryExecutionException
    ;

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

    /**
     * (Optional) Switch to Simulation Mode for Write BAPIs
     * Field name: TESTRUN
     * 
     *  Type element: TESTRUN
     *  Domain name: BAPIFLAG
     *  Internal type: CHAR
     *  Description: Switch to Simulation Session for Write BAPIs
     *  Max length: 1
     * 
     * 
     * @param testRun
     *     Switch to Simulation Mode for Write BAPIs
     * @return
     *     self
     */
    FxOptionChangeFunction testRun(ErpBoolean testRun);

}