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

Class DefaultSettlementProcessTypeService

java.lang.Object

com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.DefaultSettlementProcessTypeService

All Implemented Interfaces:

ServiceWithNavigableEntities, SettlementProcessTypeService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odatav4.services.DefaultSettlementProcessTypeService")
public class DefaultSettlementProcessTypeService
extends Object
implements ServiceWithNavigableEntities, SettlementProcessTypeService

You retrieve the following data using this OData based service: You can read the Settlement Process Types and related information. You can navigate to the Application Status Assignment for a Settlement Process Type and read the assigned Application Status Group and all the possible Application Statuses linked to it. You can navigate to the Settlement Document Type Assignment for a Settlement Process Type and read the assigned Settlement Document Types for the relevant Settlement Process Type. You can also read further information regarding the Settlement Document Types. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_SETTLMT_PROC_TYPE_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Settlement Process Type

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.onpremise.v2020.datamodel.odatav4.services.SettlementProcessTypeService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultSettlementProcessTypeService() Creates a service using SettlementProcessTypeService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder	batch() Creates a batch request builder object.
CountRequestBuilder<SettlmtApplStsGrpStsAssgmt>	countSettlmtApplStsGrpStsAssgmt() Fetch the number of entries from the SettlmtApplStsGrpStsAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocProcTypeAssgmt>	countSettlmtDocProcTypeAssgmt() Fetch the number of entries from the SettlmtDocProcTypeAssgmt entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtDocType>	countSettlmtDocType() Fetch the number of entries from the SettlmtDocType entity collection matching the filter and search expressions.
CountRequestBuilder<SettlmtProcessType>	countSettlmtProcessType() Fetch the number of entries from the SettlmtProcessType entity collection matching the filter and search expressions.
GetAllRequestBuilder<SettlmtApplStsGrpStsAssgmt>	getAllSettlmtApplStsGrpStsAssgmt() Fetch multiple SettlmtApplStsGrpStsAssgmt entities.
GetAllRequestBuilder<SettlmtDocProcTypeAssgmt>	getAllSettlmtDocProcTypeAssgmt() Fetch multiple SettlmtDocProcTypeAssgmt entities.
GetAllRequestBuilder<SettlmtDocType>	getAllSettlmtDocType() Fetch multiple SettlmtDocType entities.
GetAllRequestBuilder<SettlmtProcessType>	getAllSettlmtProcessType() Fetch multiple SettlmtProcessType entities.
String	getServicePath() Getter for the OData service root path.
GetByKeyRequestBuilder<SettlmtApplStsGrpStsAssgmt>	getSettlmtApplStsGrpStsAssgmtByKey(String settlmtApplStsGrp, String settlmtApplSts) Fetch a single SettlmtApplStsGrpStsAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocProcTypeAssgmt>	getSettlmtDocProcTypeAssgmtByKey(String settlmtProcessType, String settlmtDocType) Fetch a single SettlmtDocProcTypeAssgmt entity using key fields.
GetByKeyRequestBuilder<SettlmtDocType>	getSettlmtDocTypeByKey(String settlmtDocType) Fetch a single SettlmtDocType entity using key fields.
GetByKeyRequestBuilder<SettlmtProcessType>	getSettlmtProcessTypeByKey(String settlmtProcessType) Fetch a single SettlmtProcessType entity using key fields.
DefaultSettlementProcessTypeService	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

DefaultSettlementProcessTypeService

public DefaultSettlementProcessTypeService()

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

Method Detail

withServicePath

@Nonnull
public DefaultSettlementProcessTypeService withServicePath(@Nonnull
                                                                    String servicePath)

Description copied from interface: SettlementProcessTypeService

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 SettlementProcessTypeService

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

Creates a batch request builder object.

Specified by:

batch in interface SettlementProcessTypeService

Returns:

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

getAllSettlmtApplStsGrpStsAssgmt

@Nonnull
public GetAllRequestBuilder<SettlmtApplStsGrpStsAssgmt> getAllSettlmtApplStsGrpStsAssgmt()

Description copied from interface: SettlementProcessTypeService

Fetch multiple SettlmtApplStsGrpStsAssgmt entities.

Specified by:

getAllSettlmtApplStsGrpStsAssgmt in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch multiple SettlmtApplStsGrpStsAssgmt 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 request builder object.

countSettlmtApplStsGrpStsAssgmt

@Nonnull
public CountRequestBuilder<SettlmtApplStsGrpStsAssgmt> countSettlmtApplStsGrpStsAssgmt()

Description copied from interface: SettlementProcessTypeService

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

Specified by:

countSettlmtApplStsGrpStsAssgmt in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch the count of SettlmtApplStsGrpStsAssgmt 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 request builder object.

getSettlmtApplStsGrpStsAssgmtByKey

@Nonnull
public GetByKeyRequestBuilder<SettlmtApplStsGrpStsAssgmt> getSettlmtApplStsGrpStsAssgmtByKey(@Nonnull
                                                                                                      String settlmtApplStsGrp,
                                                                                                      @Nonnull
                                                                                                      String settlmtApplSts)

Description copied from interface: SettlementProcessTypeService

Fetch a single SettlmtApplStsGrpStsAssgmt entity using key fields.

Specified by:

getSettlmtApplStsGrpStsAssgmtByKey in interface SettlementProcessTypeService

Parameters:

settlmtApplStsGrp - Status Group for Settlement Management Documents

Constraints: Not nullable, Maximum length: 4

settlmtApplSts - Application Status for a Settlement Management Document

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SettlmtApplStsGrpStsAssgmt 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 request builder object.

getAllSettlmtDocProcTypeAssgmt

@Nonnull
public GetAllRequestBuilder<SettlmtDocProcTypeAssgmt> getAllSettlmtDocProcTypeAssgmt()

Description copied from interface: SettlementProcessTypeService

Fetch multiple SettlmtDocProcTypeAssgmt entities.

Specified by:

getAllSettlmtDocProcTypeAssgmt in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch multiple SettlmtDocProcTypeAssgmt 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 request builder object.

countSettlmtDocProcTypeAssgmt

@Nonnull
public CountRequestBuilder<SettlmtDocProcTypeAssgmt> countSettlmtDocProcTypeAssgmt()

Description copied from interface: SettlementProcessTypeService

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

Specified by:

countSettlmtDocProcTypeAssgmt in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch the count of SettlmtDocProcTypeAssgmt 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 request builder object.

getSettlmtDocProcTypeAssgmtByKey

@Nonnull
public GetByKeyRequestBuilder<SettlmtDocProcTypeAssgmt> getSettlmtDocProcTypeAssgmtByKey(@Nonnull
                                                                                                  String settlmtProcessType,
                                                                                                  @Nonnull
                                                                                                  String settlmtDocType)

Description copied from interface: SettlementProcessTypeService

Fetch a single SettlmtDocProcTypeAssgmt entity using key fields.

Specified by:

getSettlmtDocProcTypeAssgmtByKey in interface SettlementProcessTypeService

Parameters:

settlmtProcessType - Settlement Process Type

Constraints: Not nullable, Maximum length: 4

settlmtDocType - Settlement Document Type

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SettlmtDocProcTypeAssgmt 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 request builder object.

getAllSettlmtDocType

@Nonnull
public GetAllRequestBuilder<SettlmtDocType> getAllSettlmtDocType()

Description copied from interface: SettlementProcessTypeService

Fetch multiple SettlmtDocType entities.

Specified by:

getAllSettlmtDocType in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch multiple SettlmtDocType 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 request builder object.

countSettlmtDocType

@Nonnull
public CountRequestBuilder<SettlmtDocType> countSettlmtDocType()

Description copied from interface: SettlementProcessTypeService

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

Specified by:

countSettlmtDocType in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch the count of SettlmtDocType 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 request builder object.

getSettlmtDocTypeByKey

@Nonnull
public GetByKeyRequestBuilder<SettlmtDocType> getSettlmtDocTypeByKey(@Nonnull
                                                                              String settlmtDocType)

Description copied from interface: SettlementProcessTypeService

Fetch a single SettlmtDocType entity using key fields.

Specified by:

getSettlmtDocTypeByKey in interface SettlementProcessTypeService

Parameters:

settlmtDocType - Settlement Document Type

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SettlmtDocType 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 request builder object.

getAllSettlmtProcessType

@Nonnull
public GetAllRequestBuilder<SettlmtProcessType> getAllSettlmtProcessType()

Description copied from interface: SettlementProcessTypeService

Fetch multiple SettlmtProcessType entities.

Specified by:

getAllSettlmtProcessType in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch multiple SettlmtProcessType 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 request builder object.

countSettlmtProcessType

@Nonnull
public CountRequestBuilder<SettlmtProcessType> countSettlmtProcessType()

Description copied from interface: SettlementProcessTypeService

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

Specified by:

countSettlmtProcessType in interface SettlementProcessTypeService

Returns:

A fluent helper to fetch the count of SettlmtProcessType 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 request builder object.

getSettlmtProcessTypeByKey

@Nonnull
public GetByKeyRequestBuilder<SettlmtProcessType> getSettlmtProcessTypeByKey(@Nonnull
                                                                                      String settlmtProcessType)

Description copied from interface: SettlementProcessTypeService

Fetch a single SettlmtProcessType entity using key fields.

Specified by:

getSettlmtProcessTypeByKey in interface SettlementProcessTypeService

Parameters:

settlmtProcessType - Settlement Process Type

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single SettlmtProcessType 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 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.