com.sap.cloud.sdk.s4hana.datamodel.odata.helper

Class FluentHelperUpdate<FluentHelperT,EntityT extends VdmEntity<?>>

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,EntityT,com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperUpdate<FluentHelperT,EntityT>

Type Parameters:

FluentHelperT - The fluent helper type.

EntityT - The type of the entity to update.

Direct Known Subclasses:

AddressEmailAddressUpdateFluentHelper, AddressFaxNumberUpdateFluentHelper, AddressHomePageURLUpdateFluentHelper, AddressPhoneNumberUpdateFluentHelper, BillOfMaterialItemUpdateFluentHelper, BillOfMaterialUpdateFluentHelper, BPContactToFuncAndDeptUpdateFluentHelper, BuPaAddressUsageUpdateFluentHelper, BuPaIdentificationUpdateFluentHelper, BusinessPartnerAddressUpdateFluentHelper, BusinessPartnerBankUpdateFluentHelper, BusinessPartnerContactUpdateFluentHelper, BusinessPartnerRoleUpdateFluentHelper, BusinessPartnerTaxNumberUpdateFluentHelper, BusinessPartnerUpdateFluentHelper, CentralPurchaseContractUpdateFluentHelper, ChangeMasterAltDateUpdateFluentHelper, ChangeMasterObjTypeAssgmtUpdateFluentHelper, ChangeMasterUpdateFluentHelper, ChangeMstrObjectMgmtRecordUpdateFluentHelper, ChangeMstrObMgReDocInfoRecdUpdateFluentHelper, ChangeMstrObMgReMaterialUpdateFluentHelper, ChangeMstrObMgReMatlBOMUpdateFluentHelper, ClfnCharacteristicForKeyDateUpdateFluentHelper, ClfnCharcDescForKeyDateUpdateFluentHelper, ClfnCharcValueDescForKeyDateUpdateFluentHelper, ClfnCharcValueForKeyDateUpdateFluentHelper, ClfnClassCharcForKeyDateUpdateFluentHelper, ClfnClassDescForKeyDateUpdateFluentHelper, ClfnClassForKeyDateUpdateFluentHelper, ClfnClassKeywordForKeyDateUpdateFluentHelper, ClfnClassTextForKeyDateUpdateFluentHelper, CntrlPurchaseContractItemUpdateFluentHelper, CntrlPurContrItmDistributionUpdateFluentHelper, CreditMemoReqItemPartnerUpdateFluentHelper, CreditMemoReqItemPrcgElmntUpdateFluentHelper, CreditMemoReqPartnerUpdateFluentHelper, CreditMemoReqPrcgElmntUpdateFluentHelper, CreditMemoRequestItemUpdateFluentHelper, CreditMemoRequestUpdateFluentHelper, CustomerCompanyUpdateFluentHelper, CustomerDunningUpdateFluentHelper, CustomerReturnItemPartnerUpdateFluentHelper, CustomerReturnItemPrcgElmntUpdateFluentHelper, CustomerReturnItemUpdateFluentHelper, CustomerReturnPartnerUpdateFluentHelper, CustomerReturnPrcgElmntUpdateFluentHelper, CustomerReturnUpdateFluentHelper, CustomerSalesAreaTaxUpdateFluentHelper, CustomerSalesAreaUpdateFluentHelper, CustomerUpdateFluentHelper, CustomerWithHoldingTaxUpdateFluentHelper, CustSalesPartnerFuncUpdateFluentHelper, DebitMemoReqItemPartnerUpdateFluentHelper, DebitMemoReqItemPrcgElmntUpdateFluentHelper, DebitMemoReqPartnerUpdateFluentHelper, DebitMemoReqPrcgElmntUpdateFluentHelper, DebitMemoRequestItemUpdateFluentHelper, DebitMemoRequestUpdateFluentHelper, DefectUpdateFluentHelper, DemandUpdateFluentHelper, DocInfoRecdObjLinkProductUpdateFluentHelper, DocumentInfoRecordDescUpdateFluentHelper, DocumentInfoRecordUpdateFluentHelper, EnterpriseProjectUpdateFluentHelper, InbDeliveryDocFlowUpdateFluentHelper, InbDeliveryHeaderUpdateFluentHelper, InbDeliveryItemUpdateFluentHelper, InspectionResultUpdateFluentHelper, LegalTransactionUpdateFluentHelper, LglTransDateUpdateFluentHelper, LglTransEntityUpdateFluentHelper, LglTransExternalContactUpdateFluentHelper, LglTransInternalContactUpdateFluentHelper, LglTransLinkedObjectsUpdateFluentHelper, LglTransRelationshipUpdateFluentHelper, MaintainYearsPeriodUpdateFluentHelper, OutbDeliveryDocFlowUpdateFluentHelper, OutbDeliveryHeaderUpdateFluentHelper, OutbDeliveryItemUpdateFluentHelper, PhysInventoryDocItemUpdateFluentHelper, PlannedIndepRqmtItemUpdateFluentHelper, PlannedIndepRqmtUpdateFluentHelper, PlannedOrderUpdateFluentHelper, ProdAllocCharcValCombnUpdateFluentHelper, ProdAllocObjTimeSeriesUpdateFluentHelper, ProdAllocSqncAssgmtUpdateFluentHelper, ProductBasicTextUpdateFluentHelper, ProductDescriptionUpdateFluentHelper, ProductInspectionTextUpdateFluentHelper, ProductPlantCostingUpdateFluentHelper, ProductPlantForecastingUpdateFluentHelper, ProductPlantIntlTrdUpdateFluentHelper, ProductPlantMRPAreaUpdateFluentHelper, ProductPlantProcurementUpdateFluentHelper, ProductPlantQualityMgmtUpdateFluentHelper, ProductPlantSalesUpdateFluentHelper, ProductPlantStorageUpdateFluentHelper, ProductPlantTextUpdateFluentHelper, ProductPlantUpdateFluentHelper, ProductProcurementUpdateFluentHelper, ProductPurchaseTextUpdateFluentHelper, ProductQualityMgmtUpdateFluentHelper, ProductSalesDeliveryUpdateFluentHelper, ProductSalesTaxUpdateFluentHelper, ProductSalesTextUpdateFluentHelper, ProductSalesUpdateFluentHelper, ProductStorageLocationUpdateFluentHelper, ProductStorageUpdateFluentHelper, ProductSupplyPlanningUpdateFluentHelper, ProductUnitsOfMeasureEANUpdateFluentHelper, ProductUnitsOfMeasureUpdateFluentHelper, ProductUpdateFluentHelper, ProductWorkSchedulingUpdateFluentHelper, ProjectUpdateFluentHelper, PurchaseContractItemUpdateFluentHelper, PurchaseContractUpdateFluentHelper, PurchaseOrderItemUpdateFluentHelper, PurchaseOrderScheduleLineUpdateFluentHelper, PurchaseOrderUpdateFluentHelper, PurchaseRequisitionHeaderUpdateFluentHelper, PurchaseRequisitionItemUpdateFluentHelper, PurchasingQuotaArrangementUpdateFluentHelper, PurchasingSourceUpdateFluentHelper, PurCtrAccountUpdateFluentHelper, PurCtrAddressUpdateFluentHelper, PurCtrPartnersUpdateFluentHelper, PurgCatDescriptionUpdateFluentHelper, PurgCatMaterialGroupUpdateFluentHelper, PurgCatMemberUpdateFluentHelper, PurgCatPlannedSpendUpdateFluentHelper, PurgCatPurchaserResponsibleUpdateFluentHelper, PurgCatSupplierUpdateFluentHelper, PurgCatTranslationStatusUpdateFluentHelper, PurgCatUpdateFluentHelper, PurgQuotaArrangementItemUpdateFluentHelper, PurOrdAccountAssignmentUpdateFluentHelper, PurOrdPricingElementUpdateFluentHelper, PurReqAddDeliveryUpdateFluentHelper, PurReqnAcctAssgmtUpdateFluentHelper, RecipeCharcValueUpdateFluentHelper, RecipeFormulaItemUpdateFluentHelper, RecipeProcessElementTextUpdateFluentHelper, RecipeProcessElementUpdateFluentHelper, RecipeProcessEquipRqmtTextUpdateFluentHelper, RecipeProcessEquipRqmtUpdateFluentHelper, RecipeProcessParamValueTxtUpdateFluentHelper, RecipeProcessParamValueUpdateFluentHelper, RecipeTextUpdateFluentHelper, RecipeUpdateFluentHelper, RequestForQuotationBidderUpdateFluentHelper, RequestForQuotationItemUpdateFluentHelper, RequestForQuotationUpdateFluentHelper, ReturnsDeliveryDocFlowUpdateFluentHelper, ReturnsDeliveryHeaderUpdateFluentHelper, ReturnsDeliveryItemUpdateFluentHelper, SalesContractItemPartnerUpdateFluentHelper, SalesContractItemPrcgElmntUpdateFluentHelper, SalesContractItemUpdateFluentHelper, SalesContractPartnerUpdateFluentHelper, SalesContractPrcgElmntUpdateFluentHelper, SalesContractUpdateFluentHelper, SalesOrderHeaderPartnerUpdateFluentHelper, SalesOrderHeaderPrElementUpdateFluentHelper, SalesOrderItemPartnerUpdateFluentHelper, SalesOrderItemPrElementUpdateFluentHelper, SalesOrderItemUpdateFluentHelper, SalesOrderUpdateFluentHelper, SalesOrderWithoutChargeItemUpdateFluentHelper, SalesOrderWithoutChargeUpdateFluentHelper, SalesQuotationItemPartnerUpdateFluentHelper, SalesQuotationItemPrcgElmntUpdateFluentHelper, SalesQuotationItemUpdateFluentHelper, SalesQuotationPartnerUpdateFluentHelper, SalesQuotationPrcgElmntUpdateFluentHelper, SalesQuotationUpdateFluentHelper, SchAgrmtAcCntUpdateFluentHelper, SchAgrmtHeaderUpdateFluentHelper, SchAgrmtItemUpdateFluentHelper, SchAgrmtPartnerUpdateFluentHelper, SchAgrmtSchLineUpdateFluentHelper, ServiceEntrySheetItemUpdateFluentHelper, ServiceEntrySheetUpdateFluentHelper, SlsOrdWthoutChrgItmPartnerUpdateFluentHelper, SlsOrdWthoutChrgPartnerUpdateFluentHelper, SrvcEntrShtAcctAssignmentUpdateFluentHelper, SubscriptionMaintainUpdateFluentHelper, SuplrActyDescriptionUpdateFluentHelper, SuplrActyParticipantUpdateFluentHelper, SuplrActyPurchaserRespUpdateFluentHelper, SuplrActySupplierUpdateFluentHelper, SuplrActyTskDescriptionUpdateFluentHelper, SuplrActyTskMessageTextUpdateFluentHelper, SuplrActyTskProcessorUpdateFluentHelper, SuplrActyTskPurchaserRespUpdateFluentHelper, SuplrActyTskSupplierUpdateFluentHelper, SupplierActivityTaskUpdateFluentHelper, SupplierActivityUpdateFluentHelper, SupplierCompanyUpdateFluentHelper, SupplierDunningUpdateFluentHelper, SupplierPartnerFuncUpdateFluentHelper, SupplierPurchasingOrgUpdateFluentHelper, SupplierQuotationItemUpdateFluentHelper, SupplierQuotationUpdateFluentHelper, SupplierUpdateFluentHelper, SupplierWithHoldingTaxUpdateFluentHelper, TimeOverviewUpdateFluentHelper, WorkCenterCapacityIntervalUpdateFluentHelper, WorkCenterCapacityShiftUpdateFluentHelper, WorkPackageUpdateFluentHelper

public abstract class FluentHelperUpdate<FluentHelperT,EntityT extends VdmEntity<?>>
extends FluentHelperBasic<FluentHelperT,EntityT,com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult>

Representation of an OData update request as a fluent interface for further configuring the request and executing it.

Constructor Summary

Constructors

Constructor and Description
FluentHelperUpdate(String servicePath) Instantiates this fluent helper using the given service path to send the requests.

Method Summary

Modifier and Type	Method and Description
com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult	execute(ErpConfigContext configContext) Executes the underlying update request.
protected abstract EntityT	getEntity() The entity object to be updated by calling the execute(ErpConfigContext) method.
protected Class<? extends EntityT>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateRequestBuilder	getQueryBuilder() Creates an instance of the ODataUpdateRequestBuilder based on the Entity class.
FluentHelperT	ignoreVersionIdentifier() The update request will ignore the given version identifier and writes the contained changes, regardless of any changes on the remote entity.
FluentHelperT	ignoringVersionIdentifier(boolean ignore) You can specify whether the given version identifier shall be ignored and, as a consequence, the changes to the remote entity shall be written in any case regardless of any previous changes on the remote entity.
FluentHelperT	includingFields(EntityField<EntityT,?>... fields) Allows to explicitly specify entity fields that shall be sent in an update request regardless if the values of these fields have been changed.
com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateRequest	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.

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperBasic

asResilientCommand, asResilientCommand, execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getServicePath, getThis, getVersionIdentifier, withCustomHttpHeader, withCustomHttpHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentHelperUpdate

public FluentHelperUpdate(@Nonnull
                          String servicePath)

Instantiates this fluent helper using the given service path to send the requests.

Parameters:

servicePath - The service path to direct the requests to.

Method Detail

getEntity

protected abstract EntityT getEntity()

The entity object to be updated by calling the execute(ErpConfigContext) method.

Returns:

The entity to be updated.

getEntityClass

@Nonnull
protected Class<? extends EntityT> getEntityClass()

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult>

Returns:

A class object of the handled type.

getQueryBuilder

@Nonnull
protected com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateRequestBuilder getQueryBuilder()

Creates an instance of the ODataUpdateRequestBuilder based on the Entity class.

The following settings are necessary to build the ODataQueryBuilder:

• the endpoint URL
• the entity collection name
• the key fields of the entity
• the version identifier
• the fields to be updated
• the fields to be sent, even if not updated

Returns:

An initialized ODataQueryBuilder.

toQuery

@Nonnull
public com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateRequest toQuery()
                                                                           throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - if the ODataUpdateRequestBuilder could not be initialized.

withErrorHandler

@Nonnull
public FluentHelperT withErrorHandler(@Nonnull
                                               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.

ignoringVersionIdentifier

@Nonnull
public FluentHelperT ignoringVersionIdentifier(boolean ignore)

You can specify whether the given version identifier shall be ignored and, as a consequence, the changes to the remote entity shall be written in any case regardless of any previous changes on the remote entity.

Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.

Parameters:

ignore - Boolean indicating whether the version identifier shall be ignored

Returns:

The same fluent helper that will ignore the given version identifier.

ignoreVersionIdentifier

@Nonnull
public FluentHelperT ignoreVersionIdentifier()

The update request will ignore the given version identifier and writes the contained changes, regardless of any changes on the remote entity.

Warning: Be careful with this option, as this might overwrite any changes made to the remote representation of this object.

Returns:

The same fluent helper that will ignore the given version identifier.

execute

@Nonnull
public com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult execute(@Nonnull
                                                                                 ErpConfigContext configContext)
                                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException,
                                                                                 VersionIdentifierMissingException,
                                                                                 VersionIdentifierExpiredException

Executes the underlying update request.

Specified by:

execute in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,com.sap.cloud.sdk.odatav2.connectivity.ODataUpdateResult>

Parameters:

configContext - upply the ERP system context for executing the underlying OData query.

Returns:

An object providing information about the execution of the request. If the underlying OData request fails, an ODataException is thrown.

Throws:

VersionIdentifierMissingException - if a version identifier was requested by the remote, but not provided.

VersionIdentifierExpiredException - if the provided version identifier is no longer valid. To recover from this request obtain a new version identifier from the remote and call execute the update again.

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

See Also:

ErpConfigContext.ErpConfigContext()

includingFields

@Nonnull
 @SafeVarargs
public final FluentHelperT includingFields(@Nonnull
                                                                  EntityField<EntityT,?>... fields)

Allows to explicitly specify entity fields that shall be sent in an update request regardless if the values of these fields have been changed. This is helpful in case the API requires to send certain fields in any case in an update request.

Parameters:

fields - The fields to be included in the update execution.

Returns:

The same fluent helper which will include the specified fields in an update request.