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

Class DefaultSalesDocumentWithCreditBlocksService

java.lang.Object

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

All Implemented Interfaces:

SalesDocumentWithCreditBlocksService

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

This synchronous inbound service enables you to retrieve sales documents that contain credit blocks, check, release and reject the blocked sales documents with data provided in a sales document. 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_SLS_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.SalesDocumentWithCreditBlocksService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSalesDocumentWithCreditBlocksService() Creates a service using SalesDocumentWithCreditBlocksService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
CheckCreditBlockFluentHelper	checkCreditBlock(String salesDocument, String sDDocumentCategory) CheckCreates a fluent helper for the CheckCreditBlock OData function import.
CreditBlockedSalesDocumentFluentHelper	getAllCreditBlockedSalesDocument() Fetch multiple CreditBlockedSalesDocument entities.
SalesDocumentRjcnReasonFluentHelper	getAllSalesDocumentRjcnReason() Fetch multiple SalesDocumentRjcnReason entities.
CreditBlockedSalesDocumentByKeyFluentHelper	getCreditBlockedSalesDocumentByKey(String salesDocument) Fetch a single CreditBlockedSalesDocument entity using key fields.
SalesDocumentRjcnReasonByKeyFluentHelper	getSalesDocumentRjcnReasonByKey(String salesDocumentRjcnReason) Fetch a single SalesDocumentRjcnReason entity using key fields.
RejectCreditBlockFluentHelper	rejectCreditBlock(String salesDocument, String rejectionCode, String sDDocumentCategory) RejectCreates a fluent helper for the RejectCreditBlock OData function import.
ReleaseCreditBlockFluentHelper	releaseCreditBlock(String sDDocumentCategory, String salesDocument) ReleaseCreates a fluent helper for the ReleaseCreditBlock OData function import.
DefaultSalesDocumentWithCreditBlocksService	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

DefaultSalesDocumentWithCreditBlocksService

public DefaultSalesDocumentWithCreditBlocksService()

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

Method Detail

withServicePath

@Nonnull
public DefaultSalesDocumentWithCreditBlocksService withServicePath(@Nonnull
                                                                            String servicePath)

Description copied from interface: SalesDocumentWithCreditBlocksService

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 SalesDocumentWithCreditBlocksService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllCreditBlockedSalesDocument

@Nonnull
public CreditBlockedSalesDocumentFluentHelper getAllCreditBlockedSalesDocument()

Description copied from interface: SalesDocumentWithCreditBlocksService

Fetch multiple CreditBlockedSalesDocument entities.

Specified by:

getAllCreditBlockedSalesDocument in interface SalesDocumentWithCreditBlocksService

Returns:

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

getCreditBlockedSalesDocumentByKey

@Nonnull
public CreditBlockedSalesDocumentByKeyFluentHelper getCreditBlockedSalesDocumentByKey(String salesDocument)

Description copied from interface: SalesDocumentWithCreditBlocksService

Fetch a single CreditBlockedSalesDocument entity using key fields.

Specified by:

getCreditBlockedSalesDocumentByKey in interface SalesDocumentWithCreditBlocksService

Parameters:

salesDocument - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single CreditBlockedSalesDocument 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: SalesDocumentWithCreditBlocksService

Fetch multiple SalesDocumentRjcnReason entities.

Specified by:

getAllSalesDocumentRjcnReason in interface SalesDocumentWithCreditBlocksService

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: SalesDocumentWithCreditBlocksService

Fetch a single SalesDocumentRjcnReason entity using key fields.

Specified by:

getSalesDocumentRjcnReasonByKey in interface SalesDocumentWithCreditBlocksService

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 salesDocument,
                                                              String sDDocumentCategory)

Description copied from interface: SalesDocumentWithCreditBlocksService

Check

Creates a fluent helper for the CheckCreditBlock OData function import.

Specified by:

checkCreditBlock in interface SalesDocumentWithCreditBlocksService

Parameters:

salesDocument - Constraints: none

Original parameter name from the Odata EDM: SalesDocument

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 salesDocument,
                                                                String rejectionCode,
                                                                String sDDocumentCategory)

Description copied from interface: SalesDocumentWithCreditBlocksService

Reject

Creates a fluent helper for the RejectCreditBlock OData function import.

Specified by:

rejectCreditBlock in interface SalesDocumentWithCreditBlocksService

Parameters:

salesDocument - Constraints: none

Original parameter name from the Odata EDM: SalesDocument

rejectionCode - Constraints: none

Original parameter name from the Odata EDM: RejectionCode

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 salesDocument)

Description copied from interface: SalesDocumentWithCreditBlocksService

Release

Creates a fluent helper for the ReleaseCreditBlock OData function import.

Specified by:

releaseCreditBlock in interface SalesDocumentWithCreditBlocksService

Parameters:

sDDocumentCategory - Constraints: none

Original parameter name from the Odata EDM: SDDocumentCategory

salesDocument - Constraints: none

Original parameter name from the Odata EDM: SalesDocument

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.