public class MaterialDocumentHeaderByKeyFluentHelper extends Object
MaterialDocumentHeader
entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.Constructor and Description |
---|
MaterialDocumentHeaderByKeyFluentHelper(String materialDocumentYear,
String materialDocument)
Creates a fluent helper object that will fetch a single
MaterialDocumentHeader entity with the provided key field values. |
Modifier and Type | Method and Description |
---|---|
MaterialDocumentHeader |
execute()
Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
|
MaterialDocumentHeader |
execute(ErpConfigContext erpConfigContext)
Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
|
MaterialDocumentHeader |
execute(ErpEndpoint erpEndpoint)
Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
|
MaterialDocumentHeaderByKeyFluentHelper |
select(EntityField<MaterialDocumentHeader,?>... 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.
|
MaterialDocumentHeaderByKeyFluentHelper |
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. |
public MaterialDocumentHeaderByKeyFluentHelper(String materialDocumentYear, String materialDocument)
MaterialDocumentHeader
entity with the provided key field values. To perform execution, call the execute
method on the fluent helper object.materialDocument
- Alphanumeric key uniquely identifying the document.Constraints: Not nullable, Maximum length: 10
materialDocumentYear
- Material Document YearConstraints: Not nullable, Maximum length: 4
@SafeVarargs public final MaterialDocumentHeaderByKeyFluentHelper select(EntityField<MaterialDocumentHeader,?>... fields)
fields
- Fields to fetch & populate. See MaterialDocumentHeader
for available fields.public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery()
public MaterialDocumentHeaderByKeyFluentHelper withErrorHandler(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.public MaterialDocumentHeader execute(ErpEndpoint erpEndpoint) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
erpEndpoint
- Supply the ERP system instance for executing the underlying OData query.com.sap.cloud.sdk.odatav2.connectivity.ODataException
ErpConfigContext.ErpConfigContext()
,
ErpEndpoint.ErpEndpoint(ErpConfigContext)
public MaterialDocumentHeader execute(ErpConfigContext erpConfigContext) throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
erpConfigContext
- Supply the ERP system context for executing the underlying OData query.com.sap.cloud.sdk.odatav2.connectivity.ODataException
ErpConfigContext.ErpConfigContext()
,
ErpEndpoint.ErpEndpoint(ErpConfigContext)
public MaterialDocumentHeader execute() throws com.sap.cloud.sdk.odatav2.connectivity.ODataException
com.sap.cloud.sdk.odatav2.connectivity.ODataException
ErpConfigContext.ErpConfigContext()
,
ErpEndpoint.ErpEndpoint(ErpConfigContext)
Copyright © 2017 SAP SE. All rights reserved.