Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CntrlPurContrDistrMessages" of service "API_CENTRAL_PURCHASECONTRACT_SRV". This service is part of the following communication scenarios: SAP S/4HANA Procurement Hub - Central Contract Management Integration (SAP_COM_0243). See https://api.sap.com/api/API_CENTRAL_PURCHASECONTRACT_SRV for more information.

Hierarchy

  • Entity
    • CntrlPurContrDistrMessages

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

distrResponseMessageUuid

distrResponseMessageUuid: string

Generic Data Element for GUID Fields (X16).

Optional extContractForPurg

extContractForPurg: undefined | string

Contract of External System. Maximum length: 10.

nullable

Optional logicalSystem

logicalSystem: undefined | string

Logical System. System in which integrated applications are running on a common data basis. The distribution of data between systems requires that each system in the network has a unique identification. Logical systems are used for this purpose.In SAP terms, the client refers to a logical system. You can specify which logical system is a client in the Client Maintenance (choose Goto -> Details).The logical system is relevant for the following SAP areas:ALE general: Communication takes place between two or more logical systems.ALE Business Processes (for example, Cost Center Accounting): Definition of the system in which a given application runs. Changes such as those to master data can only be made in this system.Workflow objects: The key of a workflow object always contains the logical system in which the object is located.When defining the logical system keep in mind the following:The logical system must be unique enterprise-wide. It must not be used by any other system in the ALE System group.The logical system must not be changed in the production system. If the logical system of a document reference is not set to initial and does not match your own, the system assumes that the document must be located on another system. Maximum length: 10.

nullable

Optional purchasingDocument

purchasingDocument: undefined | string

Purchasing Document Number. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional purchasingDocumentCategory

purchasingDocumentCategory: undefined | string

Purchasing Document Category. Allows a distinction to be made between the various purchasing documents. Maximum length: 1.

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

sequenceNumber

sequenceNumber: string

Sequence No. of Message during Contract Distribution. Maximum length: 4.

Optional systemMessageIdentification

systemMessageIdentification: undefined | string

Message identification. A grouping term for every work area under which the number of the message is saved. Maximum length: 20.

nullable

Optional systemMessageNumber

systemMessageNumber: undefined | string

Message number. Maximum length: 3.

nullable

Optional systemMessageText

systemMessageText: undefined | string

System Message Text. Maximum length: 220.

nullable

Optional systemMessageType

systemMessageType: undefined | string

Message Type. Message type (E,I,W,...). Maximum length: 1.

nullable

Optional systemMessageVariable1

systemMessageVariable1: undefined | string

Message variable 01. Maximum length: 50.

nullable

Optional systemMessageVariable2

systemMessageVariable2: undefined | string

Message variable 02. Maximum length: 50.

nullable

Optional systemMessageVariable3

systemMessageVariable3: undefined | string

Message variable 03. Maximum length: 50.

nullable

Optional systemMessageVariable4

systemMessageVariable4: undefined | string

Message variable 04. Maximum length: 50.

nullable

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

All fields selector.

Static DISTR_RESPONSE_MESSAGE_UUID

DISTR_RESPONSE_MESSAGE_UUID: StringField<CntrlPurContrDistrMessages> = new StringField('DistrResponseMessageUUID', CntrlPurContrDistrMessages, 'Edm.Guid')

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

Static EXT_CONTRACT_FOR_PURG

EXT_CONTRACT_FOR_PURG: StringField<CntrlPurContrDistrMessages> = new StringField('ExtContractForPurg', CntrlPurContrDistrMessages, 'Edm.String')

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

Static LOGICAL_SYSTEM

LOGICAL_SYSTEM: StringField<CntrlPurContrDistrMessages> = new StringField('LogicalSystem', CntrlPurContrDistrMessages, 'Edm.String')

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

Static PURCHASING_DOCUMENT

PURCHASING_DOCUMENT: StringField<CntrlPurContrDistrMessages> = new StringField('PurchasingDocument', CntrlPurContrDistrMessages, 'Edm.String')

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

Static PURCHASING_DOCUMENT_CATEGORY

PURCHASING_DOCUMENT_CATEGORY: StringField<CntrlPurContrDistrMessages> = new StringField('PurchasingDocumentCategory', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SEQUENCE_NUMBER

SEQUENCE_NUMBER: StringField<CntrlPurContrDistrMessages> = new StringField('SequenceNumber', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_IDENTIFICATION

SYSTEM_MESSAGE_IDENTIFICATION: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageIdentification', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_NUMBER

SYSTEM_MESSAGE_NUMBER: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageNumber', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_TEXT

SYSTEM_MESSAGE_TEXT: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageText', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_TYPE

SYSTEM_MESSAGE_TYPE: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageType', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_VARIABLE_1

SYSTEM_MESSAGE_VARIABLE_1: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageVariable1', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_VARIABLE_2

SYSTEM_MESSAGE_VARIABLE_2: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageVariable2', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_VARIABLE_3

SYSTEM_MESSAGE_VARIABLE_3: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageVariable3', CntrlPurContrDistrMessages, 'Edm.String')

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

Static SYSTEM_MESSAGE_VARIABLE_4

SYSTEM_MESSAGE_VARIABLE_4: StringField<CntrlPurContrDistrMessages> = new StringField('SystemMessageVariable4', CntrlPurContrDistrMessages, 'Edm.String')

Static representation of the systemMessageVariable4 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<CntrlPurContrDistrMessages>> = [CntrlPurContrDistrMessages.SEQUENCE_NUMBER,CntrlPurContrDistrMessages.DISTR_RESPONSE_MESSAGE_UUID,CntrlPurContrDistrMessages.PURCHASING_DOCUMENT,CntrlPurContrDistrMessages.PURCHASING_DOCUMENT_CATEGORY,CntrlPurContrDistrMessages.EXT_CONTRACT_FOR_PURG,CntrlPurContrDistrMessages.LOGICAL_SYSTEM,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_TYPE,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_IDENTIFICATION,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_NUMBER,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_VARIABLE_1,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_VARIABLE_2,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_VARIABLE_3,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_VARIABLE_4,CntrlPurContrDistrMessages.SYSTEM_MESSAGE_TEXT]

All fields of the CntrlPurContrDistrMessages entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CntrlPurContrDistrMessages"

Technical entity name for CntrlPurContrDistrMessages.

Static _keyFields

_keyFields: Array<Selectable<CntrlPurContrDistrMessages>> = [CntrlPurContrDistrMessages.SEQUENCE_NUMBER, CntrlPurContrDistrMessages.DISTR_RESPONSE_MESSAGE_UUID]

All key fields of the CntrlPurContrDistrMessages entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CENTRAL_PURCHASECONTRACT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CntrlPurContrDistrMessages>

    A builder that constructs instances of entity type CntrlPurContrDistrMessages.

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

    Returns CntrlPurContrDistrMessagesRequestBuilder

    A CntrlPurContrDistrMessages request builder.