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

Class FluentHelperByKey<FluentHelperT,EntityT extends VdmEntity<?>,SelectableT>

java.lang.Object

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

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

Direct Known Subclasses:

AddressEmailAddressByKeyFluentHelper, AddressFaxNumberByKeyFluentHelper, AddressHomePageURLByKeyFluentHelper, AddressPhoneNumberByKeyFluentHelper, BillingDocumentByKeyFluentHelper, BillingDocumentItemByKeyFluentHelper, BillingDocumentItemPartnerByKeyFluentHelper, BillingDocumentItemPrcgElmntByKeyFluentHelper, BillingDocumentPartnerByKeyFluentHelper, BillingDocumentPrcgElmntByKeyFluentHelper, BillOfMaterialByKeyFluentHelper, BillOfMaterialItemByKeyFluentHelper, BPContactToAddressByKeyFluentHelper, BPContactToFuncAndDeptByKeyFluentHelper, BuPaAddressUsageByKeyFluentHelper, BuPaIdentificationByKeyFluentHelper, BusinessAreaByKeyFluentHelper, BusinessAreaTextByKeyFluentHelper, BusinessPartnerAddressByKeyFluentHelper, BusinessPartnerBankByKeyFluentHelper, BusinessPartnerByKeyFluentHelper, BusinessPartnerContactByKeyFluentHelper, BusinessPartnerRoleByKeyFluentHelper, BusinessPartnerTaxNumberByKeyFluentHelper, C_BehqueuedataByKeyFluentHelper, C_TRIALBALANCEParametersByKeyFluentHelper, ChangeMasterAltDateByKeyFluentHelper, ChangeMasterByKeyFluentHelper, ChangeMasterCharcByKeyFluentHelper, ChangeMasterCharcValueByKeyFluentHelper, ChangeMasterClassByKeyFluentHelper, ChangeMasterClassCharcByKeyFluentHelper, ChangeMasterObjTypeAssgmtByKeyFluentHelper, ChangeMstrObjectMgmtRecordByKeyFluentHelper, ChangeMstrObMgReDocInfoRecdByKeyFluentHelper, ChangeMstrObMgReMaterialByKeyFluentHelper, ChangeMstrObMgReMatlBOMByKeyFluentHelper, ChartOfAccountsByKeyFluentHelper, ChartOfAccountsTextByKeyFluentHelper, ClfnCharacteristicForKeyDateByKeyFluentHelper, ClfnCharcDescForKeyDateByKeyFluentHelper, ClfnCharcRefForKeyDateByKeyFluentHelper, ClfnCharcRstrcnForKeyDateByKeyFluentHelper, ClfnCharcValueDescForKeyDateByKeyFluentHelper, ClfnCharcValueForKeyDateByKeyFluentHelper, ClfnCharcValueForKeyDateByKeyFluentHelper, ClfnClassCharcForKeyDateByKeyFluentHelper, ClfnClassDescForKeyDateByKeyFluentHelper, ClfnClassForKeyDateByKeyFluentHelper, ClfnClassForKeyDateByKeyFluentHelper, ClfnClassKeywordForKeyDateByKeyFluentHelper, ClfnClassTextForKeyDateByKeyFluentHelper, ClfnProductByKeyFluentHelper, CompanyCodeByKeyFluentHelper, CompanyCodeByKeyFluentHelper, CompanyCodeByKeyFluentHelper, CompanyCodeByKeyFluentHelper, ComparisonResultByKeyFluentHelper, ControllingAreaByKeyFluentHelper, ControllingDebitCreditCodeByKeyFluentHelper, ControllingDebitCreditCodeTByKeyFluentHelper, CostCenterActivityTypeByKeyFluentHelper, CostCenterActivityTypeTextByKeyFluentHelper, CostCenterByKeyFluentHelper, CostCenterByKeyFluentHelper, CostCenterByKeyFluentHelper, CostCenterByKeyFluentHelper, CostCenterTextByKeyFluentHelper, CostCenterTextByKeyFluentHelper, CountryByKeyFluentHelper, CountryTextByKeyFluentHelper, CreditMemoReqItemPartnerByKeyFluentHelper, CreditMemoReqItemPrcgElmntByKeyFluentHelper, CreditMemoReqPartnerByKeyFluentHelper, CreditMemoReqPrcgElmntByKeyFluentHelper, CreditMemoRequestByKeyFluentHelper, CreditMemoRequestItemByKeyFluentHelper, CustomerByKeyFluentHelper, CustomerCompanyByKeyFluentHelper, CustomerDunningByKeyFluentHelper, CustomerGroupByKeyFluentHelper, CustomerGroupTextByKeyFluentHelper, CustomerMaterialByKeyFluentHelper, CustomerReturnByKeyFluentHelper, CustomerReturnItemByKeyFluentHelper, CustomerReturnItemPartnerByKeyFluentHelper, CustomerReturnItemPrcgElmntByKeyFluentHelper, CustomerReturnPartnerByKeyFluentHelper, CustomerReturnPrcgElmntByKeyFluentHelper, CustomerReturnScheduleLineByKeyFluentHelper, CustomerSalesAreaByKeyFluentHelper, CustomerSalesAreaTaxByKeyFluentHelper, CustomerSupplierIndustryByKeyFluentHelper, CustomerSupplierIndustryTextByKeyFluentHelper, CustomerWithHoldingTaxByKeyFluentHelper, CustSalesPartnerFuncByKeyFluentHelper, DebitMemoReqItemPartnerByKeyFluentHelper, DebitMemoReqItemPrcgElmntByKeyFluentHelper, DebitMemoReqPartnerByKeyFluentHelper, DebitMemoReqPrcgElmntByKeyFluentHelper, DebitMemoRequestByKeyFluentHelper, DebitMemoRequestItemByKeyFluentHelper, DefectByKeyFluentHelper, DefectCategoryByKeyFluentHelper, DefectCategoryTextByKeyFluentHelper, DefectClassByKeyFluentHelper, DefectClassTextByKeyFluentHelper, DefectCodeByKeyFluentHelper, DefectCodeGroupByKeyFluentHelper, DefectCodeGroupTextByKeyFluentHelper, DefectCodeTextByKeyFluentHelper, DemandByKeyFluentHelper, DistributionChannelByKeyFluentHelper, DistributionChannelTextByKeyFluentHelper, DivisionByKeyFluentHelper, DivisionTextByKeyFluentHelper, DocInfoRecdObjLinkProductByKeyFluentHelper, DocumentInfoRecordByKeyFluentHelper, DocumentInfoRecordDescByKeyFluentHelper, DocumentInfoRecordDocStsVHByKeyFluentHelper, FinPlanningEntryItemByKeyFluentHelper, FunctionalAreaByKeyFluentHelper, FunctionalAreaTextByKeyFluentHelper, GLAccountByKeyFluentHelper, GLAccountInChartOfAccountsByKeyFluentHelper, GLAccountTextByKeyFluentHelper, I_BusinessObjectKeysByKeyFluentHelper, I_BusObjectsByKeyFluentHelper, InbDeliveryDocFlowByKeyFluentHelper, InbDeliveryHeaderByKeyFluentHelper, InbDeliveryItemByKeyFluentHelper, InspectionMethodByKeyFluentHelper, InspectionSpecificationByKeyFluentHelper, JobTemplateByKeyFluentHelper, JournalEntryItemBasicByKeyFluentHelper, LedgerByKeyFluentHelper, LedgerByKeyFluentHelper, LedgerTextByKeyFluentHelper, LegalTransactionByKeyFluentHelper, LglTransCategoryByKeyFluentHelper, LglTransCategoryGroupByKeyFluentHelper, LglTransDateByKeyFluentHelper, LglTransEntityByKeyFluentHelper, LglTransExternalContactByKeyFluentHelper, LglTransInternalContactByKeyFluentHelper, LglTransLinkedObjectsByKeyFluentHelper, LglTransParentCategoryByKeyFluentHelper, LglTransRelationshipByKeyFluentHelper, MaintainYearsPeriodByKeyFluentHelper, MaterialDocumentHeaderByKeyFluentHelper, MaterialDocumentItemByKeyFluentHelper, MaterialStockByKeyFluentHelper, MatlStkInAcctModByKeyFluentHelper, ODataQueryAdditionalMetadataByKeyFluentHelper, OperationalAcctgDocItemCubeByKeyFluentHelper, OutbDeliveryDocFlowByKeyFluentHelper, OutbDeliveryHeaderByKeyFluentHelper, OutbDeliveryItemByKeyFluentHelper, PartnerCompanyByKeyFluentHelper, PhysInventoryDocHeaderByKeyFluentHelper, PhysInventoryDocItemByKeyFluentHelper, PlanDataByKeyFluentHelper, PlannedOrderByKeyFluentHelper, PlannedOrderComponentByKeyFluentHelper, PlanningCategoryByKeyFluentHelper, PlanningCategoryTextByKeyFluentHelper, ProcessOrderByKeyFluentHelper, ProcessOrderComponentByKeyFluentHelper, ProcessOrderItemByKeyFluentHelper, ProcessOrderOperationByKeyFluentHelper, ProcessOrderStatusByKeyFluentHelper, ProcOrdConfirmationByKeyFluentHelper, ProdAllocationObjectByKeyFluentHelper, ProdAllocationObjectTByKeyFluentHelper, ProdAllocationSequenceByKeyFluentHelper, ProdAllocCharcMetaDataByKeyFluentHelper, ProdAllocCharcValCombnByKeyFluentHelper, ProdAllocObjTimeSeriesByKeyFluentHelper, ProdAllocSequenceTByKeyFluentHelper, ProdAllocSqncAssgmtByKeyFluentHelper, ProductByKeyFluentHelper, ProductByKeyFluentHelper, ProductByKeyFluentHelper, ProductCharcByKeyFluentHelper, ProductCharcValueByKeyFluentHelper, ProductClassByKeyFluentHelper, ProductClassCharcByKeyFluentHelper, ProductDescriptionByKeyFluentHelper, ProductDescriptionByKeyFluentHelper, ProductDescriptionByKeyFluentHelper, ProductDescriptionByKeyFluentHelper, ProductGroupByKeyFluentHelper, ProductGroupTextByKeyFluentHelper, ProductionOrderByKeyFluentHelper, ProductionOrderComponentByKeyFluentHelper, ProductionOrderConfByKeyFluentHelper, ProductionOrderItemByKeyFluentHelper, ProductionOrderOperationByKeyFluentHelper, ProductionOrderStatusByKeyFluentHelper, ProductionRsceToolsByKeyFluentHelper, ProductPlantByKeyFluentHelper, ProductPlantByKeyFluentHelper, ProductPlantByKeyFluentHelper, ProductPlantByKeyFluentHelper, ProductPlantProcurementByKeyFluentHelper, ProductPlantProcurementByKeyFluentHelper, ProductSalesDeliveryByKeyFluentHelper, ProductSalesDeliveryByKeyFluentHelper, ProductSalesDeliveryByKeyFluentHelper, ProductSalesDeliveryByKeyFluentHelper, ProductSalesTaxByKeyFluentHelper, ProductSalesTaxByKeyFluentHelper, ProductStorageLocationByKeyFluentHelper, ProductStorageLocationByKeyFluentHelper, ProductStorageLocationByKeyFluentHelper, ProductStorageLocationByKeyFluentHelper, ProductSupplyPlanningByKeyFluentHelper, ProductSupplyPlanningByKeyFluentHelper, ProductWorkSchedulingByKeyFluentHelper, ProductWorkSchedulingByKeyFluentHelper, ProfitCenterByKeyFluentHelper, ProfitCenterByKeyFluentHelper, ProfitCenterByKeyFluentHelper, ProfitCenterTextByKeyFluentHelper, ProjectByKeyFluentHelper, ProjectByKeyFluentHelper, PurchaseContractByKeyFluentHelper, PurchaseContractItemByKeyFluentHelper, PurchaseOrderByKeyFluentHelper, PurchaseOrderItemByKeyFluentHelper, PurchaseOrderScheduleLineByKeyFluentHelper, PurchaseRequisitionHeaderByKeyFluentHelper, PurchaseRequisitionItemByKeyFluentHelper, PurchasingInfoRecordByKeyFluentHelper, PurchasingQuotaArrangementByKeyFluentHelper, PurchasingSourceByKeyFluentHelper, PurCtrAccountByKeyFluentHelper, PurCtrAddressByKeyFluentHelper, PurCtrPartnersByKeyFluentHelper, PurgCatByKeyFluentHelper, PurgCatDescriptionByKeyFluentHelper, PurgCatMaterialGroupByKeyFluentHelper, PurgCatMemberByKeyFluentHelper, PurgCatPlannedSpendByKeyFluentHelper, PurgCatPurchaserResponsibleByKeyFluentHelper, PurgCatSupplierByKeyFluentHelper, PurgCatTranslationStatusByKeyFluentHelper, PurgInfoRecdOrgPlantDataByKeyFluentHelper, PurgQuotaArrangementItemByKeyFluentHelper, PurOrdAccountAssignmentByKeyFluentHelper, PurOrdPricingElementByKeyFluentHelper, PurReqAddDeliveryByKeyFluentHelper, PurReqnAcctAssgmtByKeyFluentHelper, RawSubstanceByKeyFluentHelper, RealSubstanceByKeyFluentHelper, RecipeByKeyFluentHelper, RecipeFormulaItemByKeyFluentHelper, RecipeTextByKeyFluentHelper, RequestForQuotationBidderByKeyFluentHelper, RequestForQuotationByKeyFluentHelper, RequestForQuotationItemByKeyFluentHelper, SalesContractByKeyFluentHelper, SalesContractItemByKeyFluentHelper, SalesContractItemPartnerByKeyFluentHelper, SalesContractItemPrcgElmntByKeyFluentHelper, SalesContractPartnerByKeyFluentHelper, SalesContractPrcgElmntByKeyFluentHelper, SalesDistrictByKeyFluentHelper, SalesDistrictTextByKeyFluentHelper, SalesInquiryByKeyFluentHelper, SalesInquiryItemByKeyFluentHelper, SalesInquiryItemPartnerByKeyFluentHelper, SalesInquiryItemPrcgElmntByKeyFluentHelper, SalesInquiryPartnerByKeyFluentHelper, SalesInquiryPrcgElmntByKeyFluentHelper, SalesOrderByKeyFluentHelper, SalesOrderHeaderPartnerByKeyFluentHelper, SalesOrderHeaderPrElementByKeyFluentHelper, SalesOrderItemByKeyFluentHelper, SalesOrderItemPartnerByKeyFluentHelper, SalesOrderItemPrElementByKeyFluentHelper, SalesOrderScheduleLineByKeyFluentHelper, SalesOrganizationByKeyFluentHelper, SalesOrganizationTextByKeyFluentHelper, SalesQuotationByKeyFluentHelper, SalesQuotationItemByKeyFluentHelper, SalesQuotationItemPartnerByKeyFluentHelper, SalesQuotationItemPrcgElmntByKeyFluentHelper, SalesQuotationPartnerByKeyFluentHelper, SalesQuotationPrcgElmntByKeyFluentHelper, SchAgrmtAcCntByKeyFluentHelper, SchAgrmtHeaderByKeyFluentHelper, SchAgrmtItemByKeyFluentHelper, SchAgrmtPartnerByKeyFluentHelper, SchAgrmtSchLineByKeyFluentHelper, SegmentByKeyFluentHelper, SegmentTextByKeyFluentHelper, ServiceEntrySheetByKeyFluentHelper, ServiceEntrySheetItemByKeyFluentHelper, SpecAssignedMatlForKeyDateByKeyFluentHelper, SpecAssignedMatlForKeyDateByKeyFluentHelper, SpecAuthorizationGroupTextByKeyFluentHelper, SpecAuthorizationGroupTextByKeyFluentHelper, SpecCharByValueAssgmtInstByKeyFluentHelper, SpecCharByValueAssgmtInstByKeyFluentHelper, SpecIdentifierByKeyFluentHelper, SpecIdentifierByKeyFluentHelper, SpecStatusAttributesByKeyFluentHelper, SpecStatusAttributesByKeyFluentHelper, SpecStatusNextStatusByKeyFluentHelper, SpecStatusNextStatusByKeyFluentHelper, SpecStatusSchemaByKeyFluentHelper, SpecStatusSchemaByKeyFluentHelper, SpecValAssgmtInstanceWthCompByKeyFluentHelper, SpecValAssgmtInstanceWthCompByKeyFluentHelper, SrvcEntrShtAcctAssignmentByKeyFluentHelper, SubscriptionMaintainByKeyFluentHelper, SubscriptionReadByKeyFluentHelper, SuplrActyDescriptionByKeyFluentHelper, SuplrActyParticipantByKeyFluentHelper, SuplrActyPurchaserRespByKeyFluentHelper, SuplrActySupplierByKeyFluentHelper, SuplrActyTskActyReferenceByKeyFluentHelper, SuplrActyTskCommTextByKeyFluentHelper, SuplrActyTskDescriptionByKeyFluentHelper, SuplrActyTskMessageTextByKeyFluentHelper, SuplrActyTskProcessorByKeyFluentHelper, SuplrActyTskPurchaserRespByKeyFluentHelper, SuplrActyTskSupplierByKeyFluentHelper, SuplrEvalRspAppraiserByKeyFluentHelper, SuplrEvalRspExplTextByKeyFluentHelper, SuplrEvalRspExternalNameByKeyFluentHelper, SuplrEvalRspIntroductionByKeyFluentHelper, SuplrEvalRspLanguageByKeyFluentHelper, SuplrEvalRspPurchaserRespByKeyFluentHelper, SuplrEvalRspQuestionByKeyFluentHelper, SuplrEvalRspQuestionTextByKeyFluentHelper, SuplrEvalRspRootQnaireByKeyFluentHelper, SuplrEvalRspSectionByKeyFluentHelper, SuplrEvalRspSectionTextByKeyFluentHelper, SuplrEvalRspStrucQnaireByKeyFluentHelper, SuplrEvalRspSupplierByKeyFluentHelper, SuplrEvalSccrdPurchaserRespByKeyFluentHelper, SuplrEvalSccrdQuestionByKeyFluentHelper, SuplrEvalSccrdSectionByKeyFluentHelper, SuplrEvalSccrdStrucQnaireByKeyFluentHelper, SuplrEvalSccrdSupplierByKeyFluentHelper, SuplrEvalScorecardByKeyFluentHelper, SuplrEvalScorecardRootQnaireByKeyFluentHelper, SuplrInvcItemPurOrdRefByKeyFluentHelper, SupplierActivityByKeyFluentHelper, SupplierActivityTaskByKeyFluentHelper, SupplierByKeyFluentHelper, SupplierCompanyByKeyFluentHelper, SupplierDunningByKeyFluentHelper, SupplierEvaluationResponseByKeyFluentHelper, SupplierInvoiceByKeyFluentHelper, SupplierInvoiceItemGLAcctByKeyFluentHelper, SupplierInvoiceTaxByKeyFluentHelper, SupplierPartnerFuncByKeyFluentHelper, SupplierPurchasingOrgByKeyFluentHelper, SupplierQuotationByKeyFluentHelper, SupplierQuotationItemByKeyFluentHelper, SupplierWithHoldingTaxByKeyFluentHelper, TimeOverviewByKeyFluentHelper, TimeSheetEntryByKeyFluentHelper, WorkCenterCapacityByKeyFluentHelper, WorkCenterDayOperationByKeyFluentHelper, WorkCenterPipeLineOperationByKeyFluentHelper, WorkCentersByKeyFluentHelper, WorkItemByKeyFluentHelper, WorkItemByKeyFluentHelper, WorkpackageByKeyFluentHelper, WorkPackageByKeyFluentHelper

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

Constructor Summary

Constructors

Constructor and Description
FluentHelperByKey()

Method Summary

Modifier and Type	Method and Description
EntityT	execute(ErpEndpoint erpEndpoint) Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.
FluentHelperT	select(SelectableT... fields) Query modifier to limit which field values of the entity get fetched & populated.
com.sap.cloud.sdk.odatav2.connectivity.ODataQuery	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, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentHelperByKey

public FluentHelperByKey()

Method Detail

select

public FluentHelperT select(SelectableT... fields)

Query modifier to limit which field values of the entity get fetched & populated. If this method is never called, then all fields will be fetched & populated. But if this method is called at least once, then only the specified fields will be fetched & populated. Calling this multiple times will combine the set(s) of fields of each call.

Parameters:

fields - Array of fields to select.

Returns:

The same fluent helper with its error handler set to the provided object.

toQuery

public com.sap.cloud.sdk.odatav2.connectivity.ODataQuery toQuery()

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.

withErrorHandler

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

public EntityT execute(ErpEndpoint erpEndpoint)
                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored key field values, plus any query modifiers that were previously called.

Specified by:

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

Parameters:

erpEndpoint - Supply the ERP system instance for executing the underlying OData query.

Returns:

An AddressPhoneNumber entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

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

See Also:

ErpConfigContext.ErpConfigContext(), ErpEndpoint.ErpEndpoint(ErpConfigContext)