Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurchaseReqnItemText" of service "API_PURCHASEREQ_PROCESS_SRV". This service is part of the following communication scenarios: SAP S/4HANA Procurement Hub - Ariba GB - Hub to Ariba GB Integration (SAP_COM_0292), Purchase Requisition Integration (SAP_COM_0102). See https://api.sap.com/api/API_PURCHASEREQ_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PurchaseReqnItemText

Implements

Index

Constructors

constructor

  • Returns PurchaseReqnItemText

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 archObjectNumber

archObjectNumber: undefined | string

Name. Customer-defined name of a text or a graphic. It can be a maximum of 70 characters in length. However, in specific text applications, only shorter names are usually allowed.Do not use the characters ',' or '*' in the text name or leave it blank. Maximum length: 70.

nullable

documentText

documentText: string

Text ID. The text ID defines the various types of texts related to a text object. For example, the object "TEXT" (standard texts) can have the following text IDs: ST for user-specific standard texts (individual texts)SYST for cross-application system textsvarious IDs for specific application departments. You must have the appropriate access authorization in order to access these texts. Maximum length: 4.

Optional fixedIndicator

fixedIndicator: undefined | string

"Fixed" Indicator for Texts. Determines whether a text from a master record or another document can be adopted in a document and processed further in that document. You assign the "fixed" indicator to a text to specify whether:The text can be fixed (indicator "*")A text with the status "*" is then displayed in the document and can be adopted in the document if:You change the text and save the documentYou select the text and adopt it (Item -> Texts -> Adopt text)Until you adopt the text, changes in the master record will also be adopted in the text.The text is fixed (indicator " ")The text is copied into the document. Changes to the document text do not have any effect on the original text and changes to the original text have no effect on the document text.The text is not fixed (indicator "N")The text is only displayed in the document (i.e. it cannot be changed or printed).You specify the "fixed" indicator for each purchasing document in Customizing for Purchasing under Text Types and Copying Rules for Header Texts and Text Types and Copying Rules for Item Texts.You wish to adopt a delivery text from a requisition (status "*") in a purchase order. If you select and adopt the text, it acquires the status " " and can be printed.In Customizing for Purchasing under Messages -> Texts for Messages, you can specify for each purchasing document the sequence and priority in which the texts of a document are to be printed. Maximum length: 1.

nullable

language

language: string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.

Optional noteDescription

noteDescription: undefined | string

Long Text.

nullable

purchaseRequisition

purchaseRequisition: string

Purchase Requisition Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

purchaseRequisitionItem

purchaseRequisitionItem: string

Item Number of Purchase Requisition. Specifies the number that uniquely identifies an item in . Maximum length: 5.

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

technicalObjectType

technicalObjectType: string

Texts: Application Object. In business applications, a text is not considered an independent object. A text can only exist if it has a superior reference object. A material inspection text, for example, only exists if there is a corresponding material. The application object of a text is therefore the global environment in which a text exists. Maximum length: 10.

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<PurchaseReqnItemText> = new AllFields('*', PurchaseReqnItemText)

All fields selector.

Static ARCH_OBJECT_NUMBER

ARCH_OBJECT_NUMBER: StringField<PurchaseReqnItemText> = new StringField('ArchObjectNumber', PurchaseReqnItemText, 'Edm.String')

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

Static DOCUMENT_TEXT

DOCUMENT_TEXT: StringField<PurchaseReqnItemText> = new StringField('DocumentText', PurchaseReqnItemText, 'Edm.String')

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

Static FIXED_INDICATOR

FIXED_INDICATOR: StringField<PurchaseReqnItemText> = new StringField('FixedIndicator', PurchaseReqnItemText, 'Edm.String')

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

Static LANGUAGE

LANGUAGE: StringField<PurchaseReqnItemText> = new StringField('Language', PurchaseReqnItemText, '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 NOTE_DESCRIPTION

NOTE_DESCRIPTION: StringField<PurchaseReqnItemText> = new StringField('NoteDescription', PurchaseReqnItemText, 'Edm.String')

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

Static PURCHASE_REQUISITION

PURCHASE_REQUISITION: StringField<PurchaseReqnItemText> = new StringField('PurchaseRequisition', PurchaseReqnItemText, 'Edm.String')

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

Static PURCHASE_REQUISITION_ITEM

PURCHASE_REQUISITION_ITEM: StringField<PurchaseReqnItemText> = new StringField('PurchaseRequisitionItem', PurchaseReqnItemText, 'Edm.String')

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

Static TECHNICAL_OBJECT_TYPE

TECHNICAL_OBJECT_TYPE: StringField<PurchaseReqnItemText> = new StringField('TechnicalObjectType', PurchaseReqnItemText, 'Edm.String')

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

Static _allFields

_allFields: Array<StringField<PurchaseReqnItemText>> = [PurchaseReqnItemText.PURCHASE_REQUISITION,PurchaseReqnItemText.PURCHASE_REQUISITION_ITEM,PurchaseReqnItemText.DOCUMENT_TEXT,PurchaseReqnItemText.TECHNICAL_OBJECT_TYPE,PurchaseReqnItemText.LANGUAGE,PurchaseReqnItemText.ARCH_OBJECT_NUMBER,PurchaseReqnItemText.NOTE_DESCRIPTION,PurchaseReqnItemText.FIXED_INDICATOR]

All fields of the PurchaseReqnItemText entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurchaseReqnItemText"

Technical entity name for PurchaseReqnItemText.

Static _keyFields

_keyFields: Array<Selectable<PurchaseReqnItemText>> = [PurchaseReqnItemText.PURCHASE_REQUISITION, PurchaseReqnItemText.PURCHASE_REQUISITION_ITEM, PurchaseReqnItemText.DOCUMENT_TEXT, PurchaseReqnItemText.TECHNICAL_OBJECT_TYPE, PurchaseReqnItemText.LANGUAGE]

All key fields of the PurchaseReqnItemText entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASEREQ_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurchaseReqnItemText>

    A builder that constructs instances of entity type PurchaseReqnItemText.

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

    Returns PurchaseReqnItemTextRequestBuilder

    A PurchaseReqnItemText request builder.