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

Class Entity<EntityT>

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.Entity<EntityT>

Direct Known Subclasses:

AddressEmailAddress, AddressFaxNumber, AddressHomePageURL, AddressPhoneNumber, AttachmentContent, AttachmentsCount, AvailabilityRecord, BillingDocument, BillingDocumentItem, BillingDocumentItemPartner, BillingDocumentItemPrcgElmnt, BillingDocumentPartner, BillingDocumentPrcgElmnt, BillOfMaterial, BillOfMaterialItem, BPContactToAddress, BPContactToFuncAndDept, BuPaAddressUsage, BuPaIdentification, BusinessArea, BusinessAreaText, BusinessPartner, BusinessPartnerAddress, BusinessPartnerBank, BusinessPartnerContact, BusinessPartnerRole, BusinessPartnerTaxNumber, C_Behqueuedata, C_TRIALBALANCEParameters, C_TRIALBALANCEResult, CancelInvoiceExportParameters, ChangeMaster, ChangeMasterAltDate, ChangeMasterCharc, ChangeMasterCharcValue, ChangeMasterClass, ChangeMasterClassCharc, ChangeMasterObjTypeAssgmt, ChangeMstrObjectMgmtRecord, ChangeMstrObMgReDocInfoRecd, ChangeMstrObMgReMaterial, ChangeMstrObMgReMatlBOM, ChartOfAccounts, ChartOfAccountsText, ClfnCharacteristicForKeyDate, ClfnCharcDescForKeyDate, ClfnCharcRefForKeyDate, ClfnCharcRstrcnForKeyDate, ClfnCharcValueDescForKeyDate, ClfnCharcValueForKeyDate, ClfnCharcValueForKeyDate, ClfnClassCharcForKeyDate, ClfnClassDescForKeyDate, ClfnClassForKeyDate, ClfnClassForKeyDate, ClfnClassKeywordForKeyDate, ClfnClassTextForKeyDate, ClfnProduct, CompanyCode, CompanyCode, CompanyCode, CompanyCode, ComparisonResult, ControllingArea, ControllingDebitCreditCode, ControllingDebitCreditCodeT, CostCenter, CostCenter, CostCenter, CostCenter, CostCenterActivityType, CostCenterActivityTypeText, CostCenterText, CostCenterText, Country, CountryText, CreditMemoReqItemPartner, CreditMemoReqItemPrcgElmnt, CreditMemoReqPartner, CreditMemoReqPrcgElmnt, CreditMemoRequest, CreditMemoRequestItem, Customer, CustomerCompany, CustomerDunning, CustomerGroup, CustomerGroupText, CustomerMaterial, CustomerReturn, CustomerReturnItem, CustomerReturnItemPartner, CustomerReturnItemPrcgElmnt, CustomerReturnPartner, CustomerReturnPrcgElmnt, CustomerReturnScheduleLine, CustomerSalesArea, CustomerSalesAreaTax, CustomerSupplierIndustry, CustomerSupplierIndustryText, CustomerWithHoldingTax, CustSalesPartnerFunc, DebitMemoReqItemPartner, DebitMemoReqItemPrcgElmnt, DebitMemoReqPartner, DebitMemoReqPrcgElmnt, DebitMemoRequest, DebitMemoRequestItem, Defect, DefectCategory, DefectCategoryText, DefectClass, DefectClassText, DefectCode, DefectCodeGroup, DefectCodeGroupText, DefectCodeText, Demand, DistributionChannel, DistributionChannelText, Division, DivisionText, DocInfoRecdObjLinkProduct, DocumentInfoRecord, DocumentInfoRecordDesc, DocumentInfoRecordDocStsVH, DummyFunctionImportResult, FinPlanningEntryItem, FuncImpReturn, FunctionalArea, FunctionalAreaText, GLAccount, GLAccountInChartOfAccounts, GLAccountText, I_BusinessObjectKeys, I_BusObjects, InbDeliveryAddress, InbDeliveryDocFlow, InbDeliveryHeader, InbDeliveryItem, InbDeliveryPartner, InbDeliverySerialNmbr, InspectionMethod, InspectionSpecification, JobScheduleStatus, JobTemplate, JournalEntryItemBasic, Ledger, Ledger, LedgerText, LegalTransaction, LglTransCategory, LglTransCategoryGroup, LglTransDate, LglTransEntity, LglTransExternalContact, LglTransInternalContact, LglTransLinkedObjects, LglTransParentCategory, LglTransRelationship, MaintainYearsPeriod, MaintenanceItemObject, MaintenanceItemObjList, MaterialDocumentHeader, MaterialDocumentItem, MaterialStock, MaterialValuation, MatlStkInAcctMod, ODataQueryAdditionalMetadata, OperationalAcctgDocItemCube, OutbDeliveryAddress, OutbDeliveryDocFlow, OutbDeliveryHeader, OutbDeliveryItem, OutbDeliveryPartner, PartnerCompany, PhysInventoryDocHeader, PhysInventoryDocItem, PickingReport, PlanData, PlannedOrder, PlannedOrderComponent, PlanningCategory, PlanningCategoryText, PriceChangeDocument, ProcessOrder, ProcessOrderComponent, ProcessOrderItem, ProcessOrderOperation, ProcessOrderStatus, ProcOrdConfirmation, ProdAllocationObject, ProdAllocationObjectT, ProdAllocationSequence, ProdAllocCharcMetaData, ProdAllocCharcValCombn, ProdAllocObjTimeSeries, ProdAllocSequenceT, ProdAllocSqncAssgmt, Product, Product, Product, ProductCharc, ProductCharcValue, ProductClass, ProductClassCharc, ProductDescription, ProductDescription, ProductDescription, ProductDescription, ProductGroup, ProductGroupText, ProductionOrder, ProductionOrderComponent, ProductionOrderConf, ProductionOrderItem, ProductionOrderOperation, ProductionOrderStatus, ProductionRsceTools, ProductPlant, ProductPlant, ProductPlant, ProductPlant, ProductPlantProcurement, ProductPlantProcurement, ProductSalesDelivery, ProductSalesDelivery, ProductSalesDelivery, ProductSalesDelivery, ProductSalesTax, ProductSalesTax, ProductStorageLocation, ProductStorageLocation, ProductStorageLocation, ProductStorageLocation, ProductSupplyPlanning, ProductSupplyPlanning, ProductWorkScheduling, ProductWorkScheduling, ProfitCenter, ProfitCenter, ProfitCenter, ProfitCenterText, Project, Project, PurchaseContract, PurchaseContractItem, PurchaseOrder, PurchaseOrderItem, PurchaseOrderScheduleLine, PurchaseRequisitionHeader, PurchaseRequisitionItem, PurchasingInfoRecord, PurchasingQuotaArrangement, PurchasingSource, PurCtrAccount, PurCtrAddress, PurCtrPartners, PurgCat, PurgCatDescription, PurgCatMaterialGroup, PurgCatMember, PurgCatPlannedSpend, PurgCatPurchaserResponsible, PurgCatSupplier, PurgCatTranslationStatus, PurgInfoRecdOrgPlantData, PurgQuotaArrangementItem, PurOrdAccountAssignment, PurOrdPricingElement, PurReqAddDelivery, PurReqnAcctAssgmt, RawSubstance, RealSubstance, Recipe, RecipeFormulaItem, RecipeText, ReleaseInvoiceExportParameters, ReleaseMessage, RequestForQuotation, RequestForQuotationBidder, RequestForQuotationItem, Return, SalesContract, SalesContractItem, SalesContractItemPartner, SalesContractItemPrcgElmnt, SalesContractPartner, SalesContractPrcgElmnt, SalesDistrict, SalesDistrictText, SalesInquiry, SalesInquiryItem, SalesInquiryItemPartner, SalesInquiryItemPrcgElmnt, SalesInquiryPartner, SalesInquiryPrcgElmnt, SalesOrder, SalesOrderHeaderPartner, SalesOrderHeaderPrElement, SalesOrderItem, SalesOrderItemPartner, SalesOrderItemPrElement, SalesOrderScheduleLine, SalesOrganization, SalesOrganizationText, SalesQuotation, SalesQuotationItem, SalesQuotationItemPartner, SalesQuotationItemPrcgElmnt, SalesQuotationPartner, SalesQuotationPrcgElmnt, SchAgrmtAcCnt, SchAgrmtHeader, SchAgrmtItem, SchAgrmtPartner, SchAgrmtSchLine, Segment, SegmentText, SerialNmbrDelivery, ServiceEntrySheet, ServiceEntrySheetItem, SpecAssignedMatlForKeyDate, SpecAssignedMatlForKeyDate, SpecAuthorizationGroupText, SpecAuthorizationGroupText, SpecCharByValueAssgmtInst, SpecCharByValueAssgmtInst, SpecIdentifier, SpecIdentifier, SpecStatusAttributes, SpecStatusAttributes, SpecStatusNextStatus, SpecStatusNextStatus, SpecStatusSchema, SpecStatusSchema, SpecValAssgmtInstanceWthComp, SpecValAssgmtInstanceWthComp, SrvcEntrShtAcctAssignment, SubscriptionMaintain, SubscriptionRead, SuplrActyDescription, SuplrActyParticipant, SuplrActyPurchaserResp, SuplrActySupplier, SuplrActyTskActyReference, SuplrActyTskCommText, SuplrActyTskDescription, SuplrActyTskMessageText, SuplrActyTskProcessor, SuplrActyTskPurchaserResp, SuplrActyTskSupplier, SuplrEvalRspAppraiser, SuplrEvalRspExplText, SuplrEvalRspExternalName, SuplrEvalRspIntroduction, SuplrEvalRspLanguage, SuplrEvalRspPurchaserResp, SuplrEvalRspQuestion, SuplrEvalRspQuestionText, SuplrEvalRspRootQnaire, SuplrEvalRspSection, SuplrEvalRspSectionText, SuplrEvalRspStrucQnaire, SuplrEvalRspSupplier, SuplrEvalSccrdPurchaserResp, SuplrEvalSccrdQuestion, SuplrEvalSccrdSection, SuplrEvalSccrdStrucQnaire, SuplrEvalSccrdSupplier, SuplrEvalScorecard, SuplrEvalScorecardRootQnaire, SuplrInvcItemPurOrdRef, Supplier, SupplierActivity, SupplierActivityTask, SupplierCompany, SupplierDunning, SupplierEvaluationResponse, SupplierInvoice, SupplierInvoiceItemGLAcct, SupplierInvoiceTax, SupplierPartnerFunc, SupplierPurchasingOrg, SupplierQuotation, SupplierQuotationItem, SupplierWithHoldingTax, TimeOverview, TimeSheetDataFields, TimeSheetEntry, WorkCenterCapacity, WorkCenterDayOperation, WorkCenterPipeLineOperation, WorkCenters, WorkItem, WorkItem, Workpackage, WorkPackage

public abstract class Entity<EntityT>
extends Object

Superclass of all entities which contains common elements such as a generic representation of custom fields.

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
<T> T	getCustomField(EntityField<EntityT,T> customField) This method allows for retrieval of custom fields that are added to the underlying OData services.
<T> T	getCustomField(String customFieldName) This method allows for retrieval of custom fields that are added to the underlying OData services.
Set<String>	getCustomFieldNames()
Map<String,Object>	getCustomFields()
abstract Class<EntityT>	getType()
boolean	hasCustomField(EntityField<EntityT,?> customField)
boolean	hasCustomField(String customFieldName)
int	hashCode()
void	setCustomField(String key, Object value) Set the value of a single custom field.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Entity

public Entity()

Method Detail

getCustomFieldNames

public Set<String> getCustomFieldNames()

Returns:

The names of the custom fields of this entity.

getCustomFields

public Map<String,Object> getCustomFields()

Returns:

All of the names & values of custom fields as a map.

setCustomField

public void setCustomField(String key,
                           Object value)

Set the value of a single custom field.

Parameters:

key - Name of the custom field

value - Value of the custom field

hasCustomField

public boolean hasCustomField(String customFieldName)

Parameters:

customFieldName - Name of the custom field to check for

Returns:

true if this entity has a custom field with the given name, false otherwise.

hasCustomField

public boolean hasCustomField(EntityField<EntityT,?> customField)

Parameters:

customField - Custom field to check for, represented as an EntityField object

Returns:

true if this entity has a custom field with the name of the given field, false otherwise.

getCustomField

@Nullable
public <T> T getCustomField(String customFieldName)
                               throws NoSuchEntityFieldException

This method allows for retrieval of custom fields that are added to the underlying OData services.

Parameters:

customFieldName - Name of the field returned by the underlying OData service.

Returns:

The value of the custom field. Actual type will depend on the type configured in the underlying OData service.

Throws:

NoSuchEntityFieldException

getCustomField

@Nullable
public <T> T getCustomField(EntityField<EntityT,T> customField)
                               throws NoSuchEntityFieldException

This method allows for retrieval of custom fields that are added to the underlying OData services.

Parameters:

customField - Field returned by the underlying OData service.

Returns:

The value of the custom field. Actual type will depend on the type configured in the underlying OData service.

Throws:

NoSuchEntityFieldException

getType

public abstract Class<EntityT> getType()

Returns:

The class of this entity.

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object