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

Class DefaultDeliveryDocumentWithCreditBlocksService

java.lang.Object

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

All Implemented Interfaces:

BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>, DeliveryDocumentWithCreditBlocksService

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

This synchronous inbound service enables you to read delivery documents that contain credit blocks, and check, release and reject the blocked delivery documents. It is based on the OData protocol and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_DEL_DOC_WITH_CREDIT_BLOCK
API Version:	1
Communication Scenario:	Sales Credit Management Integration (SAP_COM_0325)
Scope Items:	Basic Credit Management (BD6)
Authentication Methods:	Basic, x509, OAuth2

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultDeliveryDocumentWithCreditBlocksService() Creates a service using DeliveryDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultDeliveryDocumentWithCreditBlocksServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
CheckCreditBlockFluentHelper	checkCreditBlock(String deliveryDocument, String sDDocumentCategory) Check
CreditBlockedDeliveryDocFluentHelper	getAllCreditBlockedDeliveryDoc() Fetch multiple CreditBlockedDeliveryDoc entities.
SalesDocumentRjcnReasonFluentHelper	getAllSalesDocumentRjcnReason() Fetch multiple SalesDocumentRjcnReason entities.
CreditBlockedDeliveryDocByKeyFluentHelper	getCreditBlockedDeliveryDocByKey(String deliveryDocument) Fetch a single CreditBlockedDeliveryDoc entity using key fields.
SalesDocumentRjcnReasonByKeyFluentHelper	getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason) Fetch a single SalesDocumentRjcnReason entity using key fields.
RejectCreditBlockFluentHelper	rejectCreditBlock(String deliveryDocument, String salesDocumentRjcnReason, String sDDocumentCategory) Reject
ReleaseCreditBlockFluentHelper	releaseCreditBlock(String sDDocumentCategory, String deliveryDocument) Release
DefaultDeliveryDocumentWithCreditBlocksService	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

DefaultDeliveryDocumentWithCreditBlocksService

public DefaultDeliveryDocumentWithCreditBlocksService()

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

Method Detail

withServicePath

@Nonnull
public DefaultDeliveryDocumentWithCreditBlocksService withServicePath(@Nonnull
                                                                               String servicePath)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

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 DeliveryDocumentWithCreditBlocksService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultDeliveryDocumentWithCreditBlocksServiceBatch batch()

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

Specified by:

batch in interface BatchService<DeliveryDocumentWithCreditBlocksServiceBatch>

Returns:

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

getAllCreditBlockedDeliveryDoc

@Nonnull
public CreditBlockedDeliveryDocFluentHelper getAllCreditBlockedDeliveryDoc()

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Fetch multiple CreditBlockedDeliveryDoc entities.

Specified by:

getAllCreditBlockedDeliveryDoc in interface DeliveryDocumentWithCreditBlocksService

Returns:

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

getCreditBlockedDeliveryDocByKey

@Nonnull
public CreditBlockedDeliveryDocByKeyFluentHelper getCreditBlockedDeliveryDocByKey(String deliveryDocument)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Fetch a single CreditBlockedDeliveryDoc entity using key fields.

Specified by:

getCreditBlockedDeliveryDocByKey in interface DeliveryDocumentWithCreditBlocksService

Parameters:

deliveryDocument - The number that uniquely identifies the delivery.

Constraints: Not nullable, Maximum length: 10

Returns:

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

getAllSalesDocumentRjcnReason

@Nonnull
public SalesDocumentRjcnReasonFluentHelper getAllSalesDocumentRjcnReason()

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Fetch multiple SalesDocumentRjcnReason entities.

Specified by:

getAllSalesDocumentRjcnReason in interface DeliveryDocumentWithCreditBlocksService

Returns:

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

getSalesDocumentRjcnReasonByKey

@Nonnull
public SalesDocumentRjcnReasonByKeyFluentHelper getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Fetch a single SalesDocumentRjcnReason entity using key fields.

Specified by:

getSalesDocumentRjcnReasonByKey in interface DeliveryDocumentWithCreditBlocksService

Parameters:

salesDocumentRjcnReason - The reason for rejecting a sales document (for example, a sales quotation or a sales order).

Constraints: Not nullable, Maximum length: 2

Returns:

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

checkCreditBlock

@Nonnull
public CheckCreditBlockFluentHelper checkCreditBlock(String deliveryDocument,
                                                              String sDDocumentCategory)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Check

Creates a fluent helper for the CheckCreditBlock OData function import.

Specified by:

checkCreditBlock in interface DeliveryDocumentWithCreditBlocksService

Parameters:

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

Returns:

A fluent helper object that will execute the CheckCreditBlock OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

rejectCreditBlock

@Nonnull
public RejectCreditBlockFluentHelper rejectCreditBlock(String deliveryDocument,
                                                                String salesDocumentRjcnReason,
                                                                String sDDocumentCategory)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Reject

Creates a fluent helper for the RejectCreditBlock OData function import.

Specified by:

rejectCreditBlock in interface DeliveryDocumentWithCreditBlocksService

Parameters:

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

salesDocumentRjcnReason - Constraints: none

Original parameter name from the Odata EDM: SalesDocumentRjcnReason

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

Returns:

A fluent helper object that will execute the RejectCreditBlock OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

releaseCreditBlock

@Nonnull
public ReleaseCreditBlockFluentHelper releaseCreditBlock(String sDDocumentCategory,
                                                                  String deliveryDocument)

Description copied from interface: DeliveryDocumentWithCreditBlocksService

Release

Creates a fluent helper for the ReleaseCreditBlock OData function import.

Specified by:

releaseCreditBlock in interface DeliveryDocumentWithCreditBlocksService

Parameters:

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

deliveryDocument - Constraints: none

Original parameter name from the Odata EDM: DeliveryDocument

Returns:

A fluent helper object that will execute the ReleaseCreditBlock OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.