Class Entity

Super class for all representations of OData v4 entity types.

Hierarchy (View Summary)

Constructors

constructor

Properties

_customFields _entityApi _oDataVersion _versionIdentifier remoteState _defaultBasePath _entityName _serviceName

Accessors

versionIdentifier

Methods

asObject getCurrentStateForKey getCustomField getCustomFields getUpdatedCustomFields getUpdatedProperties getUpdatedPropertyNames hasCustomField isConflictingCustomField isVisitedEntity setCustomField setCustomFields setOrInitializeRemoteState setVersionIdentifier toJSON

Constructors

constructor

Properties

Protected_customFields

_customFields: Record<string, any>

A 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_entityApi

_entityApi: any

Readonly_oDataVersion

_oDataVersion: "v4"

Protected_versionIdentifier

_versionIdentifier: string

The 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 "*".

ProtectedremoteState

remoteState: { [keys: string]: any }

The 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_defaultBasePath

_defaultBasePath: string

Static_entityName

_entityName: string

Static_serviceName

_serviceName: string

Accessors

versionIdentifier

  • get versionIdentifier(): string

  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved.

Methods

ProtectedasObject

  • asObject(visitedEntities?: EntityBase[]): Record<string, any>

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    Parameters

    • OptionalvisitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

    Returns Record<string, any>

    EntityBase as an object with all defined entity fields.

ProtectedgetCurrentStateForKey

getCustomField

  • getCustomField(fieldName: string): any

  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field.

    Returns any

    The value of the corresponding custom field.

getCustomFields

  • getCustomFields(): Record<string, any>

  • Returns a map that contains all entity custom fields.

    Returns Record<string, any>

    A map of all defined custom fields in the entity.

getUpdatedCustomFields

  • getUpdatedCustomFields(): Record<string, any>

  • Returns all updated custom field properties compared to the last known remote state.

    Returns Record<string, any>

    An object containing all updated custom properties, with their new values.

getUpdatedProperties

  • getUpdatedProperties(): Record<string, any>

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

    Returns Record<string, any>

    EntityBase with all properties that changed.

getUpdatedPropertyNames

  • getUpdatedPropertyNames(): string[]

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

    Returns string[]

    EntityBase with all properties that changed.

hasCustomField

  • hasCustomField(fieldName: string): boolean

  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update.

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity.

ProtectedisConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean

  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check.

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field.

ProtectedisVisitedEntity

setCustomField

  • setCustomField(fieldName: string, value: any): this

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

    Parameters

    • fieldName: string

      The name of the custom field to update.

    • value: any

      The value of the field.

    Returns this

    The entity itself, to facilitate method chaining.

setCustomFields

  • setCustomFields(customFields: Record<string, any>): this

  • Sets custom fields on an entity.

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

    Returns this

    The entity itself, to facilitate method chaining.

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: Record<string, any>): this

  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.

    Parameters

    • Optionalstate: Record<string, any>

      State to be set as remote state.

    Returns this

    The entity itself, to facilitate method chaining.

setVersionIdentifier

  • setVersionIdentifier(etag: undefined | string): this

  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: undefined | string

      The returned ETag version of the entity.

    Returns this

    The entity itself, to facilitate method chaining.

toJSON

  • toJSON(): { [key: string]: any }

  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns { [key: string]: any }

    An object containing all instance variables + custom fields.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods