EntityField (SAP S/4HANA Cloud SDK - Parent POM 2.5.0 API)

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.helper.EntityField<EntityT,FieldT>

Type Parameters:

EntityT - VdmObject that the field belongs to

FieldT - Field type

All Implemented Interfaces:

EntitySelectable<EntityT>

Direct Known Subclasses:

AddressEmailAddressField, AddressFaxNumberField, AddressHomePageURLField, AddressPhoneNumberField, AttachmentContentField, BehqueuedataField, BillingDocReqItemPartnerField, BillingDocReqItemPrcgElmntField, BillingDocReqPartnerField, BillingDocReqPrcgElmntField, BillingDocumentField, BillingDocumentItemField, BillingDocumentItemPartnerField, BillingDocumentItemPrcgElmntField, BillingDocumentPartnerField, BillingDocumentPrcgElmntField, BillingDocumentRequestField, BillingDocumentRequestItemField, BillOfMaterialField, BillOfMaterialItemField, BillOfMaterialUsageField, BillOfMaterialUsageTextField, BOMItemCategoryField, BOMItemCategoryTextField, BOMWhereUsedField, BPContactToAddressField, BPContactToFuncAndDeptField, BuPaAddressUsageField, BuPaIdentificationField, BusinessAreaField, BusinessAreaTextField, BusinessObjectKeysField, BusinessPartnerAddressField, BusinessPartnerBankField, BusinessPartnerContactField, BusinessPartnerField, BusinessPartnerRoleField, BusinessPartnerTaxNumberField, BusObjectsField, CentralPurchaseContractField, ChangeMasterAltDateField, ChangeMasterCharcField, ChangeMasterCharcValueField, ChangeMasterClassCharcField, ChangeMasterClassField, ChangeMasterField, ChangeMasterObjTypeAssgmtField, ChangeMstrObjectMgmtRecordField, ChangeMstrObMgReDocInfoRecdField, ChangeMstrObMgReMaterialField, ChangeMstrObMgReMatlBOMField, ChartOfAccountsField, ChartOfAccountsTextField, ClfnCharacteristicForKeyDateField, ClfnCharcDescForKeyDateField, ClfnCharcRefForKeyDateField, ClfnCharcRstrcnForKeyDateField, ClfnCharcValueDescForKeyDateField, ClfnCharcValueForKeyDateField, ClfnClassCharcForKeyDateField, ClfnClassDescForKeyDateField, ClfnClassForKeyDateField, ClfnClassForKeyDateField, ClfnClassKeywordForKeyDateField, ClfnClassTextForKeyDateField, ClfnProductField, CntrlPurchaseContractItemField, CntrlPurContrDistrMessagesField, CntrlPurContrItmDistributionField, CompanyCodeField, CompanyCodeField, CompanyCodeField, CompanyCodeField, ComparisonResultField, ControllingAreaField, ControllingDebitCreditCodeField, ControllingDebitCreditCodeTField, CostCenterActivityTypeField, CostCenterActivityTypeTextField, CostCenterField, CostCenterField, CostCenterField, CostCenterField, CostCenterTextField, CostCenterTextField, CountryField, CountryTextField, CreditBlockedDeliveryDocField, CreditBlockedSalesDocumentField, CreditMemoReqItemPartnerField, CreditMemoReqItemPrcgElmntField, CreditMemoReqPartnerField, CreditMemoReqPrcgElmntField, CreditMemoRequestField, CreditMemoRequestItemField, CustomerCompanyField, CustomerDunningField, CustomerField, CustomerGroupField, CustomerGroupTextField, CustomerMaterialField, CustomerReturnField, CustomerReturnItemField, CustomerReturnItemPartnerField, CustomerReturnItemPrcgElmntField, CustomerReturnPartnerField, CustomerReturnPrcgElmntField, CustomerReturnProcessStepField, CustomerReturnScheduleLineField, CustomerSalesAreaField, CustomerSalesAreaTaxField, CustomerSupplierIndustryField, CustomerSupplierIndustryTextField, CustomerWithHoldingTaxField, CustSalesPartnerFuncField, DebitMemoReqItemPartnerField, DebitMemoReqItemPrcgElmntField, DebitMemoReqPartnerField, DebitMemoReqPrcgElmntField, DebitMemoRequestField, DebitMemoRequestItemField, DefectCategoryField, DefectCategoryTextField, DefectClassField, DefectClassTextField, DefectCodeField, DefectCodeGroupField, DefectCodeGroupTextField, DefectCodeTextField, DefectField, DemandField, DistributionChannelField, DistributionChannelTextField, DivisionField, DivisionTextField, DocInfoRecdObjLinkBOMField, DocInfoRecdObjLinkChgRecdField, DocInfoRecdObjLinkProductField, DocumentInfoRecordAttchField, DocumentInfoRecordCharcField, DocumentInfoRecordCharcValueField, DocumentInfoRecordClassCharcField, DocumentInfoRecordClassField, DocumentInfoRecordDescField, DocumentInfoRecordDocStsVHField, DocumentInfoRecordField, EnterpriseProjectField, FinPlanningEntryItemField, FuncImpReturnField, FunctionalAreaField, FunctionalAreaTextField, GLAccountField, GLAccountInChartOfAccountsField, GLAccountTextField, InbDeliveryAddressField, InbDeliveryDocFlowField, InbDeliveryHeaderField, InbDeliveryItemField, InbDeliveryPartnerField, InbDeliverySerialNmbrField, InspectionCharacteristicField, InspectionLotField, InspectionLotWithStatusField, InspectionMethodField, InspectionOperationField, InspectionResultField, InspectionResultValueField, InspectionSpecificationField, InspLotUsageDecisionField, JobScheduleStatusField, JobTemplateField, JournalEntryItemBasicField, KanbanContainerField, KanbanControlCycleField, KanbanCtnDetailedQtyField, KanbanDeliveryField, LedgerField, LedgerField, LedgerTextField, LegalDocumentField, LegalTransactionField, LglDocStampField, LglTransCategoryField, LglTransCategoryGroupField, LglTransDateField, LglTransEntityField, LglTransExternalContactField, LglTransInternalContactField, LglTransLinkedObjectsField, LglTransParentCategoryField, LglTransRelationshipField, MaintainYearsPeriodField, MaintenanceItemObjectField, MaintenanceItemObjListField, MaterialCoverageField, MaterialDocumentHeaderField, MaterialDocumentItemField, MaterialStockField, MaterialValuationField, MatlStkInAcctModField, MRPMaterialField, ODataQueryAdditionalMetadataField, OperationalAcctgDocItemCubeField, OutbDeliveryAddressField, OutbDeliveryDocFlowField, OutbDeliveryHeaderField, OutbDeliveryItemField, OutbDeliveryPartnerField, PartnerCompanyField, PhysInventoryDocHeaderField, PhysInventoryDocItemField, PlanDataField, PlannedIndepRqmtField, PlannedIndepRqmtItemField, PlannedOrderComponentField, PlannedOrderField, PlanningCategoryField, PlanningCategoryTextField, ProcessOrderComponentField, ProcessOrderField, ProcessOrderItemField, ProcessOrderOperationField, ProcessOrderStatusField, ProcOrdConfirmationField, ProdAllocationObjectField, ProdAllocationObjectTField, ProdAllocationSequenceField, ProdAllocCharcMetaDataField, ProdAllocCharcValCombnField, ProdAllocObjTimeSeriesField, ProdAllocSequenceTField, ProdAllocSqncAssgmtField, ProductBasicTextField, ProductCharcField, ProductCharcValueField, ProductClassCharcField, ProductClassField, ProductDescriptionField, ProductDescriptionField, ProductDescriptionField, ProductDescriptionField, ProductField, ProductField, ProductField, ProductGroupField, ProductGroupTextField, ProductInspectionTextField, ProductionOrderComponentField, ProductionOrderConfField, ProductionOrderField, ProductionOrderItemField, ProductionOrderOperationField, ProductionOrderStatusField, ProductionRsceToolsField, ProductionSupplyAreaField, ProductionSupplyAreaTextField, ProductPlantCostingField, ProductPlantField, ProductPlantField, ProductPlantField, ProductPlantField, ProductPlantForecastingField, ProductPlantIntlTrdField, ProductPlantMRPAreaField, ProductPlantProcurementField, ProductPlantProcurementField, ProductPlantQualityMgmtField, ProductPlantSalesField, ProductPlantStorageField, ProductPlantTextField, ProductProcurementField, ProductPurchaseTextField, ProductQualityMgmtField, ProductSalesDeliveryField, ProductSalesDeliveryField, ProductSalesDeliveryField, ProductSalesDeliveryField, ProductSalesField, ProductSalesTaxField, ProductSalesTaxField, ProductSalesTextField, ProductStorageField, ProductStorageLocationField, ProductStorageLocationField, ProductStorageLocationField, ProductStorageLocationField, ProductSupplyPlanningField, ProductSupplyPlanningField, ProductUnitsOfMeasureEANField, ProductUnitsOfMeasureField, ProductWorkSchedulingField, ProductWorkSchedulingField, ProfitCenterField, ProfitCenterField, ProfitCenterField, ProfitCenterTextField, ProjectField, ProjectField, ProjectField, PurchaseContractField, PurchaseContractItemField, PurchaseOrderField, PurchaseOrderItemField, PurchaseOrderScheduleLineField, PurchaseRequisitionHeaderField, PurchaseRequisitionItemField, PurchasingInfoRecordField, PurchasingQuotaArrangementField, PurchasingSourceField, PurCtrAccountField, PurCtrAddressField, PurCtrPartnersField, PurgCatDescriptionField, PurgCatField, PurgCatMaterialGroupField, PurgCatMemberField, PurgCatPlannedSpendField, PurgCatPurchaserResponsibleField, PurgCatSupplierField, PurgCatTranslationStatusField, PurgInfoRecdOrgPlantDataField, PurgPrcgCndnTypeTextField, PurgPrcgCndnTypeTextField, PurgPrcgProcedItemTextField, PurgPricingConditionTypeField, PurgPricingConditionTypeField, PurgPricingProcedureField, PurgPricingProcedureItemField, PurgPricingProcedureTextField, PurgQuotaArrangementItemField, PurOrdAccountAssignmentField, PurOrdPricingElementField, PurReqAddDeliveryField, PurReqnAcctAssgmtField, RawSubstanceField, RealSubstanceField, RecipeCharcField, RecipeCharcValueField, RecipeClassCharcField, RecipeClassField, RecipeField, RecipeFormulaItemField, RecipeProcessElementField, RecipeProcessElementTextField, RecipeProcessEquipRqmtField, RecipeProcessEquipRqmtTextField, RecipeProcessParamField, RecipeProcessParamValueField, RecipeProcessParamValueTxtField, RecipeTextField, RecProcEquipRqmtCharcField, RecProcEquipRqmtCharcValueField, RecProcEquipRqmtClassCharcField, RecProcEquipRqmtClassField, RecProcParamValCharcField, RecProcParamValCharcValueField, RecProcParamValClassCharcField, RecProcParamValClassField, ReleaseMessageField, RequestForQuotationBidderField, RequestForQuotationField, RequestForQuotationItemField, ReservationDocumentHeaderField, ReservationDocumentItemField, ReturnsDeliveryAddressField, ReturnsDeliveryDocFlowField, ReturnsDeliveryHeaderField, ReturnsDeliveryItemField, ReturnsDeliveryMaintObjField, ReturnsDeliveryPartnerField, ReturnsDeliverySrlNmbrField, SalesContractField, SalesContractItemField, SalesContractItemPartnerField, SalesContractItemPrcgElmntField, SalesContractPartnerField, SalesContractPrcgElmntField, SalesDistrictField, SalesDistrictTextField, SalesDocumentRjcnReasonField, SalesDocumentRjcnReasonField, SalesInquiryField, SalesInquiryItemField, SalesInquiryItemPartnerField, SalesInquiryItemPrcgElmntField, SalesInquiryPartnerField, SalesInquiryPrcgElmntField, SalesOrderField, SalesOrderHeaderPartnerField, SalesOrderHeaderPrElementField, SalesOrderItemField, SalesOrderItemPartnerField, SalesOrderItemPrElementField, SalesOrderScheduleLineField, SalesOrderWithoutChargeField, SalesOrderWithoutChargeItemField, SalesOrganizationField, SalesOrganizationTextField, SalesQuotationField, SalesQuotationItemField, SalesQuotationItemPartnerField, SalesQuotationItemPrcgElmntField, SalesQuotationPartnerField, SalesQuotationPrcgElmntField, SchAgrmtAcCntField, SchAgrmtHeaderField, SchAgrmtItemField, SchAgrmtPartnerField, SchAgrmtSchLineField, SegmentField, SegmentTextField, SerialNmbrDeliveryField, ServiceEntrySheetField, ServiceEntrySheetItemField, SkillTagField, SlsOrdWthoutChrgItmPartnerField, SlsOrdWthoutChrgPartnerField, SlsOrdWthoutChrgSchedLineField, SlsPrcgCndnTypeTextField, SlsPrcgCndnTypeTextField, SlsPrcgProcedItemTextField, SlsPricingConditionTypeField, SlsPricingConditionTypeField, SlsPricingProcedureField, SlsPricingProcedureItemField, SlsPricingProcedureTextField, SpecAssignedMatlForKeyDateField, SpecAssignedMatlForKeyDateField, SpecAuthorizationGroupTextField, SpecAuthorizationGroupTextField, SpecCharByValueAssgmtInstField, SpecCharByValueAssgmtInstField, SpecIdentifierField, SpecIdentifierField, SpecStatusAttributesField, SpecStatusAttributesField, SpecStatusNextStatusField, SpecStatusNextStatusField, SpecStatusSchemaField, SpecStatusSchemaField, SpecValAssgmtInstanceWthCompField, SpecValAssgmtInstanceWthCompField, SrvcEntrShtAcctAssignmentField, StaffingDataField, StatisticalKeyFigureField, StatisticalKeyFigureTextField, SubscriptionMaintainField, SubscriptionReadField, SuplrActyDescriptionField, SuplrActyParticipantField, SuplrActyPurchaserRespField, SuplrActySupplierField, SuplrActyTskActyReferenceField, SuplrActyTskCommTextField, SuplrActyTskDescriptionField, SuplrActyTskMessageTextField, SuplrActyTskProcessorField, SuplrActyTskPurchaserRespField, SuplrActyTskSupplierField, SuplrEvalRspAppraiserField, SuplrEvalRspExplTextField, SuplrEvalRspExternalNameField, SuplrEvalRspIntroductionField, SuplrEvalRspLanguageField, SuplrEvalRspPurchaserRespField, SuplrEvalRspQuestionField, SuplrEvalRspQuestionTextField, SuplrEvalRspRootQnaireField, SuplrEvalRspSectionField, SuplrEvalRspSectionTextField, SuplrEvalRspStrucQnaireField, SuplrEvalRspSupplierField, SuplrEvalSccrdPurchaserRespField, SuplrEvalSccrdQuestionField, SuplrEvalSccrdSectionField, SuplrEvalSccrdStrucQnaireField, SuplrEvalSccrdSupplierField, SuplrEvalScorecardField, SuplrEvalScorecardRootQnaireField, SuplrInvcHeaderWhldgTaxField, SuplrInvcItemPurOrdRefField, SupplierActivityField, SupplierActivityTaskField, SupplierCompanyField, SupplierDunningField, SupplierEvaluationResponseField, SupplierField, SupplierInvoiceField, SupplierInvoiceItemGLAcctField, SupplierInvoiceTaxField, SupplierOplScoresAVParametersField, SupplierOplScoresAVResultField, SupplierPartnerFuncField, SupplierPurchasingOrgField, SupplierQuotationField, SupplierQuotationItemField, SupplierWithHoldingTaxField, SupplyDemandItemField, TimeOverviewField, TimeSheetEntryField, TRIALBALANCEParametersField, TRIALBALANCEResultField, TrsyPosFlowField, TrsyPostgJrnlEntrItmField, WorkCenterAllCapacityField, WorkCenterCapacityField, WorkCenterCapacityIntervalField, WorkCenterCapacityShiftField, WorkCenterCapDayOpField, WorkCenterCapOrderPerBucketField, WorkCenterCapOrderPerBucketParametersField, WorkCenterCapPerBucketField, WorkCenterCapPerBucketParametersField, WorkCenterCapPplineOpField, WorkCenterDayOperationField, WorkCenterPipeLineOperationField, WorkCentersField, WorkItemField, WorkItemField, WorkpackageField, WorkPackageField
```
public class EntityField<EntityT,FieldT>
extends Object
implements EntitySelectable<EntityT>
```
Template class to represent entity fields. Instances of this object are used in query modifier methods of the entity fluent helpers. Contains methods to compare a field's value with a provided value. Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying OData field names, so use the constructor with caution.

Constructor Summary

Constructors
Constructor and Description
`EntityField(String fieldName)` Use the constants declared in each entity inner class.
`EntityField(String fieldName, TypeConverter<FieldT,?> typeConverter)` Use the constants declared in each entity inner class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canEqual(Object other)`
`ExpressionFluentHelper<EntityT>`	`eq(FieldT value)` Equals expression fluent helper.
`boolean`	`equals(Object o)`
`ExpressionFluentHelper<EntityT>`	`ge(FieldT value)` Greater than or equals expression fluent helper.
`String`	`getFieldName()`
`List<String>`	`getSelections()`
`TypeConverter<FieldT,?>`	`getTypeConverter()`
`ExpressionFluentHelper<EntityT>`	`gt(FieldT value)` Greater than expression fluent helper.
`int`	`hashCode()`
`ExpressionFluentHelper<EntityT>`	`le(FieldT value)` Less than or equals expression fluent helper.
`ExpressionFluentHelper<EntityT>`	`lt(FieldT value)` Less than expression fluent helper.
`ExpressionFluentHelper<EntityT>`	`ne(FieldT value)` Not equals expression fluent helper.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EntityField
```
public EntityField(@Nonnull
                   String fieldName)
```
    Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying OData field names, so use with caution.
    
    Parameters:
    
    fieldName - OData field name. Must match the field returned by the underlying OData service.
  - EntityField
```
public EntityField(@Nonnull
                   String fieldName,
                   @Nullable
                   TypeConverter<FieldT,?> typeConverter)
```
    Use the constants declared in each entity inner class. Instantiating directly requires knowing the underlying OData field names, so use with caution. When creating instances for custom fields, this constructor can be used to add a type converter that will be automatically used by the respective entity when getting or setting custom fields.
    
    Parameters:
    
    fieldName - OData field name. Must match the field returned by the underlying OData service.
    
    typeConverter - An implementation of a TypeConverter. The first type must match FieldT, the second type must match the type Olingo returns.
- Method Detail
  - eq
```
@Nonnull
public ExpressionFluentHelper<EntityT> eq(@Nullable
                                                   FieldT value)
```
    Equals expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field == value expression.
  - ne
```
@Nonnull
public ExpressionFluentHelper<EntityT> ne(@Nullable
                                                   FieldT value)
```
    Not equals expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field != value expression.
  - gt
```
@Nonnull
public ExpressionFluentHelper<EntityT> gt(@Nullable
                                                   FieldT value)
```
    Greater than expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field > value expression.
  - ge
```
@Nonnull
public ExpressionFluentHelper<EntityT> ge(@Nullable
                                                   FieldT value)
```
    Greater than or equals expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field >= value expression.
  - lt
```
@Nonnull
public ExpressionFluentHelper<EntityT> lt(@Nullable
                                                   FieldT value)
```
    Less than expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field < value expression.
  - le
```
@Nonnull
public ExpressionFluentHelper<EntityT> le(@Nullable
                                                   FieldT value)
```
    Less than or equals expression fluent helper.
    
    Parameters:
    
    value - Field value to compare with.
    
    Returns:
    
    Fluent helper that represents a field <= value expression.
  - getSelections
```
@Nonnull
public List<String> getSelections()
```
    Specified by:
    
    getSelections in interface EntitySelectable<EntityT>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFieldName
```
@Nonnull
public String getFieldName()
```
    Specified by:
    
    getFieldName in interface EntitySelectable<EntityT>
  - getTypeConverter
```
@Nullable
public TypeConverter<FieldT,?> getTypeConverter()
```

Class EntityField<EntityT,FieldT>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityField

EntityField

Method Detail

eq

ne

gt

ge

lt

le

getSelections

equals

canEqual

hashCode

getFieldName

getTypeConverter