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

Interface DocumentComplianceElectronicDocumentFileService

All Known Implementing Classes:

DefaultDocumentComplianceElectronicDocumentFileService

public interface DocumentComplianceElectronicDocumentFileService

This service enables you to download eDocument file data in SAP S/4HANA Cloud that can be used by external applications. The service is based on the OData V4 protocol.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	ELECTRONICDOCFILE_0001
API Version:	1
Communication Scenario:	Document Compliance - Electronic Document File Integration (SAP_COM_0703)
Authentication Methods:	Basic, x509
Service Group Name:	API_ELECTRONICDOCFILE
Business Object:	ElectronicDocument

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
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<ElectronicDocFile>	countElectronicDocFile() Fetch the number of entries from the ElectronicDocFile entity collection matching the filter and search expressions.
GetAllRequestBuilder<ElectronicDocFile>	getAllElectronicDocFile() Fetch multiple ElectronicDocFile entities.
GetByKeyRequestBuilder<ElectronicDocFile>	getElectronicDocFileByKey(UUID electronicDocFileUUID) Fetch a single ElectronicDocFile entity using key fields.
DocumentComplianceElectronicDocumentFileService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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
DocumentComplianceElectronicDocumentFileService 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.

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllElectronicDocFile

@Nonnull
GetAllRequestBuilder<ElectronicDocFile> getAllElectronicDocFile()

Fetch multiple ElectronicDocFile entities.

Returns:

A request builder to fetch multiple ElectronicDocFile entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

countElectronicDocFile

@Nonnull
CountRequestBuilder<ElectronicDocFile> countElectronicDocFile()

Fetch the number of entries from the ElectronicDocFile entity collection matching the filter and search expressions.

Returns:

A request builder to fetch the count of ElectronicDocFile entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.

getElectronicDocFileByKey

@Nonnull
GetByKeyRequestBuilder<ElectronicDocFile> getElectronicDocFileByKey(@Nonnull
                                                                             UUID electronicDocFileUUID)

Fetch a single ElectronicDocFile entity using key fields.

Parameters:

electronicDocFileUUID - File GUID

Constraints: Not nullable

Returns:

A request builder to fetch a single ElectronicDocFile entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.