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>

Type Parameters:

FluentHelperT - The fluent helper type.

EntityT - The type of the entity to create.

Direct Known Subclasses:

AddressEmailAddressCreateFluentHelper, AddressFaxNumberCreateFluentHelper, AddressHomePageURLCreateFluentHelper, AddressPhoneNumberCreateFluentHelper, AttachmentContentCreateFluentHelper, BatchCreateFluentHelper, BillOfMaterialCreateFluentHelper, BillOfMaterialItemCreateFluentHelper, BuPaAddressUsageCreateFluentHelper, BuPaIdentificationCreateFluentHelper, BusinessPartnerAddressCreateFluentHelper, BusinessPartnerBankCreateFluentHelper, BusinessPartnerContactCreateFluentHelper, BusinessPartnerCreateFluentHelper, BusinessPartnerRoleCreateFluentHelper, BusinessPartnerTaxNumberCreateFluentHelper, CentralPurchaseContractCreateFluentHelper, ChangeMasterAltDateCreateFluentHelper, ChangeMasterCreateFluentHelper, ChangeMasterObjTypeAssgmtCreateFluentHelper, ChangeMstrObMgReDocInfoRecdCreateFluentHelper, ChangeMstrObMgReMaterialCreateFluentHelper, ChangeMstrObMgReMatlBOMCreateFluentHelper, ChangeRecordCreateFluentHelper, ChangeRecordReferenceBitCreateFluentHelper, ChangeRecordReferenceBOMCreateFluentHelper, ChangeRecordReferenceDocCreateFluentHelper, ChangeRecordReferenceMatCreateFluentHelper, ClfnCharacteristicForKeyDateCreateFluentHelper, ClfnCharcDescForKeyDateCreateFluentHelper, ClfnCharcRefForKeyDateCreateFluentHelper, ClfnCharcRstrcnForKeyDateCreateFluentHelper, ClfnCharcValueDescForKeyDateCreateFluentHelper, ClfnCharcValueForKeyDateCreateFluentHelper, ClfnClassCharcForKeyDateCreateFluentHelper, ClfnClassDescForKeyDateCreateFluentHelper, ClfnClassForKeyDateCreateFluentHelper, ClfnClassKeywordForKeyDateCreateFluentHelper, ClfnClassTextForKeyDateCreateFluentHelper, CreditMemoRequestCreateFluentHelper, CreditMemoRequestItemCreateFluentHelper, CustomerCompanyCreateFluentHelper, CustomerDunningCreateFluentHelper, CustomerMaterialCreateFluentHelper, CustomerReturnCreateFluentHelper, CustomerReturnItemCreateFluentHelper, CustomerSalesAreaCreateFluentHelper, CustomerSalesAreaTaxCreateFluentHelper, CustomerWithHoldingTaxCreateFluentHelper, CustSalesPartnerFuncCreateFluentHelper, DebitMemoRequestCreateFluentHelper, DebitMemoRequestItemCreateFluentHelper, DefectCreateFluentHelper, DemandCreateFluentHelper, DocInfoRecdObjLinkProductCreateFluentHelper, DocumentInfoRecordCreateFluentHelper, DocumentInfoRecordDescCreateFluentHelper, EnterpriseProjectCreateFluentHelper, EnterpriseProjectElementCreateFluentHelper, FinancialPlanDataCreateFluentHelper, InbDeliveryHeaderCreateFluentHelper, InspectionResultCreateFluentHelper, InspLotUsageDecisionCreateFluentHelper, KanbanControlCycleCreateFluentHelper, LegalDocumentCreateFluentHelper, LegalTransactionCreateFluentHelper, LglDocStampCreateFluentHelper, LglTransDateCreateFluentHelper, LglTransEntityCreateFluentHelper, LglTransExternalContactCreateFluentHelper, LglTransInternalContactCreateFluentHelper, LglTransLinkedObjectsCreateFluentHelper, LglTransRelationshipCreateFluentHelper, MaterialBOMCreateFluentHelper, MaterialBOMItemCreateFluentHelper, MaterialDocumentHeaderCreateFluentHelper, OutbDeliveryHeaderCreateFluentHelper, PaymentAdviceCreateFluentHelper, PaymentAdviceItemCreateFluentHelper, PhysInventoryDocHeaderCreateFluentHelper, PlannedIndepRqmtCreateFluentHelper, PlannedIndepRqmtItemCreateFluentHelper, PlannedOrderComponentCreateFluentHelper, PlannedOrderCreateFluentHelper, ProcOrdConf2CreateFluentHelper, ProcOrdConfMatlDocItmCreateFluentHelper, ProdAllocCharcValCombnCreateFluentHelper, ProdAllocObjTimeSeriesCreateFluentHelper, ProdAllocSqncAssgmtCreateFluentHelper, ProdnOrdConf2CreateFluentHelper, ProdnOrdConfMatlDocItmCreateFluentHelper, ProductBasicTextCreateFluentHelper, ProductCreateFluentHelper, ProductDescriptionCreateFluentHelper, ProductInspectionTextCreateFluentHelper, ProductionOrderCreateFluentHelper, ProductionSupplyAreaAddressCreateFluentHelper, ProductionSupplyAreaCreateFluentHelper, ProductionSupplyAreaTextCreateFluentHelper, 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, PurchaseOrderCreateFluentHelper, PurchaseOrderItemCreateFluentHelper, PurchaseRequisitionHeaderCreateFluentHelper, PurchasingQuotaArrangementCreateFluentHelper, PurchasingSourceCreateFluentHelper, PurgCatCreateFluentHelper, PurgCatDescriptionCreateFluentHelper, PurgCatMaterialGroupCreateFluentHelper, PurgCatMemberCreateFluentHelper, PurgCatPlannedSpendCreateFluentHelper, PurgCatSupplierCreateFluentHelper, PurgCatTranslationStatusCreateFluentHelper, RecipeCharcValueCreateFluentHelper, RecipeClassCreateFluentHelper, RecipeCreateFluentHelper, RecipeFormulaItemCreateFluentHelper, RecipeProcessElementCreateFluentHelper, RecipeProcessElementTextCreateFluentHelper, RecipeProcessEquipRqmtCreateFluentHelper, RecipeProcessEquipRqmtTextCreateFluentHelper, RecipeProcessParamValueCreateFluentHelper, RecipeProcessParamValueTxtCreateFluentHelper, RecipeTextCreateFluentHelper, RequestForQuotationBidderCreateFluentHelper, RequestForQuotationCreateFluentHelper, RequestForQuotationItemCreateFluentHelper, ReservationDocumentHeaderCreateFluentHelper, ReturnsDeliveryHeaderCreateFluentHelper, SalesContractCreateFluentHelper, SalesContractItemCreateFluentHelper, SalesOrderCreateFluentHelper, SalesOrderItemCreateFluentHelper, SalesOrderWithoutChargeCreateFluentHelper, SalesOrderWithoutChargeItemCreateFluentHelper, SalesQuotationCreateFluentHelper, SalesQuotationItemCreateFluentHelper, SchAgrmtHeaderCreateFluentHelper, ServiceEntrySheetCreateFluentHelper, SkillTagCreateFluentHelper, SlsPrcgCndnRecdSuplmntCreateFluentHelper, SlsPrcgCndnRecdValidityCreateFluentHelper, SlsPrcgCndnRecordScaleCreateFluentHelper, SlsPrcgConditionRecordCreateFluentHelper, StatisticalKeyFigureCreateFluentHelper, StatisticalKeyFigureTextCreateFluentHelper, SubscriptionMaintainCreateFluentHelper, SuplrActyDescriptionCreateFluentHelper, SuplrActyParticipantCreateFluentHelper, SuplrActySupplierCreateFluentHelper, SuplrActyTskDescriptionCreateFluentHelper, SuplrActyTskMessageTextCreateFluentHelper, SuplrActyTskSupplierCreateFluentHelper, SuplrInvcHeaderWhldgTaxCreateFluentHelper, SuplrInvcItemPurOrdRefCreateFluentHelper, SupplierActivityCreateFluentHelper, SupplierActivityTaskCreateFluentHelper, SupplierCompanyCreateFluentHelper, SupplierDunningCreateFluentHelper, SupplierInvoiceCreateFluentHelper, SupplierInvoiceItemGLAcctCreateFluentHelper, SupplierInvoiceTaxCreateFluentHelper, SupplierPartnerFuncCreateFluentHelper, SupplierPurchasingOrgCreateFluentHelper, SupplierWithHoldingTaxCreateFluentHelper, TimeOverviewCreateFluentHelper, TimeSheetEntryCreateFluentHelper, WorkCenterCapacityIntervalCreateFluentHelper, WorkCenterCapacityShiftCreateFluentHelper, WorkItemCreateFluentHelper, WorkPackageCreateFluentHelper

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<ParentEntityT extends VdmEntity<?>> FluentHelperT	asChildOf(ParentEntityT entity, EntityLink<? extends EntityLink<?,ParentEntityT,EntityT>,ParentEntityT,EntityT> entityLink) This function allows to create a new entity via an existing parent entity.
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() Returns a class object of the type this fluent helper works with.
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

asResilientCommand, asResilientCommand, cachingMetadata, execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withCustomHttpHeader, withCustomHttpHeaders, withoutCachingMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentHelperCreate

public FluentHelperCreate(@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()

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

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<?>,EntityT extends VdmEntity<?>>

Returns:

A class object of the handled type.

getQueryBuilder

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

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.

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

asChildOf

@Nonnull
public <ParentEntityT extends VdmEntity<?>> FluentHelperT asChildOf(@Nullable
                                                                             ParentEntityT entity,
                                                                             @Nullable
                                                                             EntityLink<? extends EntityLink<?,ParentEntityT,EntityT>,ParentEntityT,EntityT> entityLink)

This function allows to create a new entity via an existing parent entity. Parent means that the existing entity has to be related to the entity to be created via a navigation property. Thus, the function requires the caller to provide an EntityLink<?, ParentEntityT, EntityT> that represents such a navigation property. ParentEntityT can represent any entity that is related to the entity to be created. EntityT represents the type of the entity to be created. Furthermore, the function requires an instance of type ParentEntityT. This instance must hold the key fields used to identify it. NOTE: While any EntityLink provided by the OData VDM satisfying these type constraints allows you to call this function, the service may NOT allow this kind of create operation for the respective navigation property. Thus, calling this function without knowledge of the underlying OData service can result in failing requests.

Parameters:

entity - An instance of the related entity that MUST hold values for the respective key fields.

entityLink - An EntityLink representing a navigation property.

Returns:

The same fluent helper configured to use the provided navigation property for creation.