com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.batch

Class DefaultDocumentManagementServiceBatch

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchFluentHelperBasic<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.documentmanagement.batch.DefaultDocumentManagementServiceBatch

All Implemented Interfaces:

FluentHelperServiceBatch<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>, FluentHelperServiceBatchExecute, DocumentManagementServiceBatch

public class DefaultDocumentManagementServiceBatch
extends BatchFluentHelperBasic<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>
implements DocumentManagementServiceBatch

Default implementation of the DocumentManagementServiceBatch interface exposed in the DocumentManagementService, allowing you to create multiple changesets and finally execute the batch request.

Constructor Summary

Constructors

Constructor and Description
DefaultDocumentManagementServiceBatch(DocumentManagementService service) Creates a new instance of this DefaultDocumentManagementServiceBatch.

Method Summary

Modifier and Type	Method and Description
DocumentManagementServiceBatchChangeSet	beginChangeSet() Method to define a new OData batch changeset.
protected String	getServicePathForBatchRequest() Get the OData service endpoint path for the current OData batch request.
protected DefaultDocumentManagementServiceBatch	getThis() Method to safely return the current fluent helper instance upon public method calls.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchFluentHelperBasic

addReadOperations, addReadOperations, cachingMetadata, execute, executeRequest, toRequest, withoutCachingMetadata, withoutCsrfToken

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.odata.helper.batch.FluentHelperServiceBatch

addReadOperations, addReadOperations, cachingMetadata, withoutCachingMetadata

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

execute, executeRequest

Constructor Detail

DefaultDocumentManagementServiceBatch

public DefaultDocumentManagementServiceBatch(@Nonnull
                                             DocumentManagementService service)

Creates a new instance of this DefaultDocumentManagementServiceBatch.

Parameters:

service - The service to execute all operations in this changeset on.

Method Detail

getServicePathForBatchRequest

@Nonnull
protected String getServicePathForBatchRequest()

Get the OData service endpoint path for the current OData batch request. Usually it can be found as static member DEFAULT_SERVICE_PATH in the service class.

Specified by:

getServicePathForBatchRequest in class BatchFluentHelperBasic<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>

Returns:

The String representation of the OData service endpoint path.

getThis

@Nonnull
protected DefaultDocumentManagementServiceBatch getThis()

Method to safely return the current fluent helper instance upon public method calls.

Specified by:

getThis in class BatchFluentHelperBasic<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>

Returns:

The current fluent helper instance.

beginChangeSet

@Nonnull
public DocumentManagementServiceBatchChangeSet beginChangeSet()

Method to define a new OData batch changeset. Modifying operations on entities in a batch request can only be done as part of a changeset. All changesets will be evaluated independently from each other.

Specified by:

beginChangeSet in interface FluentHelperServiceBatch<DocumentManagementServiceBatch,DocumentManagementServiceBatchChangeSet>

Returns:

A new instance of a batch changeset associated with the OData service.