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

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

java.lang.Object

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

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

Direct Known Subclasses:

AddressEmailAddressCreateFluentHelper, AddressFaxNumberCreateFluentHelper, AddressHomePageURLCreateFluentHelper, AddressPhoneNumberCreateFluentHelper, AttachmentContentCreateFluentHelper, BillOfMaterialCreateFluentHelper, BillOfMaterialItemCreateFluentHelper, BuPaAddressUsageCreateFluentHelper, BuPaIdentificationCreateFluentHelper, BusinessPartnerAddressCreateFluentHelper, BusinessPartnerBankCreateFluentHelper, BusinessPartnerContactCreateFluentHelper, BusinessPartnerCreateFluentHelper, BusinessPartnerRoleCreateFluentHelper, BusinessPartnerTaxNumberCreateFluentHelper, CentralPurchaseContractCreateFluentHelper, ChangeMasterAltDateCreateFluentHelper, ChangeMasterCreateFluentHelper, ChangeMasterObjTypeAssgmtCreateFluentHelper, ChangeMstrObMgReDocInfoRecdCreateFluentHelper, ChangeMstrObMgReMaterialCreateFluentHelper, ChangeMstrObMgReMatlBOMCreateFluentHelper, ClfnCharacteristicForKeyDateCreateFluentHelper, ClfnCharcDescForKeyDateCreateFluentHelper, ClfnCharcRefForKeyDateCreateFluentHelper, ClfnCharcRstrcnForKeyDateCreateFluentHelper, ClfnCharcValueDescForKeyDateCreateFluentHelper, ClfnCharcValueForKeyDateCreateFluentHelper, ClfnClassCharcForKeyDateCreateFluentHelper, ClfnClassDescForKeyDateCreateFluentHelper, ClfnClassForKeyDateCreateFluentHelper, ClfnClassKeywordForKeyDateCreateFluentHelper, ClfnClassTextForKeyDateCreateFluentHelper, CntrlPurchaseContractItemCreateFluentHelper, CntrlPurContrItmDistributionCreateFluentHelper, CreditMemoRequestCreateFluentHelper, CreditMemoRequestItemCreateFluentHelper, CustomerCompanyCreateFluentHelper, CustomerDunningCreateFluentHelper, CustomerReturnCreateFluentHelper, CustomerReturnItemCreateFluentHelper, CustomerSalesAreaCreateFluentHelper, CustomerSalesAreaTaxCreateFluentHelper, CustomerWithHoldingTaxCreateFluentHelper, CustSalesPartnerFuncCreateFluentHelper, DebitMemoRequestCreateFluentHelper, DebitMemoRequestItemCreateFluentHelper, DefectCreateFluentHelper, DemandCreateFluentHelper, DocInfoRecdObjLinkProductCreateFluentHelper, DocumentInfoRecordCreateFluentHelper, DocumentInfoRecordDescCreateFluentHelper, EnterpriseProjectCreateFluentHelper, InbDeliveryHeaderCreateFluentHelper, InspectionResultCreateFluentHelper, LegalTransactionCreateFluentHelper, LglTransDateCreateFluentHelper, LglTransEntityCreateFluentHelper, LglTransExternalContactCreateFluentHelper, LglTransInternalContactCreateFluentHelper, LglTransLinkedObjectsCreateFluentHelper, LglTransRelationshipCreateFluentHelper, MaterialDocumentHeaderCreateFluentHelper, OutbDeliveryHeaderCreateFluentHelper, PhysInventoryDocHeaderCreateFluentHelper, PlannedIndepRqmtCreateFluentHelper, PlannedIndepRqmtItemCreateFluentHelper, PlannedOrderCreateFluentHelper, ProdAllocCharcValCombnCreateFluentHelper, ProdAllocObjTimeSeriesCreateFluentHelper, ProdAllocSqncAssgmtCreateFluentHelper, ProductBasicTextCreateFluentHelper, ProductCreateFluentHelper, ProductDescriptionCreateFluentHelper, ProductInspectionTextCreateFluentHelper, ProductPlantCostingCreateFluentHelper, ProductPlantCreateFluentHelper, ProductPlantForecastingCreateFluentHelper, ProductPlantIntlTrdCreateFluentHelper, ProductPlantMRPAreaCreateFluentHelper, ProductPlantProcurementCreateFluentHelper, ProductPlantQualityMgmtCreateFluentHelper, ProductPlantSalesCreateFluentHelper, ProductPlantStorageCreateFluentHelper, ProductPlantTextCreateFluentHelper, ProductProcurementCreateFluentHelper, ProductPurchaseTextCreateFluentHelper, ProductQualityMgmtCreateFluentHelper, ProductSalesCreateFluentHelper, ProductSalesDeliveryCreateFluentHelper, ProductSalesTaxCreateFluentHelper, ProductSalesTextCreateFluentHelper, ProductStorageCreateFluentHelper, ProductStorageLocationCreateFluentHelper, ProductSupplyPlanningCreateFluentHelper, ProductUnitsOfMeasureCreateFluentHelper, ProductUnitsOfMeasureEANCreateFluentHelper, ProductWorkSchedulingCreateFluentHelper, ProjectCreateFluentHelper, PurchaseContractCreateFluentHelper, PurchaseContractItemCreateFluentHelper, PurchaseOrderCreateFluentHelper, PurchaseOrderItemCreateFluentHelper, PurchaseOrderScheduleLineCreateFluentHelper, PurchaseRequisitionHeaderCreateFluentHelper, PurchaseRequisitionItemCreateFluentHelper, PurchasingQuotaArrangementCreateFluentHelper, PurchasingSourceCreateFluentHelper, PurCtrAccountCreateFluentHelper, PurCtrAddressCreateFluentHelper, PurCtrPartnersCreateFluentHelper, PurgCatCreateFluentHelper, PurgCatDescriptionCreateFluentHelper, PurgCatMaterialGroupCreateFluentHelper, PurgCatMemberCreateFluentHelper, PurgCatPlannedSpendCreateFluentHelper, PurgCatSupplierCreateFluentHelper, PurgCatTranslationStatusCreateFluentHelper, PurgQuotaArrangementItemCreateFluentHelper, PurOrdAccountAssignmentCreateFluentHelper, PurOrdPricingElementCreateFluentHelper, PurReqAddDeliveryCreateFluentHelper, PurReqnAcctAssgmtCreateFluentHelper, RecipeCharcValueCreateFluentHelper, RecipeClassCreateFluentHelper, RecipeCreateFluentHelper, RecipeFormulaItemCreateFluentHelper, RecipeProcessElementCreateFluentHelper, RecipeProcessElementTextCreateFluentHelper, RecipeProcessEquipRqmtCreateFluentHelper, RecipeProcessEquipRqmtTextCreateFluentHelper, RecipeProcessParamValueCreateFluentHelper, RecipeProcessParamValueTxtCreateFluentHelper, RecipeTextCreateFluentHelper, RequestForQuotationBidderCreateFluentHelper, RequestForQuotationCreateFluentHelper, RequestForQuotationItemCreateFluentHelper, ReservationDocumentHeaderCreateFluentHelper, ReturnsDeliveryHeaderCreateFluentHelper, SalesContractCreateFluentHelper, SalesContractItemCreateFluentHelper, SalesOrderCreateFluentHelper, SalesOrderItemCreateFluentHelper, SalesQuotationCreateFluentHelper, SalesQuotationItemCreateFluentHelper, SchAgrmtAcCntCreateFluentHelper, SchAgrmtHeaderCreateFluentHelper, SchAgrmtItemCreateFluentHelper, SchAgrmtPartnerCreateFluentHelper, SchAgrmtSchLineCreateFluentHelper, ServiceEntrySheetCreateFluentHelper, ServiceEntrySheetItemCreateFluentHelper, SrvcEntrShtAcctAssignmentCreateFluentHelper, StatisticalKeyFigureCreateFluentHelper, StatisticalKeyFigureTextCreateFluentHelper, SubscriptionMaintainCreateFluentHelper, SuplrActyDescriptionCreateFluentHelper, SuplrActyParticipantCreateFluentHelper, SuplrActySupplierCreateFluentHelper, SuplrActyTskDescriptionCreateFluentHelper, SuplrActyTskMessageTextCreateFluentHelper, SuplrActyTskSupplierCreateFluentHelper, SuplrInvcItemPurOrdRefCreateFluentHelper, SupplierActivityCreateFluentHelper, SupplierActivityTaskCreateFluentHelper, SupplierCompanyCreateFluentHelper, SupplierDunningCreateFluentHelper, SupplierInvoiceCreateFluentHelper, SupplierInvoiceItemGLAcctCreateFluentHelper, SupplierInvoiceTaxCreateFluentHelper, SupplierPartnerFuncCreateFluentHelper, SupplierPurchasingOrgCreateFluentHelper, SupplierWithHoldingTaxCreateFluentHelper, TimeOverviewCreateFluentHelper, TimeSheetEntryCreateFluentHelper, WorkItemCreateFluentHelper, WorkPackageCreateFluentHelper

public abstract class FluentHelperCreate<FluentHelperT,EntityT extends VdmEntity<?>>
extends FluentHelperBasic<FluentHelperT,EntityT,EntityT>

Constructor Summary

Constructors

Constructor and Description
FluentHelperCreate()

Method Summary

Modifier and Type	Method and Description
EntityT	execute(ErpConfigContext configContext) Executes the underlying update request.
protected abstract EntityT	getEntity() Getter for the VDM representation of the entity to be created.
protected Class<? extends EntityT>	getEntityClass()
protected com.sap.cloud.sdk.odatav2.connectivity.ODataCreateRequestBuilder	getQueryBuilder() Creates an instance of the ODataCreateRequestBuilder based on the Entity class.
com.sap.cloud.sdk.odatav2.connectivity.ODataCreateRequest	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

execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getThis, getVersionIdentifier, withCustomHttpHeader, withCustomHttpHeaders, withHttpHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentHelperCreate

public FluentHelperCreate()

Method Detail

getEntity

@Nonnull
protected abstract EntityT getEntity()

Getter for the VDM representation of the entity to be created.

Returns:

The entity that should be created by calling the execute(ErpConfigContext) method.

getEntityClass

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

Specified by:

getEntityClass in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,EntityT extends VdmEntity<?>>

getQueryBuilder

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

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

The following settings are necessary to build the ODataCreateRequestBuilder:

• the endpoint URL
• the entity collection name
• the entity values expected by the OData backend

Returns:

An initialized ODataCreateRequestBuilder.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException - if the fields of the entity could not be converted to the parameter map.

toQuery

@Nonnull
public com.sap.cloud.sdk.odatav2.connectivity.ODataCreateRequest 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 ODataCreateRequestBuilder 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.

execute

@Nonnull
public EntityT execute(@Nonnull
                                ErpConfigContext configContext)
                         throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying update request. Automatically sets the key provided by the S/4HANA system on the supplied entity object.

Specified by:

execute in class FluentHelperBasic<FluentHelperT,EntityT extends VdmEntity<?>,EntityT extends VdmEntity<?>>

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()