DefaultCostRateService (SAP Cloud SDK - Parent POM 3.39.0 API)

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCostRateService

All Implemented Interfaces:: BatchService<CostRateServiceBatch>, CostRateService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCostRateService")
public class DefaultCostRateService
extends Object
implements CostRateService

This service contains plan cost rate, actual cost rate and service cost rate. For each type you can read a list of existing cost rates, create a new one, update or delete an existing one. During creation or update, the information is used to create a new cost rate or to update an existing one - including all necessary checks for restricted values and authorizations. Created or updated cost rates are included in the response. An existing cost rate that needs to be modified or deleted is identified by the mandatory parameter - AccountingCostRateUUID. If there are any issues, the system displays error messages in the response..

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
Business Object:	AccountingCostRate

Field Summary
- Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CostRateService
  DEFAULT_SERVICE_PATH

Constructor Summary

Constructors
Constructor and Description

DefaultCostRateService()
Creates a service using CostRateService.DEFAULT_SERVICE_PATH to send the requests.

Constructors
Constructor and Description
`DefaultCostRateService()` Creates a service using `CostRateService.DEFAULT_SERVICE_PATH` to send the requests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultCostRateServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`ActualCostRateCreateFluentHelper`	`createActualCostRate(ActualCostRate actualCostRate)` Create a new `ActualCostRate` entity and save it to the S/4HANA system.
`PlanCostRateCreateFluentHelper`	`createPlanCostRate(PlanCostRate planCostRate)` Create a new `PlanCostRate` entity and save it to the S/4HANA system.
`ServiceCostRateCreateFluentHelper`	`createServiceCostRate(ServiceCostRate serviceCostRate)` Create a new `ServiceCostRate` entity and save it to the S/4HANA system.
`ActualCostRateDeleteFluentHelper`	`deleteActualCostRate(ActualCostRate actualCostRate)` Deletes an existing `ActualCostRate` entity in the S/4HANA system.
`PlanCostRateDeleteFluentHelper`	`deletePlanCostRate(PlanCostRate planCostRate)` Deletes an existing `PlanCostRate` entity in the S/4HANA system.
`ServiceCostRateDeleteFluentHelper`	`deleteServiceCostRate(ServiceCostRate serviceCostRate)` Deletes an existing `ServiceCostRate` entity in the S/4HANA system.
`ActualCostRateByKeyFluentHelper`	`getActualCostRateByKey(UUID accountingCostRateUUID)` Fetch a single `ActualCostRate` entity using key fields.
`ActualCostRateFluentHelper`	`getAllActualCostRate()` Fetch multiple `ActualCostRate` entities.
`PlanCostRateFluentHelper`	`getAllPlanCostRate()` Fetch multiple `PlanCostRate` entities.
`ServiceCostRateFluentHelper`	`getAllServiceCostRate()` Fetch multiple `ServiceCostRate` entities.
`PlanCostRateByKeyFluentHelper`	`getPlanCostRateByKey(UUID accountingCostRateUUID)` Fetch a single `PlanCostRate` entity using key fields.
`ServiceCostRateByKeyFluentHelper`	`getServiceCostRateByKey(UUID accountingCostRateUUID)` Fetch a single `ServiceCostRate` entity using key fields.
`ActualCostRateUpdateFluentHelper`	`updateActualCostRate(ActualCostRate actualCostRate)` Update an existing `ActualCostRate` entity and save it to the S/4HANA system.
`PlanCostRateUpdateFluentHelper`	`updatePlanCostRate(PlanCostRate planCostRate)` Update an existing `PlanCostRate` entity and save it to the S/4HANA system.
`ServiceCostRateUpdateFluentHelper`	`updateServiceCostRate(ServiceCostRate serviceCostRate)` Update an existing `ServiceCostRate` entity and save it to the S/4HANA system.
`DefaultCostRateService`	`withServicePath(String servicePath)` Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultCostRateService
```
public DefaultCostRateService()
```
    Creates a service using CostRateService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultCostRateService withServicePath(@Nonnull
                                                       String servicePath)
```
    Description copied from interface: CostRateService
    
    Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.
    
    Specified by:
    
    withServicePath in interface CostRateService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultCostRateServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<CostRateServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllActualCostRate
```
@Nonnull
public ActualCostRateFluentHelper getAllActualCostRate()
```
    Description copied from interface: CostRateService
    
    Fetch multiple ActualCostRate entities.
    
    Specified by:
    
    getAllActualCostRate in interface CostRateService
    
    Returns:
    
    A fluent helper to fetch multiple 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 execute method on the fluent helper object.
  - getActualCostRateByKey
```
@Nonnull
public ActualCostRateByKeyFluentHelper getActualCostRateByKey(UUID accountingCostRateUUID)
```
    Description copied from interface: CostRateService
    
    Fetch a single ActualCostRate entity using key fields.
    
    Specified by:
    
    getActualCostRateByKey in interface CostRateService
    
    Parameters:
    
    accountingCostRateUUID - Cost Rate UUID
    Constraints: Not nullable
    
    Returns:
    
    A fluent helper to fetch a single 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 execute method on the fluent helper object.
  - createActualCostRate
```
@Nonnull
public ActualCostRateCreateFluentHelper createActualCostRate(@Nonnull
                                                                      ActualCostRate actualCostRate)
```
    Description copied from interface: CostRateService
    
    Create a new ActualCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    createActualCostRate in interface CostRateService
    
    Parameters:
    
    actualCostRate - ActualCostRate entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new ActualCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - updateActualCostRate
```
@Nonnull
public ActualCostRateUpdateFluentHelper updateActualCostRate(@Nonnull
                                                                      ActualCostRate actualCostRate)
```
    Description copied from interface: CostRateService
    
    Update an existing ActualCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateActualCostRate in interface CostRateService
    
    Parameters:
    
    actualCostRate - ActualCostRate entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ActualCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - deleteActualCostRate
```
@Nonnull
public ActualCostRateDeleteFluentHelper deleteActualCostRate(@Nonnull
                                                                      ActualCostRate actualCostRate)
```
    Description copied from interface: CostRateService
    
    Deletes an existing ActualCostRate entity in the S/4HANA system.
    
    Specified by:
    
    deleteActualCostRate in interface CostRateService
    
    Parameters:
    
    actualCostRate - ActualCostRate entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing ActualCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPlanCostRate
```
@Nonnull
public PlanCostRateFluentHelper getAllPlanCostRate()
```
    Description copied from interface: CostRateService
    
    Fetch multiple PlanCostRate entities.
    
    Specified by:
    
    getAllPlanCostRate in interface CostRateService
    
    Returns:
    
    A fluent helper to fetch multiple 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 execute method on the fluent helper object.
  - getPlanCostRateByKey
```
@Nonnull
public PlanCostRateByKeyFluentHelper getPlanCostRateByKey(UUID accountingCostRateUUID)
```
    Description copied from interface: CostRateService
    
    Fetch a single PlanCostRate entity using key fields.
    
    Specified by:
    
    getPlanCostRateByKey in interface CostRateService
    
    Parameters:
    
    accountingCostRateUUID - Cost Rate UUID
    Constraints: Not nullable
    
    Returns:
    
    A fluent helper to fetch a single 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 execute method on the fluent helper object.
  - createPlanCostRate
```
@Nonnull
public PlanCostRateCreateFluentHelper createPlanCostRate(@Nonnull
                                                                  PlanCostRate planCostRate)
```
    Description copied from interface: CostRateService
    
    Create a new PlanCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPlanCostRate in interface CostRateService
    
    Parameters:
    
    planCostRate - PlanCostRate entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PlanCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - updatePlanCostRate
```
@Nonnull
public PlanCostRateUpdateFluentHelper updatePlanCostRate(@Nonnull
                                                                  PlanCostRate planCostRate)
```
    Description copied from interface: CostRateService
    
    Update an existing PlanCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    updatePlanCostRate in interface CostRateService
    
    Parameters:
    
    planCostRate - PlanCostRate entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PlanCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - deletePlanCostRate
```
@Nonnull
public PlanCostRateDeleteFluentHelper deletePlanCostRate(@Nonnull
                                                                  PlanCostRate planCostRate)
```
    Description copied from interface: CostRateService
    
    Deletes an existing PlanCostRate entity in the S/4HANA system.
    
    Specified by:
    
    deletePlanCostRate in interface CostRateService
    
    Parameters:
    
    planCostRate - PlanCostRate entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing PlanCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - getAllServiceCostRate
```
@Nonnull
public ServiceCostRateFluentHelper getAllServiceCostRate()
```
    Description copied from interface: CostRateService
    
    Fetch multiple ServiceCostRate entities.
    
    Specified by:
    
    getAllServiceCostRate in interface CostRateService
    
    Returns:
    
    A fluent helper to fetch multiple 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 execute method on the fluent helper object.
  - getServiceCostRateByKey
```
@Nonnull
public ServiceCostRateByKeyFluentHelper getServiceCostRateByKey(UUID accountingCostRateUUID)
```
    Description copied from interface: CostRateService
    
    Fetch a single ServiceCostRate entity using key fields.
    
    Specified by:
    
    getServiceCostRateByKey in interface CostRateService
    
    Parameters:
    
    accountingCostRateUUID - Cost Rate UUID
    Constraints: Not nullable
    
    Returns:
    
    A fluent helper to fetch a single 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 execute method on the fluent helper object.
  - createServiceCostRate
```
@Nonnull
public ServiceCostRateCreateFluentHelper createServiceCostRate(@Nonnull
                                                                        ServiceCostRate serviceCostRate)
```
    Description copied from interface: CostRateService
    
    Create a new ServiceCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    createServiceCostRate in interface CostRateService
    
    Parameters:
    
    serviceCostRate - ServiceCostRate entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new ServiceCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - updateServiceCostRate
```
@Nonnull
public ServiceCostRateUpdateFluentHelper updateServiceCostRate(@Nonnull
                                                                        ServiceCostRate serviceCostRate)
```
    Description copied from interface: CostRateService
    
    Update an existing ServiceCostRate entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateServiceCostRate in interface CostRateService
    
    Parameters:
    
    serviceCostRate - ServiceCostRate entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ServiceCostRate entity. To perform execution, call the execute method on the fluent helper object.
  - deleteServiceCostRate
```
@Nonnull
public ServiceCostRateDeleteFluentHelper deleteServiceCostRate(@Nonnull
                                                                        ServiceCostRate serviceCostRate)
```
    Description copied from interface: CostRateService
    
    Deletes an existing ServiceCostRate entity in the S/4HANA system.
    
    Specified by:
    
    deleteServiceCostRate in interface CostRateService
    
    Parameters:
    
    serviceCostRate - ServiceCostRate entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing ServiceCostRate entity. To perform execution, call the execute method on the fluent helper object.

Class DefaultCostRateService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CostRateService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultCostRateService

Method Detail

withServicePath

batch

getAllActualCostRate

getActualCostRateByKey

createActualCostRate

updateActualCostRate

deleteActualCostRate

getAllPlanCostRate

getPlanCostRateByKey

createPlanCostRate

updatePlanCostRate

deletePlanCostRate

getAllServiceCostRate

getServiceCostRateByKey

createServiceCostRate

updateServiceCostRate

deleteServiceCostRate