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

Class BatchFluentHelperBasic<FluentHelperBatchT extends FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>,FluentHelperBatchChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperBatchT>>

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchFluentHelperBasic<FluentHelperBatchT,FluentHelperBatchChangeSetT>

Type Parameters:

FluentHelperBatchT - The fluent helper type.

FluentHelperBatchChangeSetT - The type of the changesets being managed in this OData batch request.

All Implemented Interfaces:

FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>, FluentHelperServiceBatchExecute

Direct Known Subclasses:

DefaultAccountingDocumentServiceBatch, DefaultActivityTypeServiceBatch, DefaultAttachmentServiceBatch, DefaultBankDetailServiceBatch, DefaultBasicProductAvailabilityInformationServiceBatch, DefaultBatchServiceBatch, DefaultBillingDocumentRequestServiceBatch, DefaultBillingDocumentServiceBatch, DefaultBillOfMaterialComparisonServiceBatch, DefaultBillOfMaterialsServiceBatch, DefaultBillOfMaterialsV2ServiceBatch, DefaultBillsOfMaterialWhereUsedListServiceBatch, DefaultBrazilBusinessPlaceServiceBatch, DefaultBufferProfileServiceBatch, DefaultBufferSizingServiceBatch, DefaultBusinessAreaServiceBatch, DefaultBusinessEventQueueServiceBatch, DefaultBusinessEventSubscriptionServiceBatch, DefaultBusinessPartnerServiceBatch, DefaultBusinessSituationServiceBatch, DefaultCentralPurchaseContractServiceBatch, DefaultChangeMasterServiceBatch, DefaultChangeMasterV2ServiceBatch, DefaultChangeRecordServiceBatch, DefaultCharacteristicAttributeCatalogServiceBatch, DefaultCharacteristicDataForClassificationServiceBatch, DefaultChartOfAccountsServiceBatch, DefaultClassDataForClassificationServiceBatch, DefaultCommercialProjectDetailServiceBatch, DefaultCommercialProjectServiceBatch, DefaultCompanyCodeServiceBatch, DefaultConditionContractTypeServiceBatch, DefaultConditionTypeForPricingInPurchasingServiceBatch, DefaultConditionTypeForPricingInSalesServiceBatch, DefaultContractAccountingSEPAMandateServiceBatch, DefaultControllingAreaServiceBatch, DefaultCostCenterServiceBatch, DefaultCostCenterTestServiceBatch, DefaultCostRateServiceBatch, DefaultCountryServiceBatch, DefaultCreditMemoRequestServiceBatch, DefaultCustomerAndSupplierIndustryServiceBatch, DefaultCustomerGroupServiceBatch, DefaultCustomerMaterialServiceBatch, DefaultCustomerReturnsDeliveryServiceBatch, DefaultCustomerReturnsDeliveryV2ServiceBatch, DefaultCustomerReturnServiceBatch, DefaultDebitMemoRequestServiceBatch, DefaultDebitOrCreditIndicatorServiceBatch, DefaultDefectCategoryServiceBatch, DefaultDefectClassServiceBatch, DefaultDefectCodeAndCodeGroupServiceBatch, DefaultDefectProcessingServiceBatch, DefaultDeliveryDocumentWithCreditBlocksServiceBatch, DefaultDistributionChannelServiceBatch, DefaultDivisionServiceBatch, DefaultDocumentManagementServiceBatch, DefaultEHSIncidentCreateServiceBatch, DefaultEnterpriseProjectServiceBatch, DefaultEventBasedRevenueRecognitionIntegrationServiceBatch, DefaultExtendedPlannedIndependentRequirementServiceBatch, DefaultExternalJobSchedulerIntegrationServiceBatch, DefaultFinancialPlanningDataServiceBatch, DefaultFinancialPlanningEntryItemServiceBatch, DefaultFunctionalAreaServiceBatch, DefaultGeneralLedgerAccountServiceBatch, DefaultHandlingUnitServiceBatch, DefaultInboundDeliveryServiceBatch, DefaultInboundDeliveryV2ServiceBatch, DefaultIncomingVATInvoiceChinaServiceBatch, DefaultInspectionMethodServiceBatch, DefaultInspectionPlanServiceBatch, DefaultJournalEntryItemServiceBatch, DefaultJustInTimeCallServiceBatch, DefaultKanbanControlCycleV2ServiceBatch, DefaultLedgerServiceBatch, DefaultLegalCategorieServiceBatch, DefaultLegalDocumentAccessLevelServiceBatch, DefaultLegalDocumentContentTypeServiceBatch, DefaultLegalDocumentServiceBatch, DefaultLegalTransactionServiceBatch, DefaultLineItemOfTreasuryPostingJournalEntryServiceBatch, DefaultMasterDataForGroupReportingServiceBatch, DefaultMasterInspectionCharacteristicServiceBatch, DefaultMasterRecipeServiceBatch, DefaultMaterialDocumentServiceBatch, DefaultMaterialPlanningDataServiceBatch, DefaultMaterialPriceServiceBatch, DefaultMaterialStockDisplayServiceBatch, DefaultOutboundDeliveryServiceBatch, DefaultOutboundDeliveryV2ServiceBatch, DefaultPaymentAdviceServiceBatch, DefaultPersonnelSettlementDocumentServiceBatch, DefaultPhaseRelationshipTypeServiceBatch, DefaultPhysicalInventoryDocumentServiceBatch, DefaultPlannedIndependentRequirementServiceBatch, DefaultPlannedOrderServiceBatch, DefaultPlanningCategoryServiceBatch, DefaultPricingProcedureInPurchasingServiceBatch, DefaultPricingProcedureInSalesServiceBatch, DefaultProcessOrderConfirmationServiceBatch, DefaultProcessOrderConfirmationV2ServiceBatch, DefaultProcessOrderServiceBatch, DefaultProductAllocationObjectServiceBatch, DefaultProductAllocationSequenceServiceBatch, DefaultProductGroupServiceBatch, DefaultProductionOrderConfirmationServiceBatch, DefaultProductionOrderConfirmationV2ServiceBatch, DefaultProductionOrderServiceBatch, DefaultProductionOrderV2ServiceBatch, DefaultProductionRoutingServiceBatch, DefaultProductionSupplyAreaServiceBatch, DefaultProductMasterDataIncludingClassificationServiceBatch, DefaultProductMasterServiceBatch, DefaultProfitCenterServiceBatch, DefaultPurchaseContractServiceBatch, DefaultPurchaseOrderServiceBatch, DefaultPurchaseRequisitionServiceBatch, DefaultPurchasingCategoryServiceBatch, DefaultPurchasingInfoRecordServiceBatch, DefaultPurchasingPricingConditionRecordServiceBatch, DefaultPurchasingQuotaArrangementServiceBatch, DefaultPurchasingSourceServiceBatch, DefaultQualityInfoRecordServiceBatch, DefaultQualityInspectionDataServiceBatch, DefaultRawSubstanceServiceBatch, DefaultRealSubstanceServiceBatch, DefaultRecipeHeaderAndFormulaServiceBatch, DefaultRequestsForQuotationServiceBatch, DefaultReservationDocumentServiceBatch, DefaultSalesContractServiceBatch, DefaultSalesDistrictServiceBatch, DefaultSalesDocumentWithCreditBlocksServiceBatch, DefaultSalesInquiryServiceBatch, DefaultSalesOrderServiceBatch, DefaultSalesOrderSimulateServiceBatch, DefaultSalesOrderWithoutChargeServiceBatch, DefaultSalesOrganizationServiceBatch, DefaultSalesPricingConditionRecordServiceBatch, DefaultSalesQuotationServiceBatch, DefaultSalesSchedulingAgreementServiceBatch, DefaultSchedulingAgreementServiceBatch, DefaultSegmentServiceBatch, DefaultServiceConfirmationServiceBatch, DefaultServiceContractServiceBatch, DefaultServiceEntrySheetServiceBatch, DefaultServiceOrderServiceBatch, DefaultServiceQuotationServiceBatch, DefaultSoldToPartyAssignmentOfSalesSchedulingAgreementServiceBatch, DefaultStatisticalKeyFigureServiceBatch, DefaultSupplierActivityServiceBatch, DefaultSupplierActivityTaskServiceBatch, DefaultSupplierEvaluationResponseServiceBatch, DefaultSupplierEvaluationScorecardServiceBatch, DefaultSupplierEvaluationScoreServiceBatch, DefaultSupplierInvoiceIntegrationServiceBatch, DefaultSupplierQuotationServiceBatch, DefaultTradingPartnerServiceBatch, DefaultTransactionDataForGroupReportingServiceBatch, DefaultTreasuryPositionFlowServiceBatch, DefaultTrialBalanceServiceBatch, DefaultWarehouseOutboundDeliveryOrderServiceBatch, DefaultWarehousePhysicalInventoryServiceBatch, DefaultWarehouseResourceServiceBatch, DefaultWarehouseStorageBinServiceBatch, DefaultWarehouseTaskServiceBatch, DefaultWorkCenterDataServiceBatch, DefaultWorkforceAvailabilityServiceBatch, DefaultWorkforcePersonSkilltagServiceBatch, DefaultWorkforceTimesheetServiceBatch

public abstract class BatchFluentHelperBasic<FluentHelperBatchT extends FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>,FluentHelperBatchChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperBatchT>>
extends Object
implements FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>

Representation of any OData batch request as a fluent interface for managing changesets and executing them in a single query.

Constructor Summary

Constructors

Constructor and Description
BatchFluentHelperBasic()

Method Summary

Modifier and Type	Method and Description
FluentHelperBatchT	cachingMetadata() Enable the caching of OData metadata responses for this batch request.
BatchResponse	execute(HttpDestinationProperties destination) Executes the underlying batch query including the stored changeset operations.
protected abstract String	getServicePathForBatchRequest() Get the OData service endpoint path for the current OData batch request.
protected abstract FluentHelperBatchT	getThis() Method to safely return the current fluent helper instance upon public method calls.
FluentHelperBatchT	withoutCachingMetadata() Disable the caching of OData metadata responses for this batch request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.FluentHelperServiceBatch

beginChangeSet

Constructor Detail

BatchFluentHelperBasic

public BatchFluentHelperBasic()

Method Detail

getServicePathForBatchRequest

@Nonnull
protected abstract String getServicePathForBatchRequest()

Get the OData service endpoint path for the current OData batch request. Usually it can be found as static member DEFAULT_SERVICE_PATH in the service class.

Returns:

The String representation of the OData service endpoint path.

getThis

@Nonnull
protected abstract FluentHelperBatchT getThis()

Method to safely return the current fluent helper instance upon public method calls.

Returns:

The current fluent helper instance.

cachingMetadata

@Nonnull
public FluentHelperBatchT cachingMetadata()

Enable the caching of OData metadata responses for this batch request.

Specified by:

cachingMetadata in interface FluentHelperServiceBatch<FluentHelperBatchT extends FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>,FluentHelperBatchChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperBatchT>>

Returns:

The current OData batch request instance.

withoutCachingMetadata

@Nonnull
public FluentHelperBatchT withoutCachingMetadata()

Disable the caching of OData metadata responses for this batch request.

Specified by:

withoutCachingMetadata in interface FluentHelperServiceBatch<FluentHelperBatchT extends FluentHelperServiceBatch<FluentHelperBatchT,FluentHelperBatchChangeSetT>,FluentHelperBatchChangeSetT extends FluentHelperBatchEndChangeSet<FluentHelperBatchT>>

Returns:

The current OData batch request instance.

execute

@Nonnull
public BatchResponse execute(@Nonnull
                                      HttpDestinationProperties destination)
                               throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying batch query including the stored changeset operations.

Specified by:

execute in interface FluentHelperServiceBatchExecute

Parameters:

destination - Destination object for resolving the HttpClient when executing the underlying OData query.

Returns:

A single result element, holding each changeset response.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - If the parent OData batch request fails, then an ODataException is thrown.