Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_LglTransExternalContact" of service "API_LEGAL_TRANSACTION_SRV". This service is part of the following communication scenarios: Legal Transaction Integration (SAP_COM_0140). See https://api.sap.com/api/API_LEGAL_TRANSACTION_SRV for more information.

Hierarchy

  • Entity
    • LglTransExternalContact

Implements

Index

Constructors

constructor

  • Returns LglTransExternalContact

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

legalTransactionExtCntctUuid

legalTransactionExtCntctUuid: string

Universal Unique Identifier.

Optional legalTransactionMandatoryFlag

legalTransactionMandatoryFlag: string

Control Parameter Legal Transaction Mandatory State. Maximum length: 1.

nullable

Optional legalTransactionUuid

legalTransactionUuid: string

Universal Unique Identifier.

nullable

Optional lglCntntMExtCntctBp

lglCntntMExtCntctBp: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

nullable

Optional lglCntntMExtCntctType

lglCntntMExtCntctType: string

Contact Type. Maximum length: 4.

nullable

Optional lglCntntMRank

lglCntntMRank: number

Rank.

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

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

All fields selector.

Static LEGAL_TRANSACTION_EXT_CNTCT_UUID

LEGAL_TRANSACTION_EXT_CNTCT_UUID: StringField<LglTransExternalContact> = new StringField('LegalTransactionExtCntctUUID', LglTransExternalContact, 'Edm.Guid')

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

Static LEGAL_TRANSACTION_MANDATORY_FLAG

LEGAL_TRANSACTION_MANDATORY_FLAG: StringField<LglTransExternalContact> = new StringField('LegalTransactionMandatoryFlag', LglTransExternalContact, 'Edm.String')

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

Static LEGAL_TRANSACTION_UUID

LEGAL_TRANSACTION_UUID: StringField<LglTransExternalContact> = new StringField('LegalTransactionUUID', LglTransExternalContact, 'Edm.Guid')

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

Static LGL_CNTNT_M_EXT_CNTCT_BP

LGL_CNTNT_M_EXT_CNTCT_BP: StringField<LglTransExternalContact> = new StringField('LglCntntMExtCntctBP', LglTransExternalContact, 'Edm.String')

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

Static LGL_CNTNT_M_EXT_CNTCT_TYPE

LGL_CNTNT_M_EXT_CNTCT_TYPE: StringField<LglTransExternalContact> = new StringField('LglCntntMExtCntctType', LglTransExternalContact, 'Edm.String')

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

Static LGL_CNTNT_M_RANK

LGL_CNTNT_M_RANK: NumberField<LglTransExternalContact> = new NumberField('LglCntntMRank', LglTransExternalContact, 'Edm.Int16')

Static representation of the lglCntntMRank 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<LglTransExternalContact> | NumberField<LglTransExternalContact>> = [LglTransExternalContact.LEGAL_TRANSACTION_EXT_CNTCT_UUID,LglTransExternalContact.LGL_CNTNT_M_RANK,LglTransExternalContact.LGL_CNTNT_M_EXT_CNTCT_TYPE,LglTransExternalContact.LGL_CNTNT_M_EXT_CNTCT_BP,LglTransExternalContact.LEGAL_TRANSACTION_MANDATORY_FLAG,LglTransExternalContact.LEGAL_TRANSACTION_UUID]

All fields of the LglTransExternalContact entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_LglTransExternalContact"

Technical entity name for LglTransExternalContact.

Static _keyFields

_keyFields: Array<Selectable<LglTransExternalContact>> = [LglTransExternalContact.LEGAL_TRANSACTION_EXT_CNTCT_UUID]

All key fields of the LglTransExternalContact entity.

Static _keys

_keys: any = LglTransExternalContact._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_LEGAL_TRANSACTION_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<LglTransExternalContact>

    A builder that constructs instances of entity type LglTransExternalContact.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns LglTransExternalContactRequestBuilder

    A LglTransExternalContact request builder.