Abstract
Internal
Protected
_customA mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.
Readonly
_entityAbstract
Readonly
_oProtected
_versionThe current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".
Protected
remoteThe remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of the original OData properties.
Static
_defaultStatic
_entityStatic
_serviceETag version identifier accessor.
The ETag version identifier of the retrieved entity, returns undefined
if not retrieved.
Protected
asCreates an object containing all defined properties, navigation properties and custom fields in the entity.
Optional
visitedEntities: EntityBase[]List of entities to check in case of circular dependencies.
EntityBase as an object with all defined entity fields.
Protected
getOptional
visitedEntities: EntityBase[]Returns all changed properties compared to the last known remote state. The returned properties do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.
EntityBase with all properties that changed.
Returns all changed property names compared to the last known remote state. The returned properties names do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.
EntityBase with all properties that changed.
Protected
isValidates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
Field name to check.
Boolean value that describes whether a field name can be defined as custom field.
Protected
isOptional
visitedEntities: EntityBase[]Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.
The name of the custom field to update.
The value of the field.
The entity itself, to facilitate method chaining.
Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.
Optional
state: Record<string, any>State to be set as remote state.
The entity itself, to facilitate method chaining.
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Super class for all representations of OData entity types.