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

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

java.lang.Object

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

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

Direct Known Subclasses:

AddressEmailAddressFluentHelper, AddressFaxNumberFluentHelper, AddressHomePageURLFluentHelper, AddressPhoneNumberFluentHelper, BillingDocumentFluentHelper, BillingDocumentItemFluentHelper, BillingDocumentItemPartnerFluentHelper, BillingDocumentItemPrcgElmntFluentHelper, BillingDocumentPartnerFluentHelper, BillingDocumentPrcgElmntFluentHelper, BillOfMaterialFluentHelper, BillOfMaterialItemFluentHelper, BPContactToAddressFluentHelper, BPContactToFuncAndDeptFluentHelper, BuPaAddressUsageFluentHelper, BuPaIdentificationFluentHelper, BusinessAreaFluentHelper, BusinessAreaTextFluentHelper, BusinessPartnerAddressFluentHelper, BusinessPartnerBankFluentHelper, BusinessPartnerContactFluentHelper, BusinessPartnerFluentHelper, BusinessPartnerRoleFluentHelper, BusinessPartnerTaxNumberFluentHelper, C_BehqueuedataFluentHelper, ChangeMasterAltDateFluentHelper, ChangeMasterCharcFluentHelper, ChangeMasterCharcValueFluentHelper, ChangeMasterClassCharcFluentHelper, ChangeMasterClassFluentHelper, ChangeMasterFluentHelper, ChangeMasterObjTypeAssgmtFluentHelper, ChangeMstrObjectMgmtRecordFluentHelper, ChangeMstrObMgReDocInfoRecdFluentHelper, ChangeMstrObMgReMaterialFluentHelper, ChangeMstrObMgReMatlBOMFluentHelper, ChangeRecordFluentHelper, ChangeRecordReferenceBitFluentHelper, ChangeRecordReferenceBOMFluentHelper, ChangeRecordReferenceDocFluentHelper, ChangeRecordReferenceMatFluentHelper, ChartOfAccountsFluentHelper, ChartOfAccountsTextFluentHelper, ClfnCharacteristicForKeyDateFluentHelper, ClfnCharcDescForKeyDateFluentHelper, ClfnCharcRefForKeyDateFluentHelper, ClfnCharcRstrcnForKeyDateFluentHelper, ClfnCharcValueDescForKeyDateFluentHelper, ClfnCharcValueForKeyDateFluentHelper, ClfnClassCharcForKeyDateFluentHelper, ClfnClassDescForKeyDateFluentHelper, ClfnClassForKeyDateFluentHelper, ClfnClassForKeyDateFluentHelper, ClfnClassKeywordForKeyDateFluentHelper, ClfnClassTextForKeyDateFluentHelper, ClfnProductFluentHelper, CompanyCodeFluentHelper, CompanyCodeFluentHelper, CompanyCodeFluentHelper, CompanyCodeFluentHelper, ComparisonResultFluentHelper, ControllingAreaFluentHelper, ControllingDebitCreditCodeFluentHelper, ControllingDebitCreditCodeTFluentHelper, CostCenterActivityTypeFluentHelper, CostCenterActivityTypeTextFluentHelper, CostCenterFluentHelper, CostCenterFluentHelper, CostCenterFluentHelper, CostCenterFluentHelper, CostCenterTextFluentHelper, CostCenterTextFluentHelper, CountryFluentHelper, CountryTextFluentHelper, CreditMemoReqItemPartnerFluentHelper, CreditMemoReqItemPrcgElmntFluentHelper, CreditMemoReqPartnerFluentHelper, CreditMemoReqPrcgElmntFluentHelper, CreditMemoRequestFluentHelper, CreditMemoRequestItemFluentHelper, CustomerCompanyFluentHelper, CustomerDunningFluentHelper, CustomerFluentHelper, CustomerGroupFluentHelper, CustomerGroupTextFluentHelper, CustomerMaterialFluentHelper, CustomerReturnFluentHelper, CustomerReturnItemFluentHelper, CustomerReturnItemPartnerFluentHelper, CustomerReturnItemPrcgElmntFluentHelper, CustomerReturnPartnerFluentHelper, CustomerReturnPrcgElmntFluentHelper, CustomerReturnProcessStepFluentHelper, CustomerReturnScheduleLineFluentHelper, CustomerSalesAreaFluentHelper, CustomerSalesAreaTaxFluentHelper, CustomerSupplierIndustryFluentHelper, CustomerSupplierIndustryTextFluentHelper, CustomerWithHoldingTaxFluentHelper, CustSalesPartnerFuncFluentHelper, DebitMemoReqItemPartnerFluentHelper, DebitMemoReqItemPrcgElmntFluentHelper, DebitMemoReqPartnerFluentHelper, DebitMemoReqPrcgElmntFluentHelper, DebitMemoRequestFluentHelper, DebitMemoRequestItemFluentHelper, DefectCategoryFluentHelper, DefectCategoryTextFluentHelper, DefectClassFluentHelper, DefectClassTextFluentHelper, DefectCodeFluentHelper, DefectCodeGroupFluentHelper, DefectCodeGroupTextFluentHelper, DefectCodeTextFluentHelper, DefectFluentHelper, DistributionChannelFluentHelper, DistributionChannelTextFluentHelper, DivisionFluentHelper, DivisionTextFluentHelper, DocInfoRecdObjLinkProductFluentHelper, DocumentInfoRecordDescFluentHelper, DocumentInfoRecordDocStsVHFluentHelper, DocumentInfoRecordFluentHelper, EnterpriseProjectFluentHelper, FinPlanningEntryItemFluentHelper, FunctionalAreaFluentHelper, FunctionalAreaTextFluentHelper, GLAccountFluentHelper, GLAccountInChartOfAccountsFluentHelper, GLAccountTextFluentHelper, I_BusinessObjectKeysFluentHelper, I_BusObjectsFluentHelper, InbDeliveryDocFlowFluentHelper, InbDeliveryHeaderFluentHelper, InbDeliveryItemFluentHelper, InspectionCharacteristicFluentHelper, InspectionLotFluentHelper, InspectionLotWithStatusFluentHelper, InspectionMethodFluentHelper, InspectionOperationFluentHelper, InspectionResultFluentHelper, InspectionSpecificationFluentHelper, InspLotUsageDecisionFluentHelper, InternalOrderFluentHelper, JobTemplateFluentHelper, JournalEntryItemBasicFluentHelper, LedgerFluentHelper, LedgerFluentHelper, LedgerTextFluentHelper, LegalTransactionFluentHelper, LglTransCategoryFluentHelper, LglTransCategoryGroupFluentHelper, LglTransDateFluentHelper, LglTransEntityFluentHelper, LglTransExternalContactFluentHelper, LglTransInternalContactFluentHelper, LglTransLinkedObjectsFluentHelper, LglTransParentCategoryFluentHelper, LglTransRelationshipFluentHelper, MaintainYearsPeriodFluentHelper, MaterialDocumentHeaderFluentHelper, MaterialDocumentItemFluentHelper, MaterialStockFluentHelper, MatlStkInAcctModFluentHelper, MRPMaterialFluentHelper, ODataQueryAdditionalMetadataFluentHelper, OperationalAcctgDocItemCubeFluentHelper, OutbDeliveryDocFlowFluentHelper, OutbDeliveryHeaderFluentHelper, OutbDeliveryItemFluentHelper, PartnerCompanyFluentHelper, PhysInventoryDocHeaderFluentHelper, PhysInventoryDocItemFluentHelper, PlanDataFluentHelper, PlannedOrderComponentFluentHelper, PlannedOrderFluentHelper, PlanningCategoryFluentHelper, PlanningCategoryTextFluentHelper, ProcessOrderComponentFluentHelper, ProcessOrderFluentHelper, ProcessOrderItemFluentHelper, ProcessOrderOperationFluentHelper, ProcessOrderStatusFluentHelper, ProcOrdConfirmationFluentHelper, ProdAllocationObjectFluentHelper, ProdAllocationObjectTFluentHelper, ProdAllocationSequenceFluentHelper, ProdAllocCharcMetaDataFluentHelper, ProdAllocCharcValCombnFluentHelper, ProdAllocObjTimeSeriesFluentHelper, ProdAllocSequenceTFluentHelper, ProdAllocSqncAssgmtFluentHelper, ProductBasicTextFluentHelper, ProductCharcFluentHelper, ProductCharcValueFluentHelper, ProductClassCharcFluentHelper, ProductClassFluentHelper, ProductDescriptionFluentHelper, ProductDescriptionFluentHelper, ProductDescriptionFluentHelper, ProductDescriptionFluentHelper, ProductFluentHelper, ProductFluentHelper, ProductFluentHelper, ProductGroupFluentHelper, ProductGroupTextFluentHelper, ProductInspectionTextFluentHelper, ProductionOrderComponentFluentHelper, ProductionOrderConfFluentHelper, ProductionOrderFluentHelper, ProductionOrderItemFluentHelper, ProductionOrderOperationFluentHelper, ProductionOrderStatusFluentHelper, ProductionRsceToolsFluentHelper, ProductPlantCostingFluentHelper, ProductPlantFluentHelper, ProductPlantFluentHelper, ProductPlantFluentHelper, ProductPlantFluentHelper, ProductPlantForecastingFluentHelper, ProductPlantIntlTrdFluentHelper, ProductPlantProcurementFluentHelper, ProductPlantProcurementFluentHelper, ProductPlantQualityMgmtFluentHelper, ProductPlantSalesFluentHelper, ProductPlantStorageFluentHelper, ProductPlantTextFluentHelper, ProductProcurementFluentHelper, ProductPurchaseTextFluentHelper, ProductQualityMgmtFluentHelper, ProductSalesDeliveryFluentHelper, ProductSalesDeliveryFluentHelper, ProductSalesDeliveryFluentHelper, ProductSalesDeliveryFluentHelper, ProductSalesFluentHelper, ProductSalesTaxFluentHelper, ProductSalesTaxFluentHelper, ProductSalesTextFluentHelper, ProductStorageFluentHelper, ProductStorageLocationFluentHelper, ProductStorageLocationFluentHelper, ProductStorageLocationFluentHelper, ProductStorageLocationFluentHelper, ProductSupplyPlanningFluentHelper, ProductSupplyPlanningFluentHelper, ProductUnitsOfMeasureEANFluentHelper, ProductUnitsOfMeasureFluentHelper, ProductWorkSchedulingFluentHelper, ProductWorkSchedulingFluentHelper, ProfitCenterFluentHelper, ProfitCenterFluentHelper, ProfitCenterFluentHelper, ProfitCenterTextFluentHelper, ProjectFluentHelper, PurchaseContractFluentHelper, PurchaseContractItemFluentHelper, PurchaseOrderFluentHelper, PurchaseOrderItemFluentHelper, PurchaseOrderScheduleLineFluentHelper, PurchaseRequisitionHeaderFluentHelper, PurchaseRequisitionItemFluentHelper, PurchasingInfoRecordFluentHelper, PurchasingQuotaArrangementFluentHelper, PurchasingSourceFluentHelper, PurCtrAccountFluentHelper, PurCtrAddressFluentHelper, PurCtrPartnersFluentHelper, PurgCatDescriptionFluentHelper, PurgCatFluentHelper, PurgCatMaterialGroupFluentHelper, PurgCatMemberFluentHelper, PurgCatPlannedSpendFluentHelper, PurgCatPurchaserResponsibleFluentHelper, PurgCatSupplierFluentHelper, PurgCatTranslationStatusFluentHelper, PurgInfoRecdOrgPlantDataFluentHelper, PurgQuotaArrangementItemFluentHelper, PurOrdAccountAssignmentFluentHelper, PurOrdPricingElementFluentHelper, PurReqAddDeliveryFluentHelper, PurReqnAcctAssgmtFluentHelper, RawSubstanceFluentHelper, RealSubstanceFluentHelper, RecipeCharcFluentHelper, RecipeCharcValueFluentHelper, RecipeClassCharcFluentHelper, RecipeClassFluentHelper, RecipeFluentHelper, RecipeFormulaItemFluentHelper, RecipeTextFluentHelper, RequestForQuotationBidderFluentHelper, RequestForQuotationFluentHelper, RequestForQuotationItemFluentHelper, ReturnsDeliveryDocFlowFluentHelper, ReturnsDeliveryHeaderFluentHelper, ReturnsDeliveryItemFluentHelper, SalesContractFluentHelper, SalesContractItemFluentHelper, SalesContractItemPartnerFluentHelper, SalesContractItemPrcgElmntFluentHelper, SalesContractPartnerFluentHelper, SalesContractPrcgElmntFluentHelper, SalesDistrictFluentHelper, SalesDistrictTextFluentHelper, SalesInquiryFluentHelper, SalesInquiryItemFluentHelper, SalesInquiryItemPartnerFluentHelper, SalesInquiryItemPrcgElmntFluentHelper, SalesInquiryPartnerFluentHelper, SalesInquiryPrcgElmntFluentHelper, SalesOrderFluentHelper, SalesOrderHeaderPartnerFluentHelper, SalesOrderHeaderPrElementFluentHelper, SalesOrderItemFluentHelper, SalesOrderItemPartnerFluentHelper, SalesOrderItemPrElementFluentHelper, SalesOrderScheduleLineFluentHelper, SalesOrganizationFluentHelper, SalesOrganizationTextFluentHelper, SalesQuotationFluentHelper, SalesQuotationItemFluentHelper, SalesQuotationItemPartnerFluentHelper, SalesQuotationItemPrcgElmntFluentHelper, SalesQuotationPartnerFluentHelper, SalesQuotationPrcgElmntFluentHelper, SchAgrmtAcCntFluentHelper, SchAgrmtHeaderFluentHelper, SchAgrmtItemFluentHelper, SchAgrmtPartnerFluentHelper, SchAgrmtSchLineFluentHelper, SegmentFluentHelper, SegmentTextFluentHelper, ServiceEntrySheetFluentHelper, ServiceEntrySheetItemFluentHelper, SpecAssignedMatlForKeyDateFluentHelper, SpecAssignedMatlForKeyDateFluentHelper, SpecAuthorizationGroupTextFluentHelper, SpecAuthorizationGroupTextFluentHelper, SpecCharByValueAssgmtInstFluentHelper, SpecCharByValueAssgmtInstFluentHelper, SpecIdentifierFluentHelper, SpecIdentifierFluentHelper, SpecStatusAttributesFluentHelper, SpecStatusAttributesFluentHelper, SpecStatusNextStatusFluentHelper, SpecStatusNextStatusFluentHelper, SpecStatusSchemaFluentHelper, SpecStatusSchemaFluentHelper, SpecValAssgmtInstanceWthCompFluentHelper, SpecValAssgmtInstanceWthCompFluentHelper, SrvcEntrShtAcctAssignmentFluentHelper, StatisticalKeyFigureFluentHelper, StatisticalKeyFigureTextFluentHelper, SubscriptionMaintainFluentHelper, SubscriptionReadFluentHelper, SuplrActyDescriptionFluentHelper, SuplrActyParticipantFluentHelper, SuplrActyPurchaserRespFluentHelper, SuplrActySupplierFluentHelper, SuplrActyTskActyReferenceFluentHelper, SuplrActyTskCommTextFluentHelper, SuplrActyTskDescriptionFluentHelper, SuplrActyTskMessageTextFluentHelper, SuplrActyTskProcessorFluentHelper, SuplrActyTskPurchaserRespFluentHelper, SuplrActyTskSupplierFluentHelper, SuplrEvalRspAppraiserFluentHelper, SuplrEvalRspExplTextFluentHelper, SuplrEvalRspExternalNameFluentHelper, SuplrEvalRspIntroductionFluentHelper, SuplrEvalRspLanguageFluentHelper, SuplrEvalRspPurchaserRespFluentHelper, SuplrEvalRspQuestionFluentHelper, SuplrEvalRspQuestionTextFluentHelper, SuplrEvalRspRootQnaireFluentHelper, SuplrEvalRspSectionFluentHelper, SuplrEvalRspSectionTextFluentHelper, SuplrEvalRspStrucQnaireFluentHelper, SuplrEvalRspSupplierFluentHelper, SuplrEvalSccrdPurchaserRespFluentHelper, SuplrEvalSccrdQuestionFluentHelper, SuplrEvalSccrdSectionFluentHelper, SuplrEvalSccrdStrucQnaireFluentHelper, SuplrEvalSccrdSupplierFluentHelper, SuplrEvalScorecardFluentHelper, SuplrEvalScorecardRootQnaireFluentHelper, SuplrInvcItemPurOrdRefFluentHelper, SupplierActivityFluentHelper, SupplierActivityTaskFluentHelper, SupplierCompanyFluentHelper, SupplierDunningFluentHelper, SupplierEvaluationResponseFluentHelper, SupplierFluentHelper, SupplierInvoiceFluentHelper, SupplierInvoiceItemGLAcctFluentHelper, SupplierInvoiceTaxFluentHelper, SupplierPartnerFuncFluentHelper, SupplierPurchasingOrgFluentHelper, SupplierQuotationFluentHelper, SupplierQuotationItemFluentHelper, SupplierWithHoldingTaxFluentHelper, SupplyDemandItemFluentHelper, TimeOverviewFluentHelper, TimeSheetEntryFluentHelper, WorkCenterCapacityFluentHelper, WorkCenterDayOperationFluentHelper, WorkCenterPipeLineOperationFluentHelper, WorkCentersFluentHelper, WorkItemFluentHelper, WorkpackageFluentHelper

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

Constructor Summary

Constructors

Constructor and Description
FluentHelperRead()

Method Summary

Modifier and Type	Method and Description
List<EntityT>	execute(ErpEndpoint erpEndpoint) Executes the underlying query using the stored values, plus any query modifiers that were previously called.
FluentHelperT	filter(ExpressionFluentHelper<EntityT> expression) Query modifier to restrict the set of returned entities based on the values of one or more fields.
FluentHelperT	orderBy(EntityField<EntityT,?> field, Order order) Query modifier to sort the set of returned entities by one or more fields.
FluentHelperT	select(SelectableT... fields) Query modifier to limit which field values of the entity get fetched and populated, and to specify which navigation properties to expand.
FluentHelperT	skip(Number skip) Query modifier to not return the first N entities of the result set.
FluentHelperT	top(Number top) Query modifier to limit the number of entities returned.
com.sap.cloud.sdk.odatav2.connectivity.ODataQuery	toQuery() Provides access to the underlying Query object for inspection and logging purposes.
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

FluentHelperRead

public FluentHelperRead()

Method Detail

select

public FluentHelperT select(SelectableT... fields)

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

Parameters:

fields - Fields to select and/or navigation properties to expand.

Returns:

The same fluent helper with this query modifier applied.

orderBy

public FluentHelperT orderBy(EntityField<EntityT,?> field,
                             Order order)

Query modifier to sort the set of returned entities by one or more fields. If this method is called more than once, then the result entity set will be sorted by each field in the order that the methods were called.

Parameters:

field - Field to sort by.

order - Sorting direction to use (ascending or descending).

Returns:

The same fluent helper with this query modifier applied.

top

public FluentHelperT top(@NonNull
                         Number top)

Query modifier to limit the number of entities returned. If this method is never called, then the result entity list will not be limited in size. If this method is called multiple times, then only the value of the last call will be used.

Parameters:

top - Number of entities to limit the result set to.

Returns:

The same fluent helper with this query modifier applied.

skip

public FluentHelperT skip(@NonNull
                          Number skip)

Query modifier to not return the first N entities of the result set. If this method is never called, then the full list will be returned from the first entity. If this method is called multiple times, then only the value of the last call will be used.

Parameters:

skip - Number of entities to skip by.

Returns:

The same fluent helper with this query modifier applied.

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.

toQuery

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

Provides access to the underlying Query object for inspection and logging purposes.

Returns:

The underlying query object.

execute

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

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

Specified by:

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

Parameters:

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

Returns:

A single result elements if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown.

Throws:

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

See Also:

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

filter

public FluentHelperT filter(ExpressionFluentHelper<EntityT> expression)

Query modifier to restrict the set of returned entities based on the values of one or more fields. If this method is never called, then all accessible entities will be fetched. Calling this multiple times will combine the filters into one that is the intersection of all filters (filter1 AND filter2 AND ... filterN).

Parameters:

expression - Fluent helper that represents a field value expression. To create this, start with an EntityField constant in your respective entity type for the desired entity field. Then call one of the comparison operators and provide a comparison value. Optionally the resulting fluent helper can be chained with other expression fluent helpers.

Returns:

The same fluent helper with this query modifier applied.