com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface ProductionVolumeCaptureService

All Superinterfaces:

BatchService<ProductionVolumeCaptureServiceBatch>

All Known Implementing Classes:

DefaultProductionVolumeCaptureService

public interface ProductionVolumeCaptureService
extends BatchService<ProductionVolumeCaptureServiceBatch>

You can use the service to read and create production volumes for wells or combination of well and well completions. The service is based on the OData protocol and can be consumed by external systems.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODVOLCAPTURE
API Version:	1
Communication Scenario:	Production Volume Management Integration (SAP_COM_0704)
Scope Items:	Production Volume Capture (4AG)
Authentication Methods:	Basic, x509

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
ProductionVolumeCreateFluentHelper	createProductionVolume(ProductionVolume productionVolume) Create a new ProductionVolume entity and save it to the S/4HANA system.
ProductionVolumeFluentHelper	getAllProductionVolume() Fetch multiple ProductionVolume entities.
ProductionVolumeByKeyFluentHelper	getProductionVolumeByKey(String well, String wellCompletion, LocalDateTime productionDate, ZonedDateTime oilAllocAtWellCompltnDateTime) Fetch a single ProductionVolume entity using key fields.
ProductionVolumeCaptureService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
ProductionVolumeCaptureService withServicePath(@Nonnull
                                                        String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllProductionVolume

@Nonnull
ProductionVolumeFluentHelper getAllProductionVolume()

Fetch multiple ProductionVolume entities.

Returns:

A fluent helper to fetch multiple ProductionVolume 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.

getProductionVolumeByKey

@Nonnull
ProductionVolumeByKeyFluentHelper getProductionVolumeByKey(String well,
                                                                    String wellCompletion,
                                                                    LocalDateTime productionDate,
                                                                    ZonedDateTime oilAllocAtWellCompltnDateTime)

Fetch a single ProductionVolume entity using key fields.

Parameters:

productionDate - Production Date

Constraints: Not nullable, Precision: 0

well - Well ID

Constraints: Not nullable, Maximum length: 30

wellCompletion - Well Completion ID

Constraints: Not nullable, Maximum length: 30

oilAllocAtWellCompltnDateTime - The UTC time stamp is the date and time relative to UTC (Universal Coordinated Time).

Constraints: Not nullable, Precision: 0

Returns:

A fluent helper to fetch a single ProductionVolume 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.

createProductionVolume

@Nonnull
ProductionVolumeCreateFluentHelper createProductionVolume(@Nonnull
                                                                   ProductionVolume productionVolume)

Create a new ProductionVolume entity and save it to the S/4HANA system.

Parameters:

productionVolume - ProductionVolume entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ProductionVolume entity. To perform execution, call the execute method on the fluent helper object.