Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierActivityTask" of service "API_SUPPLIER_ACTIVITY_TASK_SRV". This service is part of the following communication scenarios: Supplier Activity Task Integration (SAP_COM_0138). See https://api.sap.com/api/API_SUPPLIER_ACTIVITY_TASK_SRV for more information.

Hierarchy

  • Entity
    • SupplierActivityTask

Implements

Index

Constructors

constructor

  • Returns SupplierActivityTask

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 createdByUser

createdByUser: undefined | string

Created-By Name. Maximum length: 60.

nullable

Optional creationDateTime

creationDateTime: Moment

Created On.

nullable

Optional endDate

endDate: Moment

Due Date.

nullable

Optional language

language: undefined | string

Language. Maximum length: 2.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Changed-By Name. Maximum length: 60.

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

Optional suplrActyTaskLifecycleStatus

suplrActyTaskLifecycleStatus: undefined | string

Lifecycle Status Code for Tasks. Maximum length: 2.

nullable

Optional suplrActyTaskName

suplrActyTaskName: undefined | string

Task Name. Maximum length: 60.

nullable

Optional suplrActyTaskPriority

suplrActyTaskPriority: undefined | string

Priority of a Task. Maximum length: 1.

nullable

suplrActyTaskUuid

suplrActyTaskUuid: string

Task UUID.

Optional supplierActivityTask

supplierActivityTask: undefined | string

Task ID. Maximum length: 20.

nullable

toSuplrActyTskActyReference

toSuplrActyTskActyReference: SuplrActyTskActyReference

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

toSuplrActyTskCommText

toSuplrActyTskCommText: SuplrActyTskCommText

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

toSuplrActyTskDescription

toSuplrActyTskDescription: SuplrActyTskDescription

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

toSuplrActyTskMessageText

toSuplrActyTskMessageText: SuplrActyTskMessageText

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

toSuplrActyTskProcessor

toSuplrActyTskProcessor: SuplrActyTskProcessor

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

toSuplrActyTskPurchaserResp

toSuplrActyTskPurchaserResp: SuplrActyTskPurchaserResp

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

toSuplrActyTskSupplier

toSuplrActyTskSupplier: SuplrActyTskSupplier[]

One-to-many navigation property to the SuplrActyTskSupplier 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<SupplierActivityTask> = new AllFields('*', SupplierActivityTask)

All fields selector.

Static CREATED_BY_USER

CREATED_BY_USER: StringField<SupplierActivityTask> = new StringField('CreatedByUser', SupplierActivityTask, '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<SupplierActivityTask> = new DateField('CreationDateTime', SupplierActivityTask, '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 END_DATE

END_DATE: DateField<SupplierActivityTask> = new DateField('EndDate', SupplierActivityTask, 'Edm.DateTime')

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

Static LANGUAGE

LANGUAGE: StringField<SupplierActivityTask> = new StringField('Language', SupplierActivityTask, 'Edm.String')

Static representation of the language 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<SupplierActivityTask> = new StringField('LastChangedByUser', SupplierActivityTask, '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 SUPLR_ACTY_TASK_LIFECYCLE_STATUS

SUPLR_ACTY_TASK_LIFECYCLE_STATUS: StringField<SupplierActivityTask> = new StringField('SuplrActyTaskLifecycleStatus', SupplierActivityTask, 'Edm.String')

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

Static SUPLR_ACTY_TASK_NAME

SUPLR_ACTY_TASK_NAME: StringField<SupplierActivityTask> = new StringField('SuplrActyTaskName', SupplierActivityTask, 'Edm.String')

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

Static SUPLR_ACTY_TASK_PRIORITY

SUPLR_ACTY_TASK_PRIORITY: StringField<SupplierActivityTask> = new StringField('SuplrActyTaskPriority', SupplierActivityTask, 'Edm.String')

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

Static SUPLR_ACTY_TASK_UUID

SUPLR_ACTY_TASK_UUID: StringField<SupplierActivityTask> = new StringField('SuplrActyTaskUUID', SupplierActivityTask, 'Edm.Guid')

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

Static SUPPLIER_ACTIVITY_TASK

SUPPLIER_ACTIVITY_TASK: StringField<SupplierActivityTask> = new StringField('SupplierActivityTask', SupplierActivityTask, 'Edm.String')

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

Static TO_SUPLR_ACTY_TSK_ACTY_REFERENCE

TO_SUPLR_ACTY_TSK_ACTY_REFERENCE: OneToOneLink<SupplierActivityTask, SuplrActyTskActyReference> = new OneToOneLink('to_SuplrActyTskActyReference', SupplierActivityTask, SuplrActyTskActyReference)

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

Static TO_SUPLR_ACTY_TSK_COMM_TEXT

TO_SUPLR_ACTY_TSK_COMM_TEXT: OneToOneLink<SupplierActivityTask, SuplrActyTskCommText> = new OneToOneLink('to_SuplrActyTskCommText', SupplierActivityTask, SuplrActyTskCommText)

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

Static TO_SUPLR_ACTY_TSK_DESCRIPTION

TO_SUPLR_ACTY_TSK_DESCRIPTION: OneToOneLink<SupplierActivityTask, SuplrActyTskDescription> = new OneToOneLink('to_SuplrActyTskDescription', SupplierActivityTask, SuplrActyTskDescription)

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

Static TO_SUPLR_ACTY_TSK_MESSAGE_TEXT

TO_SUPLR_ACTY_TSK_MESSAGE_TEXT: OneToOneLink<SupplierActivityTask, SuplrActyTskMessageText> = new OneToOneLink('to_SuplrActyTskMessageText', SupplierActivityTask, SuplrActyTskMessageText)

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

Static TO_SUPLR_ACTY_TSK_PROCESSOR

TO_SUPLR_ACTY_TSK_PROCESSOR: OneToOneLink<SupplierActivityTask, SuplrActyTskProcessor> = new OneToOneLink('to_SuplrActyTskProcessor', SupplierActivityTask, SuplrActyTskProcessor)

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

Static TO_SUPLR_ACTY_TSK_PURCHASER_RESP

TO_SUPLR_ACTY_TSK_PURCHASER_RESP: OneToOneLink<SupplierActivityTask, SuplrActyTskPurchaserResp> = new OneToOneLink('to_SuplrActyTskPurchaserResp', SupplierActivityTask, SuplrActyTskPurchaserResp)

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

Static TO_SUPLR_ACTY_TSK_SUPPLIER

TO_SUPLR_ACTY_TSK_SUPPLIER: Link<SupplierActivityTask, SuplrActyTskSupplier> = new Link('to_SuplrActyTskSupplier', SupplierActivityTask, SuplrActyTskSupplier)

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

Static _allFields

_allFields: Array<StringField<SupplierActivityTask> | DateField<SupplierActivityTask> | OneToOneLink<SupplierActivityTask, SuplrActyTskActyReference> | OneToOneLink<SupplierActivityTask, SuplrActyTskCommText> | OneToOneLink<SupplierActivityTask, SuplrActyTskDescription> | OneToOneLink<SupplierActivityTask, SuplrActyTskMessageText> | OneToOneLink<SupplierActivityTask, SuplrActyTskProcessor> | OneToOneLink<SupplierActivityTask, SuplrActyTskPurchaserResp> | Link<SupplierActivityTask, SuplrActyTskSupplier>> = [SupplierActivityTask.SUPLR_ACTY_TASK_UUID,SupplierActivityTask.SUPPLIER_ACTIVITY_TASK,SupplierActivityTask.SUPLR_ACTY_TASK_NAME,SupplierActivityTask.CREATION_DATE_TIME,SupplierActivityTask.CREATED_BY_USER,SupplierActivityTask.LAST_CHANGED_BY_USER,SupplierActivityTask.END_DATE,SupplierActivityTask.LANGUAGE,SupplierActivityTask.SUPLR_ACTY_TASK_PRIORITY,SupplierActivityTask.SUPLR_ACTY_TASK_LIFECYCLE_STATUS,SupplierActivityTask.TO_SUPLR_ACTY_TSK_ACTY_REFERENCE,SupplierActivityTask.TO_SUPLR_ACTY_TSK_COMM_TEXT,SupplierActivityTask.TO_SUPLR_ACTY_TSK_DESCRIPTION,SupplierActivityTask.TO_SUPLR_ACTY_TSK_MESSAGE_TEXT,SupplierActivityTask.TO_SUPLR_ACTY_TSK_PROCESSOR,SupplierActivityTask.TO_SUPLR_ACTY_TSK_PURCHASER_RESP,SupplierActivityTask.TO_SUPLR_ACTY_TSK_SUPPLIER]

All fields of the SupplierActivityTask entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierActivityTask"

Technical entity name for SupplierActivityTask.

Static _keyFields

_keyFields: Array<Selectable<SupplierActivityTask>> = [SupplierActivityTask.SUPLR_ACTY_TASK_UUID]

All key fields of the SupplierActivityTask entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_SUPPLIER_ACTIVITY_TASK_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierActivityTask>

    A builder that constructs instances of entity type SupplierActivityTask.

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

    Returns SupplierActivityTaskRequestBuilder

    A SupplierActivityTask request builder.