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

Class DefaultProductionVolumeCaptureService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ProductionVolumeCaptureServiceBatch>, ProductionVolumeCaptureService

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

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProductionVolumeCaptureService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultProductionVolumeCaptureService() Creates a service using ProductionVolumeCaptureService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultProductionVolumeCaptureServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultProductionVolumeCaptureService	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

DefaultProductionVolumeCaptureService

public DefaultProductionVolumeCaptureService()

Creates a service using ProductionVolumeCaptureService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultProductionVolumeCaptureService withServicePath(@Nonnull
                                                                      String servicePath)

Description copied from interface: ProductionVolumeCaptureService

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 ProductionVolumeCaptureService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultProductionVolumeCaptureServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ProductionVolumeCaptureServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllProductionVolume

@Nonnull
public ProductionVolumeFluentHelper getAllProductionVolume()

Description copied from interface: ProductionVolumeCaptureService

Fetch multiple ProductionVolume entities.

Specified by:

getAllProductionVolume in interface ProductionVolumeCaptureService

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
public ProductionVolumeByKeyFluentHelper getProductionVolumeByKey(String well,
                                                                           String wellCompletion,
                                                                           LocalDateTime productionDate,
                                                                           ZonedDateTime oilAllocAtWellCompltnDateTime)

Description copied from interface: ProductionVolumeCaptureService

Fetch a single ProductionVolume entity using key fields.

Specified by:

getProductionVolumeByKey in interface ProductionVolumeCaptureService

Parameters:

well - Well ID

Constraints: Not nullable, Maximum length: 30

wellCompletion - Well Completion ID

Constraints: Not nullable, Maximum length: 30

productionDate - Production Date

Constraints: Not nullable, Precision: 0

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
public ProductionVolumeCreateFluentHelper createProductionVolume(@Nonnull
                                                                          ProductionVolume productionVolume)

Description copied from interface: ProductionVolumeCaptureService

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

Specified by:

createProductionVolume in interface ProductionVolumeCaptureService

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.