com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readbillingdocuments

Class BillingDocumentItemByKeyFluentHelper

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.readbillingdocuments.BillingDocumentItemByKeyFluentHelper

public class BillingDocumentItemByKeyFluentHelper
extends Object

Fluent helper to fetch a single BillingDocumentItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.

Constructor Summary

Constructors

Constructor and Description
BillingDocumentItemByKeyFluentHelper(String billingDocument, String billingDocumentItem) Creates a fluent helper object that will fetch a single BillingDocumentItem entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
BillingDocumentItem	execute() Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
BillingDocumentItem	execute(ErpConfigContext erpConfigContext) Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
BillingDocumentItem	execute(ErpEndpoint erpEndpoint) Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
BillingDocumentItemByKeyFluentHelper	select(EntityField<BillingDocumentItem,?>... fields) Query modifier to limit which field values within an entity get fetched & populated.
com.sap.cloud.sdk.odatav2.connectivity.ODataQuery	toQuery() Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.
BillingDocumentItemByKeyFluentHelper	withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler) An error handling class that implements the ErrorResultHandler interface can be attached to this fluent helper.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BillingDocumentItemByKeyFluentHelper

public BillingDocumentItemByKeyFluentHelper(String billingDocument,
                                            String billingDocumentItem)

Creates a fluent helper object that will fetch a single BillingDocumentItem entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

billingDocumentItem - The number that uniquely identifies the item in the billing document.

Constraints: Not nullable, Maximum length: 6

billingDocument - The number that uniquely identifies the billing document (the invoice, for example).

Constraints: Not nullable, Maximum length: 10

Method Detail

select

@SafeVarargs
public final BillingDocumentItemByKeyFluentHelper select(EntityField<BillingDocumentItem,?>... fields)

Query modifier to limit which field values within an entity get fetched & populated. If this method is never called, then all fields will be fetched & populated. But if this method is called at least once, then only the specified fields will be fetched & populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Fields to fetch & populate. See BillingDocumentItem for available fields.

Returns:

The same fluent helper with this query modifier applied.

toQuery

public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery()

Provides access to the underlying Query object, to allow for custom integration scenarios not yet supported by the virtual data model.

Returns:

The underlying query object.

withErrorHandler

public BillingDocumentItemByKeyFluentHelper withErrorHandler(com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)

An error handling class that implements the ErrorResultHandler interface can be attached to this fluent helper. This allows custom logic to be called when an error occurs in the execute method. If this method is not called, then an instance of ODataVdmErrorResultHandler is used. Only one handler can be attached at a time per fluent helper object, so calling this multiple times will replace the handler.

Parameters:

errorResultHandler - Instance of an error handler class that implements the ErrorResultHandler interface.

Returns:

The same fluent helper with its error handler set to the provided object.

execute

public BillingDocumentItem execute(ErpEndpoint erpEndpoint)
                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

Parameters:

erpEndpoint - Supply the ERP system instance for executing the underlying OData query.

Returns:

An BillingDocumentItem entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)

execute

public BillingDocumentItem execute(ErpConfigContext erpConfigContext)
                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

Parameters:

erpConfigContext - Supply the ERP system context for executing the underlying OData query.

Returns:

An BillingDocumentItem entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)

execute

public BillingDocumentItem execute()
                            throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

The default ERP configuration context will be used.

Returns:

An BillingDocumentItem entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)