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

Class DefaultDocumentComplianceElectronicDocumentFileService

java.lang.Object

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

All Implemented Interfaces:

ServiceWithNavigableEntities, DocumentComplianceElectronicDocumentFileService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultDocumentComplianceElectronicDocumentFileService")
public class DefaultDocumentComplianceElectronicDocumentFileService
extends Object
implements ServiceWithNavigableEntities, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DocumentComplianceElectronicDocumentFileService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentComplianceElectronicDocumentFileService() Creates a service using DocumentComplianceElectronicDocumentFileService.DEFAULT_SERVICE_PATH to send the requests.

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.
String	getServicePath() Getter for the OData service root path.
DefaultDocumentComplianceElectronicDocumentFileService	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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultDocumentComplianceElectronicDocumentFileService

public DefaultDocumentComplianceElectronicDocumentFileService()

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

Method Detail

withServicePath

@Nonnull
public DefaultDocumentComplianceElectronicDocumentFileService withServicePath(@Nonnull
                                                                                       String servicePath)

Description copied from interface: DocumentComplianceElectronicDocumentFileService

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 DocumentComplianceElectronicDocumentFileService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: DocumentComplianceElectronicDocumentFileService

Creates a batch request builder object.

Specified by:

batch in interface DocumentComplianceElectronicDocumentFileService

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
public GetAllRequestBuilder<ElectronicDocFile> getAllElectronicDocFile()

Description copied from interface: DocumentComplianceElectronicDocumentFileService

Fetch multiple ElectronicDocFile entities.

Specified by:

getAllElectronicDocFile in interface DocumentComplianceElectronicDocumentFileService

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
public CountRequestBuilder<ElectronicDocFile> countElectronicDocFile()

Description copied from interface: DocumentComplianceElectronicDocumentFileService

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

Specified by:

countElectronicDocFile in interface DocumentComplianceElectronicDocumentFileService

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
public GetByKeyRequestBuilder<ElectronicDocFile> getElectronicDocFileByKey(@Nonnull
                                                                                    UUID electronicDocFileUUID)

Description copied from interface: DocumentComplianceElectronicDocumentFileService

Fetch a single ElectronicDocFile entity using key fields.

Specified by:

getElectronicDocFileByKey in interface DocumentComplianceElectronicDocumentFileService

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.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.