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

Class DefaultContractAccountingDocumentManageService

java.lang.Object

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

All Implemented Interfaces:

OperationsOnEntityCollections, ServiceWithNavigableEntities, ContractAccountingDocumentManageService

@Named("com.sap.cloud.sdk.s4hana.datamodel.odatav4.services.DefaultContractAccountingDocumentManageService")
@Deprecated
public class DefaultContractAccountingDocumentManageService
extends Object
implements ServiceWithNavigableEntities, ContractAccountingDocumentManageService

Deprecated.

The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

Retrieve a list of documents. Read data on document header, document business partner line items and document general ledger line items. Update document header and document business partner line items. Create and delete business locks on existing business partner line items..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service:	CADOCUMENTMANAGE_0001
API Version:	1.1.0
Minimum ERP Version:	2302
Communication Scenario:	Finance - Contract Accounting Open Item Management Integration(SAP_COM_0361)
Scope Items:	Contract Accounting - Open Item Management(2UJ), Contract Accounting: Open Item Management(PUJ)
Authentication Methods:	x509
Service Group Name:	API_CADOCUMENTMANAGE
Business Object:	Contract Accounting Document

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor	Description
DefaultContractAccountingDocumentManageService()	Deprecated. Creates a service using ContractAccountingDocumentManageService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method	Description
BatchRequestBuilder	batch()	Deprecated. Creates a batch request builder object.
CountRequestBuilder<CADocBPItem>	countBPItem()	Deprecated. Fetch the number of entries from the CADocBPItem entity collection matching the filter and search expressions.
CountRequestBuilder<CADocBPItemBusLock>	countBPItemBusLock()	Deprecated. Fetch the number of entries from the CADocBPItemBusLock entity collection matching the filter and search expressions.
CountRequestBuilder<CADocBPItemLogical>	countBPItemLogical()	Deprecated. Fetch the number of entries from the CADocBPItemLogical entity collection matching the filter and search expressions.
CountRequestBuilder<CADocHeader>	countDocumentHeader()	Deprecated. Fetch the number of entries from the CADocHeader entity collection matching the filter and search expressions.
CountRequestBuilder<CADocGLItem>	countGLItem()	Deprecated. Fetch the number of entries from the CADocGLItem entity collection matching the filter and search expressions.
CreateRequestBuilder<CADocBPItem>	createBPItem(CADocBPItem cADocBPItem)	Deprecated. Create a new CADocBPItem entity and save it to the S/4HANA system.
DeleteRequestBuilder<CADocBPItemBusLock>	deleteBPItemBusLock(CADocBPItemBusLock cADocBPItemBusLock)	Deprecated. Deletes an existing CADocBPItemBusLock entity in the S/4HANA system.
GetAllRequestBuilder<CADocBPItem>	getAllBPItem()	Deprecated. Fetch multiple CADocBPItem entities.
GetAllRequestBuilder<CADocBPItemBusLock>	getAllBPItemBusLock()	Deprecated. Fetch multiple CADocBPItemBusLock entities.
GetAllRequestBuilder<CADocBPItemLogical>	getAllBPItemLogical()	Deprecated. Fetch multiple CADocBPItemLogical entities.
GetAllRequestBuilder<CADocHeader>	getAllDocumentHeader()	Deprecated. Fetch multiple CADocHeader entities.
GetAllRequestBuilder<CADocGLItem>	getAllGLItem()	Deprecated. Fetch multiple CADocGLItem entities.
GetByKeyRequestBuilder<CADocBPItemBusLock>	getBPItemBusLockByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber, String cABusinessProcess, String cABusinessLockReason, LocalDate cABusinessLockValidFrom, LocalDate cABusinessLockValidTo)	Deprecated. Fetch a single CADocBPItemBusLock entity using key fields.
GetByKeyRequestBuilder<CADocBPItem>	getBPItemByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber)	Deprecated. Fetch a single CADocBPItem entity using key fields.
GetByKeyRequestBuilder<CADocBPItemLogical>	getBPItemLogicalByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber)	Deprecated. Fetch a single CADocBPItemLogical entity using key fields.
GetByKeyRequestBuilder<CADocHeader>	getDocumentHeaderByKey(String cADocumentNumber)	Deprecated. Fetch a single CADocHeader entity using key fields.
GetByKeyRequestBuilder<CADocGLItem>	getGLItemByKey(String cADocumentNumber, String cAGLItemNumber)	Deprecated. Fetch a single CADocGLItem entity using key fields.
String	getServicePath()	Deprecated.
UpdateRequestBuilder<CADocBPItem>	updateBPItem(CADocBPItem cADocBPItem)	Deprecated. Update an existing CADocBPItem entity and save it to the S/4HANA system.
UpdateRequestBuilder<CADocHeader>	updateDocumentHeader(CADocHeader cADocHeader)	Deprecated. Update an existing CADocHeader entity and save it to the S/4HANA system.
DefaultContractAccountingDocumentManageService	withServicePath(String servicePath)	Deprecated. 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

applyAction, applyAction, applyFunction, applyFunction, forEntity, withFunction, withFunction

Constructor Details

DefaultContractAccountingDocumentManageService

public DefaultContractAccountingDocumentManageService()

Deprecated.

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

Method Details

withServicePath

@Nonnull
public DefaultContractAccountingDocumentManageService withServicePath(@Nonnull
 String servicePath)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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 ContractAccountingDocumentManageService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public BatchRequestBuilder batch()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Creates a batch request builder object.

Specified by:

batch in interface ContractAccountingDocumentManageService

Returns:

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

getAllBPItem

@Nonnull
public GetAllRequestBuilder<CADocBPItem> getAllBPItem()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple CADocBPItem entities.

Specified by:

getAllBPItem in interface ContractAccountingDocumentManageService

Returns:

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

countBPItem

@Nonnull
public CountRequestBuilder<CADocBPItem> countBPItem()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countBPItem in interface ContractAccountingDocumentManageService

Returns:

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

getBPItemByKey

@Nonnull
public GetByKeyRequestBuilder<CADocBPItem> getBPItemByKey(String cADocumentNumber,
 String cARepetitionItemNumber,
 String cABPItemNumber,
 String cASubItemNumber)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single CADocBPItem entity using key fields.

Specified by:

getBPItemByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cARepetitionItemNumber - Repetition Item in FI-CA Document

Constraints: Not nullable, Maximum length: 3

cABPItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

cASubItemNumber - Subitem for a Partial Clearing in Document

Constraints: Not nullable, Maximum length: 3

Returns:

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

createBPItem

@Nonnull
public CreateRequestBuilder<CADocBPItem> createBPItem(@Nonnull
 CADocBPItem cADocBPItem)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

createBPItem in interface ContractAccountingDocumentManageService

Parameters:

cADocBPItem - CADocBPItem entity object that will be created in the S/4HANA system.

Returns:

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

updateBPItem

@Nonnull
public UpdateRequestBuilder<CADocBPItem> updateBPItem(@Nonnull
 CADocBPItem cADocBPItem)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Update an existing CADocBPItem entity and save it to the S/4HANA system.

Specified by:

updateBPItem in interface ContractAccountingDocumentManageService

Parameters:

cADocBPItem - CADocBPItem entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing CADocBPItem entity. To perform execution, call the execute method on the request builder object.

getAllBPItemBusLock

@Nonnull
public GetAllRequestBuilder<CADocBPItemBusLock> getAllBPItemBusLock()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple CADocBPItemBusLock entities.

Specified by:

getAllBPItemBusLock in interface ContractAccountingDocumentManageService

Returns:

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

countBPItemBusLock

@Nonnull
public CountRequestBuilder<CADocBPItemBusLock> countBPItemBusLock()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countBPItemBusLock in interface ContractAccountingDocumentManageService

Returns:

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

getBPItemBusLockByKey

@Nonnull
public GetByKeyRequestBuilder<CADocBPItemBusLock> getBPItemBusLockByKey(String cADocumentNumber,
 String cARepetitionItemNumber,
 String cABPItemNumber,
 String cASubItemNumber,
 String cABusinessProcess,
 String cABusinessLockReason,
 LocalDate cABusinessLockValidFrom,
 LocalDate cABusinessLockValidTo)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single CADocBPItemBusLock entity using key fields.

Specified by:

getBPItemBusLockByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Document

Constraints: Not nullable, Maximum length: 12

cARepetitionItemNumber - Repetition Item in FI-CA Document

Constraints: Not nullable, Maximum length: 3

cABPItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

cASubItemNumber - Subitem for a Partial Clearing in Document

Constraints: Not nullable, Maximum length: 3

cABusinessProcess - Process Code (Example: Dunning, Payment)

Constraints: Not nullable, Maximum length: 2

cABusinessLockReason - Lock Reason

Constraints: Not nullable, Maximum length: 1

cABusinessLockValidFrom - Lock valid from

Constraints: Not nullable

cABusinessLockValidTo - Lock valid to

Constraints: Not nullable

Returns:

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

deleteBPItemBusLock

@Nonnull
public DeleteRequestBuilder<CADocBPItemBusLock> deleteBPItemBusLock(@Nonnull
 CADocBPItemBusLock cADocBPItemBusLock)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Deletes an existing CADocBPItemBusLock entity in the S/4HANA system.

Specified by:

deleteBPItemBusLock in interface ContractAccountingDocumentManageService

Parameters:

cADocBPItemBusLock - CADocBPItemBusLock entity object that will be deleted in the S/4HANA system.

Returns:

A request builder to delete an existing CADocBPItemBusLock entity. To perform execution, call the execute method on the request builder object.

getAllBPItemLogical

@Nonnull
public GetAllRequestBuilder<CADocBPItemLogical> getAllBPItemLogical()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple CADocBPItemLogical entities.

Specified by:

getAllBPItemLogical in interface ContractAccountingDocumentManageService

Returns:

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

countBPItemLogical

@Nonnull
public CountRequestBuilder<CADocBPItemLogical> countBPItemLogical()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countBPItemLogical in interface ContractAccountingDocumentManageService

Returns:

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

getBPItemLogicalByKey

@Nonnull
public GetByKeyRequestBuilder<CADocBPItemLogical> getBPItemLogicalByKey(String cADocumentNumber,
 String cARepetitionItemNumber,
 String cABPItemNumber,
 String cASubItemNumber)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single CADocBPItemLogical entity using key fields.

Specified by:

getBPItemLogicalByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cARepetitionItemNumber - Repetition Item in FI-CA Document

Constraints: Not nullable, Maximum length: 3

cABPItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

cASubItemNumber - Subitem for a Partial Clearing in Document

Constraints: Not nullable, Maximum length: 3

Returns:

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

getAllDocumentHeader

@Nonnull
public GetAllRequestBuilder<CADocHeader> getAllDocumentHeader()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple CADocHeader entities.

Specified by:

getAllDocumentHeader in interface ContractAccountingDocumentManageService

Returns:

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

countDocumentHeader

@Nonnull
public CountRequestBuilder<CADocHeader> countDocumentHeader()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countDocumentHeader in interface ContractAccountingDocumentManageService

Returns:

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

getDocumentHeaderByKey

@Nonnull
public GetByKeyRequestBuilder<CADocHeader> getDocumentHeaderByKey(String cADocumentNumber)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single CADocHeader entity using key fields.

Specified by:

getDocumentHeaderByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

Returns:

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

updateDocumentHeader

@Nonnull
public UpdateRequestBuilder<CADocHeader> updateDocumentHeader(@Nonnull
 CADocHeader cADocHeader)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Update an existing CADocHeader entity and save it to the S/4HANA system.

Specified by:

updateDocumentHeader in interface ContractAccountingDocumentManageService

Parameters:

cADocHeader - CADocHeader entity object that will be updated in the S/4HANA system.

Returns:

A request builder to update an existing CADocHeader entity. To perform execution, call the execute method on the request builder object.

getAllGLItem

@Nonnull
public GetAllRequestBuilder<CADocGLItem> getAllGLItem()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple CADocGLItem entities.

Specified by:

getAllGLItem in interface ContractAccountingDocumentManageService

Returns:

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

countGLItem

@Nonnull
public CountRequestBuilder<CADocGLItem> countGLItem()

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countGLItem in interface ContractAccountingDocumentManageService

Returns:

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

getGLItemByKey

@Nonnull
public GetByKeyRequestBuilder<CADocGLItem> getGLItemByKey(String cADocumentNumber,
 String cAGLItemNumber)

Deprecated.

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single CADocGLItem entity using key fields.

Specified by:

getGLItemByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cAGLItemNumber - Item Number in FI-CA Document

Constraints: Not nullable, Maximum length: 4

Returns:

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

getServicePath

@Nonnull
public String getServicePath()

Deprecated.

Specified by:

getServicePath in interface ServiceWithNavigableEntities