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:

ServiceWithNavigableEntities, ContractAccountingDocumentManageService

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

Retrieve a list of documents. Read data on document header, document business partner line items and document general ledger line items. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	CADOCUMENTMANAGE_0001
API Version:	1
Communication Scenario:	Finance - Contract Accounting Open Item Management Integration (SAP_COM_0361)
Scope Items:	Contract Accounting - Open Item Management (2UJ)
Authentication Methods:	Basic, x509
Service Group Name:	API_CADOCUMENTMANAGE
Business Object:	ContrAcctgDocument

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.ContractAccountingDocumentManageService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<BPItemLogical>	countBPItemLogical() Fetch the number of entries from the BPItemLogical entity collection matching the filter and search expressions.
CountRequestBuilder<BPItemPaytData>	countBPItemPaytData() Fetch the number of entries from the BPItemPaytData entity collection matching the filter and search expressions.
CountRequestBuilder<DocumentHeader>	countDocumentHeader() Fetch the number of entries from the DocumentHeader entity collection matching the filter and search expressions.
CountRequestBuilder<GLItem>	countGLItem() Fetch the number of entries from the GLItem entity collection matching the filter and search expressions.
CountRequestBuilder<GLItemPaytData>	countGLItemPaytData() Fetch the number of entries from the GLItemPaytData entity collection matching the filter and search expressions.
GetAllRequestBuilder<BPItemLogical>	getAllBPItemLogical() Fetch multiple BPItemLogical entities.
GetAllRequestBuilder<BPItemPaytData>	getAllBPItemPaytData() Fetch multiple BPItemPaytData entities.
GetAllRequestBuilder<DocumentHeader>	getAllDocumentHeader() Fetch multiple DocumentHeader entities.
GetAllRequestBuilder<GLItem>	getAllGLItem() Fetch multiple GLItem entities.
GetAllRequestBuilder<GLItemPaytData>	getAllGLItemPaytData() Fetch multiple GLItemPaytData entities.
GetByKeyRequestBuilder<BPItemLogical>	getBPItemLogicalByKey(String cADocumentNumber, String cARepetitionItemNumber, String cABPItemNumber, String cASubItemNumber) Fetch a single BPItemLogical entity using key fields.
GetByKeyRequestBuilder<BPItemPaytData>	getBPItemPaytDataByKey(String cADocumentNumber, String cAGroupingForPayment) Fetch a single BPItemPaytData entity using key fields.
GetByKeyRequestBuilder<DocumentHeader>	getDocumentHeaderByKey(String cADocumentNumber) Fetch a single DocumentHeader entity using key fields.
GetByKeyRequestBuilder<GLItem>	getGLItemByKey(String cADocumentNumber, String cAGLItemNumber) Fetch a single GLItem entity using key fields.
GetByKeyRequestBuilder<GLItemPaytData>	getGLItemPaytDataByKey(String cADocumentNumber, String cAGLItemNumber) Fetch a single GLItemPaytData entity using key fields.
String	getServicePath() Getter for the OData service root path.
DefaultContractAccountingDocumentManageService	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

DefaultContractAccountingDocumentManageService

public DefaultContractAccountingDocumentManageService()

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

Method Detail

withServicePath

@Nonnull
public DefaultContractAccountingDocumentManageService withServicePath(@Nonnull
                                                                               String servicePath)

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

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.

getAllBPItemLogical

@Nonnull
public GetAllRequestBuilder<BPItemLogical> getAllBPItemLogical()

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple BPItemLogical entities.

Specified by:

getAllBPItemLogical in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch multiple BPItemLogical 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<BPItemLogical> countBPItemLogical()

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countBPItemLogical in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch the count of BPItemLogical 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<BPItemLogical> getBPItemLogicalByKey(@Nonnull
                                                                            String cADocumentNumber,
                                                                            @Nonnull
                                                                            String cARepetitionItemNumber,
                                                                            @Nonnull
                                                                            String cABPItemNumber,
                                                                            @Nonnull
                                                                            String cASubItemNumber)

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single BPItemLogical 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 BPItemLogical 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.

getAllBPItemPaytData

@Nonnull
public GetAllRequestBuilder<BPItemPaytData> getAllBPItemPaytData()

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple BPItemPaytData entities.

Specified by:

getAllBPItemPaytData in interface ContractAccountingDocumentManageService

Returns:

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

countBPItemPaytData

@Nonnull
public CountRequestBuilder<BPItemPaytData> countBPItemPaytData()

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countBPItemPaytData in interface ContractAccountingDocumentManageService

Returns:

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

getBPItemPaytDataByKey

@Nonnull
public GetByKeyRequestBuilder<BPItemPaytData> getBPItemPaytDataByKey(@Nonnull
                                                                              String cADocumentNumber,
                                                                              @Nonnull
                                                                              String cAGroupingForPayment)

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single BPItemPaytData entity using key fields.

Specified by:

getBPItemPaytDataByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Number of a FI-CA Document

Constraints: Not nullable, Maximum length: 12

cAGroupingForPayment - Grouping field for automatic payments

Constraints: Not nullable, Maximum length: 10

Returns:

A request builder to fetch a single BPItemPaytData 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<DocumentHeader> getAllDocumentHeader()

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple DocumentHeader entities.

Specified by:

getAllDocumentHeader in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch multiple DocumentHeader 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<DocumentHeader> countDocumentHeader()

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countDocumentHeader in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch the count of DocumentHeader 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<DocumentHeader> getDocumentHeaderByKey(@Nonnull
                                                                              String cADocumentNumber)

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single DocumentHeader entity using key fields.

Specified by:

getDocumentHeaderByKey in interface ContractAccountingDocumentManageService

Parameters:

cADocumentNumber - Document

Constraints: Not nullable, Maximum length: 12

Returns:

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

getAllGLItem

@Nonnull
public GetAllRequestBuilder<GLItem> getAllGLItem()

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple GLItem entities.

Specified by:

getAllGLItem in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch multiple GLItem 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<GLItem> countGLItem()

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countGLItem in interface ContractAccountingDocumentManageService

Returns:

A request builder to fetch the count of GLItem 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<GLItem> getGLItemByKey(@Nonnull
                                                              String cADocumentNumber,
                                                              @Nonnull
                                                              String cAGLItemNumber)

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single GLItem 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 GLItem 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.

getAllGLItemPaytData

@Nonnull
public GetAllRequestBuilder<GLItemPaytData> getAllGLItemPaytData()

Description copied from interface: ContractAccountingDocumentManageService

Fetch multiple GLItemPaytData entities.

Specified by:

getAllGLItemPaytData in interface ContractAccountingDocumentManageService

Returns:

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

countGLItemPaytData

@Nonnull
public CountRequestBuilder<GLItemPaytData> countGLItemPaytData()

Description copied from interface: ContractAccountingDocumentManageService

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

Specified by:

countGLItemPaytData in interface ContractAccountingDocumentManageService

Returns:

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

getGLItemPaytDataByKey

@Nonnull
public GetByKeyRequestBuilder<GLItemPaytData> getGLItemPaytDataByKey(@Nonnull
                                                                              String cADocumentNumber,
                                                                              @Nonnull
                                                                              String cAGLItemNumber)

Description copied from interface: ContractAccountingDocumentManageService

Fetch a single GLItemPaytData entity using key fields.

Specified by:

getGLItemPaytDataByKey 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 GLItemPaytData 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()

Description copied from interface: ServiceWithNavigableEntities

Getter for the OData service root path.

Specified by:

getServicePath in interface ServiceWithNavigableEntities

Returns:

the service path.