com.sap.cloud.sdk.s4hana.datamodel.odata.services.CostRateService 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 java.util.UUID;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ActualCostRateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ActualCostRateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.PlanCostRateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.PlanCostRateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ServiceCostRateByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ServiceCostRateFluentHelper;

/**
 * 
 * This service enables you to create, read, update, or delete the master data of cost rates.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_FCO_COST_RATE_SRV
API Version: 1
Communication Scenario: Finance - Activity Type Integration (SAP_COM_0129)
Scope Items: Overhead Cost Accounting (J54)
Authentication Methods: Basic, x509
 * 
 */
public interface CostRateService
{

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ActualCostRate ActualCostRate}
     * entity using key fields.
     * 
     * @param accountingCostRateUUID
     *            Cost Rate UUID
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ActualCostRate ActualCostRate} 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.costrate.ActualCostRateByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ActualCostRateByKeyFluentHelper getActualCostRateByKey( final UUID accountingCostRateUUID );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.PlanCostRate PlanCostRate}
     * entity using key fields.
     * 
     * @param accountingCostRateUUID
     *            Cost Rate UUID
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.PlanCostRate PlanCostRate} 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.costrate.PlanCostRateByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    PlanCostRateByKeyFluentHelper getPlanCostRateByKey( final UUID accountingCostRateUUID );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ServiceCostRate
     * ServiceCostRate} entity using key fields.
     * 
     * @param accountingCostRateUUID
     *            Cost Rate UUID
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.costrate.ServiceCostRate ServiceCostRate}
     *         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.costrate.ServiceCostRateByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ServiceCostRateByKeyFluentHelper getServiceCostRateByKey( final UUID accountingCostRateUUID );

}
OData Service:	API_FCO_COST_RATE_SRV
API Version:	1
Communication Scenario:	Finance - Activity Type Integration (SAP_COM_0129)
Scope Items:	Overhead Cost Accounting (J54)
Authentication Methods:	Basic, x509