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

Class DefaultCashSecurityDepositService

java.lang.Object

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

All Implemented Interfaces:

ServiceWithNavigableEntities, CashSecurityDepositService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultCashSecurityDepositService")
public class DefaultCashSecurityDepositService
extends Object
implements ServiceWithNavigableEntities, 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

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

ServiceWithNavigableEntities.NavigableEntity<EntityT extends VdmEntity<EntityT>>

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.CashSecurityDepositService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCashSecurityDepositService() Creates a service using CashSecurityDepositService.DEFAULT_SERVICE_PATH to send the requests.

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.
String	getServicePath() Getter for the OData service root path.
DefaultCashSecurityDepositService	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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odatav4.core.ServiceWithNavigableEntities

forEntity

Constructor Detail

DefaultCashSecurityDepositService

public DefaultCashSecurityDepositService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCashSecurityDepositService withServicePath(@Nonnull
                                                                  String servicePath)

Description copied from interface: CashSecurityDepositService

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 CashSecurityDepositService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Description copied from interface: CashSecurityDepositService

Creates a batch request builder object.

Specified by:

batch in interface CashSecurityDepositService

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
public GetAllRequestBuilder<CAScrtyDepDocumentFlow> getAllCAScrtyDepDocumentFlow()

Description copied from interface: CashSecurityDepositService

Fetch multiple CAScrtyDepDocumentFlow entities.

Specified by:

getAllCAScrtyDepDocumentFlow in interface CashSecurityDepositService

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
public CountRequestBuilder<CAScrtyDepDocumentFlow> countCAScrtyDepDocumentFlow()

Description copied from interface: CashSecurityDepositService

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

Specified by:

countCAScrtyDepDocumentFlow in interface CashSecurityDepositService

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
public GetByKeyRequestBuilder<CAScrtyDepDocumentFlow> getCAScrtyDepDocumentFlowByKey(@Nonnull
                                                                                              String cASecurityDeposit,
                                                                                              @Nonnull
                                                                                              String cADocumentNumber,
                                                                                              @Nonnull
                                                                                              String cAScrtyDepositClearedDocument)

Description copied from interface: CashSecurityDepositService

Fetch a single CAScrtyDepDocumentFlow entity using key fields.

Specified by:

getCAScrtyDepDocumentFlowByKey in interface CashSecurityDepositService

Parameters:

cASecurityDeposit - Security Deposit

Constraints: Not nullable, Maximum length: 12

cADocumentNumber -

Constraints: Not nullable, Maximum length: 12

cAScrtyDepositClearedDocument - Number of Cleared Document

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
public GetAllRequestBuilder<CASecurityDeposit> getAllCASecurityDeposit()

Description copied from interface: CashSecurityDepositService

Fetch multiple CASecurityDeposit entities.

Specified by:

getAllCASecurityDeposit in interface CashSecurityDepositService

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
public CountRequestBuilder<CASecurityDeposit> countCASecurityDeposit()

Description copied from interface: CashSecurityDepositService

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

Specified by:

countCASecurityDeposit in interface CashSecurityDepositService

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
public GetByKeyRequestBuilder<CASecurityDeposit> getCASecurityDepositByKey(@Nonnull
                                                                                    String cASecurityDeposit)

Description copied from interface: CashSecurityDepositService

Fetch a single CASecurityDeposit entity using key fields.

Specified by:

getCASecurityDepositByKey in interface CashSecurityDepositService

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
public CreateRequestBuilder<CASecurityDeposit> createCASecurityDeposit(@Nonnull
                                                                                CASecurityDeposit cASecurityDeposit)

Description copied from interface: CashSecurityDepositService

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

Specified by:

createCASecurityDeposit in interface CashSecurityDepositService

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
public GetAllRequestBuilder<CASecurityDepositReqDetail> getAllCASecurityDepositReqDetail()

Description copied from interface: CashSecurityDepositService

Fetch multiple CASecurityDepositReqDetail entities.

Specified by:

getAllCASecurityDepositReqDetail in interface CashSecurityDepositService

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
public CountRequestBuilder<CASecurityDepositReqDetail> countCASecurityDepositReqDetail()

Description copied from interface: CashSecurityDepositService

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

Specified by:

countCASecurityDepositReqDetail in interface CashSecurityDepositService

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
public GetByKeyRequestBuilder<CASecurityDepositReqDetail> getCASecurityDepositReqDetailByKey(@Nonnull
                                                                                                      String cASecurityDeposit,
                                                                                                      @Nonnull
                                                                                                      String cADocumentNumber)

Description copied from interface: CashSecurityDepositService

Fetch a single CASecurityDepositReqDetail entity using key fields.

Specified by:

getCASecurityDepositReqDetailByKey in interface CashSecurityDepositService

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
public CreateRequestBuilder<CASecurityDepositReqDetail> createCASecurityDepositReqDetail(@Nonnull
                                                                                                  CASecurityDepositReqDetail cASecurityDepositReqDetail)

Description copied from interface: CashSecurityDepositService

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

Specified by:

createCASecurityDepositReqDetail in interface CashSecurityDepositService

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.

getServicePath

@Nonnull
public String getServicePath()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.