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

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

java.lang.Object

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

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

Type Parameters:

FluentHelperT - The fluent helper type.

EntityT - The type of the entity to delete.

Direct Known Subclasses:

AddressEmailAddressDeleteFluentHelper, AddressFaxNumberDeleteFluentHelper, AddressHomePageURLDeleteFluentHelper, AddressPhoneNumberDeleteFluentHelper, AttachmentContentDeleteFluentHelper, BillingDocumentRequestDeleteFluentHelper, BuPaAddressUsageDeleteFluentHelper, BuPaIdentificationDeleteFluentHelper, BusinessPartnerAddressDeleteFluentHelper, BusinessPartnerBankDeleteFluentHelper, BusinessPartnerContactDeleteFluentHelper, BusinessPartnerTaxNumberDeleteFluentHelper, ChangeMasterAltDateDeleteFluentHelper, ChangeMasterDeleteFluentHelper, ChangeMasterObjTypeAssgmtDeleteFluentHelper, ChangeMstrObjectMgmtRecordDeleteFluentHelper, ChangeMstrObMgReDocInfoRecdDeleteFluentHelper, ChangeMstrObMgReMaterialDeleteFluentHelper, ChangeMstrObMgReMatlBOMDeleteFluentHelper, ClfnCharacteristicForKeyDateDeleteFluentHelper, ClfnCharcDescForKeyDateDeleteFluentHelper, ClfnCharcRstrcnForKeyDateDeleteFluentHelper, ClfnCharcValueDescForKeyDateDeleteFluentHelper, ClfnCharcValueForKeyDateDeleteFluentHelper, ClfnClassCharcForKeyDateDeleteFluentHelper, ClfnClassDescForKeyDateDeleteFluentHelper, ClfnClassForKeyDateDeleteFluentHelper, ClfnClassKeywordForKeyDateDeleteFluentHelper, ClfnClassTextForKeyDateDeleteFluentHelper, CreditMemoReqItemPartnerDeleteFluentHelper, CreditMemoReqItemPrcgElmntDeleteFluentHelper, CreditMemoReqPartnerDeleteFluentHelper, CreditMemoReqPrcgElmntDeleteFluentHelper, CreditMemoRequestDeleteFluentHelper, CreditMemoRequestItemDeleteFluentHelper, CustomerDunningDeleteFluentHelper, CustomerReturnDeleteFluentHelper, CustomerReturnItemDeleteFluentHelper, CustomerReturnItemPartnerDeleteFluentHelper, CustomerReturnItemPrcgElmntDeleteFluentHelper, CustomerReturnPartnerDeleteFluentHelper, CustomerReturnPrcgElmntDeleteFluentHelper, CustomerWithHoldingTaxDeleteFluentHelper, CustSalesPartnerFuncDeleteFluentHelper, DebitMemoReqItemPartnerDeleteFluentHelper, DebitMemoReqItemPrcgElmntDeleteFluentHelper, DebitMemoReqPartnerDeleteFluentHelper, DebitMemoReqPrcgElmntDeleteFluentHelper, DebitMemoRequestDeleteFluentHelper, DebitMemoRequestItemDeleteFluentHelper, DefectDeleteFluentHelper, DemandDeleteFluentHelper, DocInfoRecdObjLinkProductDeleteFluentHelper, DocumentInfoRecordDeleteFluentHelper, DocumentInfoRecordDescDeleteFluentHelper, EnterpriseProjectDeleteFluentHelper, InbDeliveryHeaderDeleteFluentHelper, InbDeliveryItemDeleteFluentHelper, LglTransDateDeleteFluentHelper, LglTransEntityDeleteFluentHelper, LglTransExternalContactDeleteFluentHelper, LglTransInternalContactDeleteFluentHelper, LglTransLinkedObjectsDeleteFluentHelper, LglTransRelationshipDeleteFluentHelper, OutbDeliveryHeaderDeleteFluentHelper, OutbDeliveryItemDeleteFluentHelper, PlannedOrderDeleteFluentHelper, ProductBasicTextDeleteFluentHelper, ProductDescriptionDeleteFluentHelper, ProductInspectionTextDeleteFluentHelper, ProductPlantTextDeleteFluentHelper, ProductPurchaseTextDeleteFluentHelper, ProductSalesTaxDeleteFluentHelper, ProductSalesTextDeleteFluentHelper, ProductUnitsOfMeasureDeleteFluentHelper, ProductUnitsOfMeasureEANDeleteFluentHelper, PurchaseContractDeleteFluentHelper, PurchaseContractItemDeleteFluentHelper, PurchaseOrderDeleteFluentHelper, PurchaseOrderItemDeleteFluentHelper, PurchaseOrderScheduleLineDeleteFluentHelper, PurchaseRequisitionHeaderDeleteFluentHelper, PurchaseRequisitionItemDeleteFluentHelper, PurchasingQuotaArrangementDeleteFluentHelper, PurchasingSourceDeleteFluentHelper, PurCtrAccountDeleteFluentHelper, PurCtrAddressDeleteFluentHelper, PurCtrPartnersDeleteFluentHelper, PurgCatMaterialGroupDeleteFluentHelper, PurgCatMemberDeleteFluentHelper, PurgCatPlannedSpendDeleteFluentHelper, PurgCatSupplierDeleteFluentHelper, PurgCatTranslationStatusDeleteFluentHelper, PurgQuotaArrangementItemDeleteFluentHelper, PurOrdAccountAssignmentDeleteFluentHelper, PurOrdPricingElementDeleteFluentHelper, PurReqAddDeliveryDeleteFluentHelper, PurReqnAcctAssgmtDeleteFluentHelper, RecipeCharcValueDeleteFluentHelper, RecipeClassDeleteFluentHelper, RecipeDeleteFluentHelper, RecipeFormulaItemDeleteFluentHelper, RecipeProcessElementDeleteFluentHelper, RecipeProcessElementTextDeleteFluentHelper, RecipeProcessEquipRqmtDeleteFluentHelper, RecipeProcessEquipRqmtTextDeleteFluentHelper, RecipeProcessParamValueDeleteFluentHelper, RecipeProcessParamValueTxtDeleteFluentHelper, RecipeTextDeleteFluentHelper, RequestForQuotationBidderDeleteFluentHelper, RequestForQuotationDeleteFluentHelper, RequestForQuotationItemDeleteFluentHelper, ReservationDocumentHeaderDeleteFluentHelper, ReturnsDeliveryHeaderDeleteFluentHelper, ReturnsDeliveryItemDeleteFluentHelper, SalesContractDeleteFluentHelper, SalesContractItemDeleteFluentHelper, SalesContractItemPartnerDeleteFluentHelper, SalesContractItemPrcgElmntDeleteFluentHelper, SalesContractPartnerDeleteFluentHelper, SalesContractPrcgElmntDeleteFluentHelper, SalesOrderDeleteFluentHelper, SalesOrderHeaderPartnerDeleteFluentHelper, SalesOrderHeaderPrElementDeleteFluentHelper, SalesOrderItemDeleteFluentHelper, SalesOrderItemPartnerDeleteFluentHelper, SalesOrderItemPrElementDeleteFluentHelper, SalesOrderWithoutChargeDeleteFluentHelper, SalesOrderWithoutChargeItemDeleteFluentHelper, SalesQuotationDeleteFluentHelper, SalesQuotationItemDeleteFluentHelper, SalesQuotationItemPartnerDeleteFluentHelper, SalesQuotationItemPrcgElmntDeleteFluentHelper, SalesQuotationPartnerDeleteFluentHelper, SalesQuotationPrcgElmntDeleteFluentHelper, SchAgrmtAcCntDeleteFluentHelper, SchAgrmtHeaderDeleteFluentHelper, SchAgrmtItemDeleteFluentHelper, SchAgrmtPartnerDeleteFluentHelper, SchAgrmtSchLineDeleteFluentHelper, SkillTagDeleteFluentHelper, SlsOrdWthoutChrgItmPartnerDeleteFluentHelper, SlsOrdWthoutChrgPartnerDeleteFluentHelper, SuplrActyParticipantDeleteFluentHelper, SuplrActySupplierDeleteFluentHelper, SuplrActyTskDescriptionDeleteFluentHelper, SuplrActyTskSupplierDeleteFluentHelper, SupplierActivityDeleteFluentHelper, SupplierDunningDeleteFluentHelper, SupplierPartnerFuncDeleteFluentHelper, SupplierQuotationDeleteFluentHelper, SupplierWithHoldingTaxDeleteFluentHelper, TimeOverviewDeleteFluentHelper, WorkItemDeleteFluentHelper, WorkPackageDeleteFluentHelper

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

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

Constructor Summary

Constructors

Constructor and Description
FluentHelperDelete(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.ODataDeleteResult	execute(ErpConfigContext configContext) Executes the underlying delete request.
protected abstract EntityT	getEntity() The entity object to be deleted 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.ODataDeleteRequestBuilder	getQueryBuilder() Creates an instance of the ODataDeleteRequestBuilder based on the Entity class.
FluentHelperT	ignoreVersionIdentifier() The delete request will ignore the given version identifier and deletes the entity, 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 deletion of the remote entity shall be executed in any case regardless of any previous changes on the remote entity.
com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest	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

FluentHelperDelete

public FluentHelperDelete(@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

@Nonnull
protected abstract EntityT getEntity()

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

Returns:

The entity to be deleted.

getEntityClass

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

Description copied from class: FluentHelperBasic

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.ODataDeleteResult>

Returns:

A class object of the handled type.

getQueryBuilder

@Nonnull
protected com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequestBuilder getQueryBuilder()
                                                                                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

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

The following settings are necessary to build the ODataDeleteRequestBuilder:

• the endpoint URL
• the entity collection name
• the key fields of the entity

Returns:

An initialized ODataDeleteRequestBuilder.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - if the key values of the entity could not be converted to the OData key values.

toQuery

@Nonnull
public com.sap.cloud.sdk.odatav2.connectivity.ODataDeleteRequest 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 ODataDeleteRequest 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 deletion of the remote entity shall be executed 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 delete request will ignore the given version identifier and deletes the entity, 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.ODataDeleteResult execute(@Nonnull
                                                                                 ErpConfigContext configContext)
                                                                          throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying delete request.

Specified by:

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

Parameters:

configContext - Supply 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:

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

See Also:

ErpConfigContext.ErpConfigContext()