public abstract class FluentHelperByKey<FluentHelperT,EntityT extends VdmEntity<?>,SelectableT> extends FluentHelperBasic<FluentHelperT,EntityT,EntityT>
Constructor and Description |
---|
FluentHelperByKey() |
Modifier and Type | Method and Description |
---|---|
EntityT |
execute(ErpConfigContext configContext)
Executes the underlying query using the stored key field values, plus any query modifiers that were previously
called.
|
protected abstract Map<String,Object> |
getKey()
Getter for a map containing the OData name of key properties, each mapped to the value to search by.
|
protected com.sap.cloud.sdk.odatav2.connectivity.ODataQueryBuilder |
getQueryBuilder()
Creates an instance of the
ODataQueryBuilder based on the Entity class. |
FluentHelperT |
select(SelectableT... fields)
Query modifier to limit which field values of the 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.
|
FluentHelperT |
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. |
execute, getEntityClass, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getThis, getVersionIdentifier, withCustomHttpHeader, withCustomHttpHeaders, withHttpHeader
@Nonnull protected abstract Map<String,Object> getKey()
@Nonnull protected com.sap.cloud.sdk.odatav2.connectivity.ODataQueryBuilder getQueryBuilder() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
ODataQueryBuilder
based on the Entity class.
The following settings are necessary to build the ODataQueryBuilder
:
ODataQueryBuilder
.com.sap.cloud.sdk.odatav2.connectivity.ODataException
- if the key values of the entity could not be converted to the OData key values.@Nonnull public FluentHelperT select(@Nonnull SelectableT... fields)
fields
- Array of fields to select.@Nonnull public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
com.sap.cloud.sdk.odatav2.connectivity.ODataException
- if the ODataQueryBuilder
could not be initialized.@Nonnull public FluentHelperT withErrorHandler(@Nonnull com.sap.cloud.sdk.odatav2.connectivity.ErrorResultHandler<?> errorResultHandler)
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.errorResultHandler
- Instance of an error handler class that implements the ErrorResultHandler
interface.@Nonnull public EntityT execute(@Nonnull ErpConfigContext configContext) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
execute
in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,EntityT extends VdmEntity<?>>
configContext
- Supply the ERP system context for executing the underlying OData query.com.sap.cloud.sdk.odatav2.connectivity.ODataException
ErpConfigContext.ErpConfigContext()
Copyright © 2018 SAP SE. All rights reserved.