Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProdAllocCharcValCombn" of service "API_PRODUCT_ALLOCATION_OBJECT_SRV". This service is part of the following communication scenarios: Product Allocation Object Integration (SAP_COM_0152). See https://api.sap.com/api/API_PRODUCT_ALLOCATION_OBJECT_SRV for more information.

Hierarchy

  • Entity
    • ProdAllocCharcValCombn

Implements

Index

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<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.

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

charcValueCombinationUuid

charcValueCombinationUuid: string

Characteristic Value Combination UUID.

Optional prodAllocCharc01

prodAllocCharc01: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc02

prodAllocCharc02: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc03

prodAllocCharc03: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc04

prodAllocCharc04: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc05

prodAllocCharc05: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc06

prodAllocCharc06: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc07

prodAllocCharc07: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc08

prodAllocCharc08: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc09

prodAllocCharc09: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharc10

prodAllocCharc10: undefined | string

Product Allocation Characteristic. Maximum length: 40.

nullable

Optional prodAllocCharcConstraintStatus

prodAllocCharcConstraintStatus: undefined | string

Product Allocation Characteristic Constraint Status. Maximum length: 2.

nullable

Optional prodAllocationActivationStatus

prodAllocationActivationStatus: undefined | string

Product Allocation Activation Status. Maximum length: 2.

nullable

Optional productAllocationObject

productAllocationObject: undefined | string

Product Allocation Object. Maximum length: 40.

nullable

Optional productAllocationObjectUuid

productAllocationObjectUuid: undefined | string

Product Allocation Object UUID.

nullable

Protected remoteState

remoteState: object

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 VDM properties.

Type declaration

  • [keys: string]: any

toProdAllocObjTimeSeriesTp

toProdAllocObjTimeSeriesTp: ProdAllocObjTimeSeries[]

One-to-many navigation property to the ProdAllocObjTimeSeries entity.

toProdAllocationObjectTp

toProdAllocationObjectTp: ProdAllocationObject

One-to-one navigation property to the ProdAllocationObject entity.

Static ALL_FIELDS

ALL_FIELDS: AllFields<ProdAllocCharcValCombn> = new AllFields('*', ProdAllocCharcValCombn)

All fields selector.

Static CHARC_VALUE_COMBINATION_UUID

CHARC_VALUE_COMBINATION_UUID: StringField<ProdAllocCharcValCombn> = new StringField('CharcValueCombinationUUID', ProdAllocCharcValCombn, 'Edm.Guid')

Static representation of the charcValueCombinationUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_ALLOCATION_OBJECT

PRODUCT_ALLOCATION_OBJECT: StringField<ProdAllocCharcValCombn> = new StringField('ProductAllocationObject', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the productAllocationObject property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PRODUCT_ALLOCATION_OBJECT_UUID

PRODUCT_ALLOCATION_OBJECT_UUID: StringField<ProdAllocCharcValCombn> = new StringField('ProductAllocationObjectUUID', ProdAllocCharcValCombn, 'Edm.Guid')

Static representation of the productAllocationObjectUuid property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOCATION_ACTIVATION_STATUS

PROD_ALLOCATION_ACTIVATION_STATUS: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocationActivationStatus', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocationActivationStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_01

PROD_ALLOC_CHARC_01: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc01', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc01 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_02

PROD_ALLOC_CHARC_02: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc02', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc02 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_03

PROD_ALLOC_CHARC_03: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc03', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc03 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_04

PROD_ALLOC_CHARC_04: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc04', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc04 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_05

PROD_ALLOC_CHARC_05: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc05', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc05 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_06

PROD_ALLOC_CHARC_06: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc06', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc06 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_07

PROD_ALLOC_CHARC_07: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc07', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc07 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_08

PROD_ALLOC_CHARC_08: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc08', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc08 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_09

PROD_ALLOC_CHARC_09: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc09', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc09 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_10

PROD_ALLOC_CHARC_10: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharc10', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharc10 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PROD_ALLOC_CHARC_CONSTRAINT_STATUS

PROD_ALLOC_CHARC_CONSTRAINT_STATUS: StringField<ProdAllocCharcValCombn> = new StringField('ProdAllocCharcConstraintStatus', ProdAllocCharcValCombn, 'Edm.String')

Static representation of the prodAllocCharcConstraintStatus property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PROD_ALLOCATION_OBJECT_TP

TO_PROD_ALLOCATION_OBJECT_TP: OneToOneLink<ProdAllocCharcValCombn, ProdAllocationObject> = new OneToOneLink('to_ProdAllocationObjectTP', ProdAllocCharcValCombn, ProdAllocationObject)

Static representation of the one-to-one navigation property toProdAllocationObjectTp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_PROD_ALLOC_OBJ_TIME_SERIES_TP

TO_PROD_ALLOC_OBJ_TIME_SERIES_TP: Link<ProdAllocCharcValCombn, ProdAllocObjTimeSeries> = new Link('to_ProdAllocObjTimeSeriesTP', ProdAllocCharcValCombn, ProdAllocObjTimeSeries)

Static representation of the one-to-many navigation property toProdAllocObjTimeSeriesTp for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<ProdAllocCharcValCombn> | OneToOneLink<ProdAllocCharcValCombn, ProdAllocationObject> | Link<ProdAllocCharcValCombn, ProdAllocObjTimeSeries>> = [ProdAllocCharcValCombn.CHARC_VALUE_COMBINATION_UUID,ProdAllocCharcValCombn.PRODUCT_ALLOCATION_OBJECT_UUID,ProdAllocCharcValCombn.PRODUCT_ALLOCATION_OBJECT,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_01,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_02,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_03,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_04,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_05,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_06,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_07,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_08,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_09,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_10,ProdAllocCharcValCombn.PROD_ALLOC_CHARC_CONSTRAINT_STATUS,ProdAllocCharcValCombn.PROD_ALLOCATION_ACTIVATION_STATUS,ProdAllocCharcValCombn.TO_PROD_ALLOCATION_OBJECT_TP,ProdAllocCharcValCombn.TO_PROD_ALLOC_OBJ_TIME_SERIES_TP]

All fields of the ProdAllocCharcValCombn entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_PRODUCT_ALLOCATION_OBJECT_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProdAllocCharcValCombn"

Technical entity name for ProdAllocCharcValCombn.

Static _keyFields

_keyFields: Array<Selectable<ProdAllocCharcValCombn>> = [ProdAllocCharcValCombn.CHARC_VALUE_COMBINATION_UUID]

All key fields of the ProdAllocCharcValCombn entity.

Static _keys

_keys: object = ProdAllocCharcValCombn._keyFields.reduce((acc: { [keys: string]: Selectable<ProdAllocCharcValCombn> }, field: Selectable<ProdAllocCharcValCombn>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property ProdAllocCharcValCombn.

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_ALLOCATION_OBJECT_SRV"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for ProdAllocCharcValCombn.

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

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

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(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity 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

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • 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

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

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

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

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ProdAllocCharcValCombn.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProdAllocCharcValCombn>

    A builder that constructs instances of entity type ProdAllocCharcValCombn.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ProdAllocCharcValCombn entity type.

    Returns ProdAllocCharcValCombnRequestBuilder

    A ProdAllocCharcValCombn request builder.