com.sap.cloud.sdk.s4hana.datamodel.bapi.functions.AcctngActivityAllocPostFunction 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.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.datamodel.bapi.structures.ContainerForCustomerExitParameter;
import com.sap.cloud.sdk.s4hana.datamodel.bapi.structures.PostingInAccountingCoPaAcctAssignmentCharacteristic;
import com.sap.cloud.sdk.s4hana.serialization.ErpBoolean;

/**
 * FI/CO: Post activity allocation
 *  *  BAPI_ACC_ACTIVITY_ALLOC_POST
 * 
 * 
 */
public interface AcctngActivityAllocPostFunction {


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

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

    /**
     * (Optional) Flag: Ignore warnings
     * Field name: IGNWARN
     * 
     *  Type element: BAPIIGNWAR
     *  Domain name: SYCHAR01
     *  Internal type: CHAR
     *  Description: Ignore Warnings
     *  Max length: 1
     * 
     * 
     * @param ignoreWarnings
     *     Flag: Ignore warnings
     * @return
     *     self
     */
    @Nonnull
    AcctngActivityAllocPostFunction ignoreWarnings(ErpBoolean ignoreWarnings);

    /**
     * (Optional) Object Attributes for Profitability Segment
     * 
     * @param criteria
     *     Object Attributes for Profitability Segment
     * @return
     *     self
     */
    @Nonnull
    AcctngActivityAllocPostFunction criteria(Iterable criteria);

    /**
     * (Optional) Object Attributes for Profitability Segment
     * 
     * @param items
     *     Array of PostingInAccountingCoPaAcctAssignmentCharacteristic
     * @return
     *     self
     */
    @Nonnull
    AcctngActivityAllocPostFunction criteria(PostingInAccountingCoPaAcctAssignmentCharacteristic... items);

    /**
     * (Optional) Customer Fields
     * 
     * @param customerFields
     *     Customer Fields
     * @return
     *     self
     */
    @Nonnull
    AcctngActivityAllocPostFunction customerFields(Iterable customerFields);

    /**
     * (Optional) Customer Fields
     * 
     * @param items
     *     Array of ContainerForCustomerExitParameter
     * @return
     *     self
     */
    @Nonnull
    AcctngActivityAllocPostFunction customerFields(ContainerForCustomerExitParameter... items);

}