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

Interface CashSecurityDepositService

All Known Implementing Classes:

DefaultCashSecurityDepositService

public interface CashSecurityDepositService

The service contains a list of security deposits. With this service you can create, read, update cash security deposits. You can change header information, add request documents, reverse, clear, release or reset the release of specific cash security deposits. After a request to fetch security deposits is sent, all filtered security deposits are returned. After a security deposit has been created using the Create operation a new security deposit number and the message header are returned. After a security deposit has been revised, for example, by using the Change or Create Request Operation operation, the number of that revised security deposit and the message header are returned..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CASECURITYDEPOSIT_0001
API Version:	1
Communication Scenario:	Finance - Contract Accounting Security Deposits Integration (SAP_COM_0380)
Scope Items:	Contract Accounting - Open Item Management (2UJ)
Authentication Methods:	Basic, x509
Service Group Name:	API_CASECURITYDEPOSIT
Business Object:	ContrAcctgSecurityDeposit

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<CAScrtyDepDocumentFlow>	countCAScrtyDepDocumentFlow() Fetch the number of entries from the CAScrtyDepDocumentFlow entity collection matching the filter and search expressions.
CountRequestBuilder<CASecurityDeposit>	countCASecurityDeposit() Fetch the number of entries from the CASecurityDeposit entity collection matching the filter and search expressions.
CountRequestBuilder<CASecurityDepositReqDetail>	countCASecurityDepositReqDetail() Fetch the number of entries from the CASecurityDepositReqDetail entity collection matching the filter and search expressions.
CreateRequestBuilder<CASecurityDeposit>	createCASecurityDeposit(CASecurityDeposit cASecurityDeposit) Create a new CASecurityDeposit entity and save it to the S/4HANA system.
CreateRequestBuilder<CASecurityDepositReqDetail>	createCASecurityDepositReqDetail(CASecurityDepositReqDetail cASecurityDepositReqDetail) Create a new CASecurityDepositReqDetail entity and save it to the S/4HANA system.
GetAllRequestBuilder<CAScrtyDepDocumentFlow>	getAllCAScrtyDepDocumentFlow() Fetch multiple CAScrtyDepDocumentFlow entities.
GetAllRequestBuilder<CASecurityDeposit>	getAllCASecurityDeposit() Fetch multiple CASecurityDeposit entities.
GetAllRequestBuilder<CASecurityDepositReqDetail>	getAllCASecurityDepositReqDetail() Fetch multiple CASecurityDepositReqDetail entities.
GetByKeyRequestBuilder<CAScrtyDepDocumentFlow>	getCAScrtyDepDocumentFlowByKey(String cASecurityDeposit, String cADocumentNumber, String cAScrtyDepositClearedDocument) Fetch a single CAScrtyDepDocumentFlow entity using key fields.
GetByKeyRequestBuilder<CASecurityDeposit>	getCASecurityDepositByKey(String cASecurityDeposit) Fetch a single CASecurityDeposit entity using key fields.
GetByKeyRequestBuilder<CASecurityDepositReqDetail>	getCASecurityDepositReqDetailByKey(String cASecurityDeposit, String cADocumentNumber) Fetch a single CASecurityDepositReqDetail entity using key fields.
CashSecurityDepositService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
CashSecurityDepositService withServicePath(@Nonnull
                                                    String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
BatchRequestBuilder batch()

Creates a batch request builder object.

Returns:

A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.

getAllCAScrtyDepDocumentFlow

@Nonnull
GetAllRequestBuilder<CAScrtyDepDocumentFlow> getAllCAScrtyDepDocumentFlow()

Fetch multiple CAScrtyDepDocumentFlow entities.

Returns:

A request builder to fetch multiple CAScrtyDepDocumentFlow 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.

countCAScrtyDepDocumentFlow

@Nonnull
CountRequestBuilder<CAScrtyDepDocumentFlow> countCAScrtyDepDocumentFlow()

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

Returns:

A request builder to fetch the count of CAScrtyDepDocumentFlow 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.

getCAScrtyDepDocumentFlowByKey

@Nonnull
GetByKeyRequestBuilder<CAScrtyDepDocumentFlow> getCAScrtyDepDocumentFlowByKey(@Nonnull
                                                                                       String cASecurityDeposit,
                                                                                       @Nonnull
                                                                                       String cADocumentNumber,
                                                                                       @Nonnull
                                                                                       String cAScrtyDepositClearedDocument)

Fetch a single CAScrtyDepDocumentFlow entity using key fields.

Parameters:

cASecurityDeposit - Security Deposit

Constraints: Not nullable, Maximum length: 12

cAScrtyDepositClearedDocument - Number of Cleared Document

Constraints: Not nullable, Maximum length: 12

cADocumentNumber -

Constraints: Not nullable, Maximum length: 12

Returns:

A request builder to fetch a single CAScrtyDepDocumentFlow 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.

getAllCASecurityDeposit

@Nonnull
GetAllRequestBuilder<CASecurityDeposit> getAllCASecurityDeposit()

Fetch multiple CASecurityDeposit entities.

Returns:

A request builder to fetch multiple CASecurityDeposit 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.

countCASecurityDeposit

@Nonnull
CountRequestBuilder<CASecurityDeposit> countCASecurityDeposit()

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

Returns:

A request builder to fetch the count of CASecurityDeposit 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.

getCASecurityDepositByKey

@Nonnull
GetByKeyRequestBuilder<CASecurityDeposit> getCASecurityDepositByKey(@Nonnull
                                                                             String cASecurityDeposit)

Fetch a single CASecurityDeposit entity using key fields.

Parameters:

cASecurityDeposit - Security Deposit

Constraints: Not nullable, Maximum length: 12

Returns:

A request builder to fetch a single CASecurityDeposit 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.

createCASecurityDeposit

@Nonnull
CreateRequestBuilder<CASecurityDeposit> createCASecurityDeposit(@Nonnull
                                                                         CASecurityDeposit cASecurityDeposit)

Create a new CASecurityDeposit entity and save it to the S/4HANA system.

Parameters:

cASecurityDeposit - CASecurityDeposit entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new CASecurityDeposit entity. To perform execution, call the execute method on the request builder object.

getAllCASecurityDepositReqDetail

@Nonnull
GetAllRequestBuilder<CASecurityDepositReqDetail> getAllCASecurityDepositReqDetail()

Fetch multiple CASecurityDepositReqDetail entities.

Returns:

A request builder to fetch multiple CASecurityDepositReqDetail 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.

countCASecurityDepositReqDetail

@Nonnull
CountRequestBuilder<CASecurityDepositReqDetail> countCASecurityDepositReqDetail()

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

Returns:

A request builder to fetch the count of CASecurityDepositReqDetail 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.

getCASecurityDepositReqDetailByKey

@Nonnull
GetByKeyRequestBuilder<CASecurityDepositReqDetail> getCASecurityDepositReqDetailByKey(@Nonnull
                                                                                               String cASecurityDeposit,
                                                                                               @Nonnull
                                                                                               String cADocumentNumber)

Fetch a single CASecurityDepositReqDetail entity using key fields.

Parameters:

cASecurityDeposit - Security Deposit

Constraints: Not nullable, Maximum length: 12

cADocumentNumber -

Constraints: Not nullable, Maximum length: 12

Returns:

A request builder to fetch a single CASecurityDepositReqDetail 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.

createCASecurityDepositReqDetail

@Nonnull
CreateRequestBuilder<CASecurityDepositReqDetail> createCASecurityDepositReqDetail(@Nonnull
                                                                                           CASecurityDepositReqDetail cASecurityDepositReqDetail)

Create a new CASecurityDepositReqDetail entity and save it to the S/4HANA system.

Parameters:

cASecurityDepositReqDetail - CASecurityDepositReqDetail entity object that will be created in the S/4HANA system.

Returns:

A request builder to create a new CASecurityDepositReqDetail entity. To perform execution, call the execute method on the request builder object.