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

Class DefaultCustomerDataReturnFileDownloadService

java.lang.Object

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

All Implemented Interfaces:

BatchService<CustomerDataReturnFileDownloadServiceBatch>, CustomerDataReturnFileDownloadService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCustomerDataReturnFileDownloadService")
@Deprecated
public class DefaultCustomerDataReturnFileDownloadService
extends Object
implements CustomerDataReturnFileDownloadService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

This service can be consumed by external application to download all business data from SAP S/4HANA Cloud systems, prepared using Customer Data Return - Extraction app, to a local machine or third party storage. You can use this service to: - Download prepared files in compressed format - Retrieve list of prepared files - Retrieve download status details of files It returns an appropriate success or error response while performing the operations. .

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	API_CDR_FILE_DOWNLOAD_SRV
API Version:	1.0.0
Minimum ERP Version:	2302
Communication Scenario:	Customer Data Return Integration(SAP_COM_0589)
Scope Items:	Customer Data Return(5I9)
Authentication Methods:	x509

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultCustomerDataReturnFileDownloadService()	Deprecated. Creates a service using CustomerDataReturnFileDownloadService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
DefaultCustomerDataReturnFileDownloadServiceBatch	batch()	Deprecated.
FileDownloadStatusFluentHelper	getAllFileDownloadStatus()	Deprecated. Fetch multiple FileDownloadStatus entities.
ListFileFluentHelper	getAllListFile()	Deprecated. Fetch multiple ListFile entities.
DownloadFileByKeyFluentHelper	getDownloadFileByKey(String packageName, String fileName)	Deprecated. Fetch a single DownloadFile entity using key fields.
DefaultCustomerDataReturnFileDownloadService	withServicePath(String servicePath)	Deprecated. 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 Details

DefaultCustomerDataReturnFileDownloadService

public DefaultCustomerDataReturnFileDownloadService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultCustomerDataReturnFileDownloadService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Description copied from interface: CustomerDataReturnFileDownloadService

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 CustomerDataReturnFileDownloadService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCustomerDataReturnFileDownloadServiceBatch batch()

Deprecated.

Specified by:

batch in interface BatchService<CustomerDataReturnFileDownloadServiceBatch>

getAllListFile

@Nonnull
public ListFileFluentHelper getAllListFile()

Deprecated.

Description copied from interface: CustomerDataReturnFileDownloadService

Fetch multiple ListFile entities.

Specified by:

getAllListFile in interface CustomerDataReturnFileDownloadService

Returns:

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

getDownloadFileByKey

@Nonnull
public DownloadFileByKeyFluentHelper getDownloadFileByKey(String packageName,
 String fileName)

Deprecated.

Description copied from interface: CustomerDataReturnFileDownloadService

Fetch a single DownloadFile entity using key fields.

Specified by:

getDownloadFileByKey in interface CustomerDataReturnFileDownloadService

Parameters:

packageName - Package Name

Constraints: Not nullable, Maximum length: 32

fileName - ZIP File Name

Constraints: Not nullable, Maximum length: 60

Returns:

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

getAllFileDownloadStatus

@Nonnull
public FileDownloadStatusFluentHelper getAllFileDownloadStatus()

Deprecated.

Description copied from interface: CustomerDataReturnFileDownloadService

Fetch multiple FileDownloadStatus entities.

Specified by:

getAllFileDownloadStatus in interface CustomerDataReturnFileDownloadService

Returns:

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