Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProdAllocationObject" of service "API_PRODUCT_ALLOCATION_OBJECT_SRV". See https://api.sap.com/api/API_PRODUCT_ALLOCATION_OBJECT_SRV for more information.

Hierarchy

  • Entity
    • ProdAllocationObject

Implements

Index

Constructors

constructor

  • Returns ProdAllocationObject

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

Optional collectiveAllocationType

collectiveAllocationType: undefined | string

Collective Allocation Type. Maximum length: 2.

nullable

Optional createdByUser

createdByUser: undefined | string

Created by User. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: Moment

Creation Date Time.

nullable

Optional factoryCalendar

factoryCalendar: undefined | string

Factory calendar key. Maximum length: 2.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Last Change Date Time.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed by User. Maximum length: 12.

nullable

Optional prodAllocCheckDateTimeType

prodAllocCheckDateTimeType: undefined | string

Product Allocation Check Date Time Type. Maximum length: 2.

nullable

Optional prodAllocationPeriodTimeZone

prodAllocationPeriodTimeZone: undefined | string

Product Allocation Period Time Zone. Maximum length: 6.

nullable

Optional productAllocationObject

productAllocationObject: undefined | string

Product Allocation Object. Maximum length: 40.

nullable

Optional productAllocationObjectText

productAllocationObjectText: undefined | string

Product Allocation Object Description. Maximum length: 255.

nullable

productAllocationObjectUuid

productAllocationObjectUuid: string

Product Allocation Object UUID.

Optional productAllocationPeriodType

productAllocationPeriodType: undefined | string

Product Allocation Period Type. Maximum length: 2.

nullable

Optional productAllocationQuantityUnit

productAllocationQuantityUnit: undefined | string

Product Allocation Quantity Unit. Maximum length: 3.

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

toProdAllocCharcMetaDataTp

toProdAllocCharcMetaDataTp: ProdAllocCharcMetaData[]

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

toProdAllocCharcValCombnTp

toProdAllocCharcValCombnTp: ProdAllocCharcValCombn[]

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

toProdAllocationObjectTtp

toProdAllocationObjectTtp: ProdAllocationObjectT[]

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COLLECTIVE_ALLOCATION_TYPE

COLLECTIVE_ALLOCATION_TYPE: StringField<ProdAllocationObject> = new StringField('CollectiveAllocationType', ProdAllocationObject, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<ProdAllocationObject> = new StringField('CreatedByUser', ProdAllocationObject, 'Edm.String')

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

Static CREATION_DATE_TIME

CREATION_DATE_TIME: DateField<ProdAllocationObject> = new DateField('CreationDateTime', ProdAllocationObject, 'Edm.DateTimeOffset')

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

Static FACTORY_CALENDAR

FACTORY_CALENDAR: StringField<ProdAllocationObject> = new StringField('FactoryCalendar', ProdAllocationObject, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<ProdAllocationObject> = new StringField('LastChangedByUser', ProdAllocationObject, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<ProdAllocationObject> = new DateField('LastChangeDateTime', ProdAllocationObject, 'Edm.DateTimeOffset')

Static representation of the lastChangeDateTime 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<ProdAllocationObject> = new StringField('ProductAllocationObject', ProdAllocationObject, '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_TEXT

PRODUCT_ALLOCATION_OBJECT_TEXT: StringField<ProdAllocationObject> = new StringField('ProductAllocationObject_Text', ProdAllocationObject, 'Edm.String')

Static representation of the productAllocationObjectText 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<ProdAllocationObject> = new StringField('ProductAllocationObjectUUID', ProdAllocationObject, '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 PRODUCT_ALLOCATION_PERIOD_TYPE

PRODUCT_ALLOCATION_PERIOD_TYPE: StringField<ProdAllocationObject> = new StringField('ProductAllocationPeriodType', ProdAllocationObject, 'Edm.String')

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

Static PRODUCT_ALLOCATION_QUANTITY_UNIT

PRODUCT_ALLOCATION_QUANTITY_UNIT: StringField<ProdAllocationObject> = new StringField('ProductAllocationQuantityUnit', ProdAllocationObject, 'Edm.String')

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

Static PROD_ALLOCATION_PERIOD_TIME_ZONE

PROD_ALLOCATION_PERIOD_TIME_ZONE: StringField<ProdAllocationObject> = new StringField('ProdAllocationPeriodTimeZone', ProdAllocationObject, 'Edm.String')

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

Static PROD_ALLOC_CHECK_DATE_TIME_TYPE

PROD_ALLOC_CHECK_DATE_TIME_TYPE: StringField<ProdAllocationObject> = new StringField('ProdAllocCheckDateTimeType', ProdAllocationObject, 'Edm.String')

Static representation of the prodAllocCheckDateTimeType 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_TTP

TO_PROD_ALLOCATION_OBJECT_TTP: Link<ProdAllocationObject, ProdAllocationObjectT> = new Link('to_ProdAllocationObjectTTP', ProdAllocationObject, ProdAllocationObjectT)

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

Static TO_PROD_ALLOC_CHARC_META_DATA_TP

TO_PROD_ALLOC_CHARC_META_DATA_TP: Link<ProdAllocationObject, ProdAllocCharcMetaData> = new Link('to_ProdAllocCharcMetaDataTP', ProdAllocationObject, ProdAllocCharcMetaData)

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

Static TO_PROD_ALLOC_CHARC_VAL_COMBN_TP

TO_PROD_ALLOC_CHARC_VAL_COMBN_TP: Link<ProdAllocationObject, ProdAllocCharcValCombn> = new Link('to_ProdAllocCharcValCombnTP', ProdAllocationObject, ProdAllocCharcValCombn)

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

Static _allFields

_allFields: Array<StringField<ProdAllocationObject> | DateField<ProdAllocationObject> | Link<ProdAllocationObject, ProdAllocationObjectT> | Link<ProdAllocationObject, ProdAllocCharcMetaData> | Link<ProdAllocationObject, ProdAllocCharcValCombn>> = [ProdAllocationObject.PRODUCT_ALLOCATION_OBJECT_UUID,ProdAllocationObject.CREATION_DATE_TIME,ProdAllocationObject.CREATED_BY_USER,ProdAllocationObject.LAST_CHANGE_DATE_TIME,ProdAllocationObject.LAST_CHANGED_BY_USER,ProdAllocationObject.PRODUCT_ALLOCATION_OBJECT,ProdAllocationObject.PRODUCT_ALLOCATION_OBJECT_TEXT,ProdAllocationObject.PRODUCT_ALLOCATION_PERIOD_TYPE,ProdAllocationObject.PROD_ALLOCATION_PERIOD_TIME_ZONE,ProdAllocationObject.FACTORY_CALENDAR,ProdAllocationObject.PROD_ALLOC_CHECK_DATE_TIME_TYPE,ProdAllocationObject.PRODUCT_ALLOCATION_QUANTITY_UNIT,ProdAllocationObject.COLLECTIVE_ALLOCATION_TYPE,ProdAllocationObject.TO_PROD_ALLOCATION_OBJECT_TTP,ProdAllocationObject.TO_PROD_ALLOC_CHARC_META_DATA_TP,ProdAllocationObject.TO_PROD_ALLOC_CHARC_VAL_COMBN_TP]

All fields of the ProdAllocationObject 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_ProdAllocationObject"

Technical entity name for ProdAllocationObject.

Static _keyFields

_keyFields: Array<Selectable<ProdAllocationObject>> = [ProdAllocationObject.PRODUCT_ALLOCATION_OBJECT_UUID]

All key fields of the ProdAllocationObject entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_ALLOCATION_OBJECT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProdAllocationObject>

    A builder that constructs instances of entity type ProdAllocationObject.

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 ProdAllocationObject entity type.

    Returns ProdAllocationObjectRequestBuilder

    A ProdAllocationObject request builder.