Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_LegalTransaction" 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
    • LegalTransaction

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns LegalTransaction

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 isEndOfPurposeBlocked

isEndOfPurposeBlocked: string

Business Purpose Completed. Indicates whether the end of purpose (EoP) has been reached. The EoP is the point in time for a data set when the processing of personal data is no longer required for the primary business purpose. After the EoP has been reached, the data is blocked and can only be accessed by users with special authorization. Maximum length: 1.

nullable

Optional legalTransaction

legalTransaction: string

Legal Transaction ID. Maximum length: 10.

nullable

Optional legalTransactionHealth

legalTransactionHealth: string

Legal Transaction Health. Maximum length: 4.

nullable

Optional legalTransactionSource

legalTransactionSource: string

LCM LT Integration source. Maximum length: 3.

nullable

Optional legalTransactionTitle

legalTransactionTitle: string

Legal Transaction Name. Maximum length: 128.

nullable

legalTransactionUuid

legalTransactionUuid: string

Universal Unique Identifier.

Optional lglCntntMChangedByUser

lglCntntMChangedByUser: string

Changed By User. Maximum length: 12.

nullable

Optional lglCntntMChangedUtcDateTime

lglCntntMChangedUtcDateTime: Moment

Changed UTC Date Time.

nullable

Optional lglCntntMContext

lglCntntMContext: string

Context ID. Maximum length: 5.

nullable

Optional lglCntntMContextUuid

lglCntntMContextUuid: string

Universal Unique Identifier.

nullable

Optional lglCntntMCreatedByUser

lglCntntMCreatedByUser: string

Created By. Maximum length: 12.

nullable

Optional lglCntntMCreatedUtcDateTime

lglCntntMCreatedUtcDateTime: Moment

Created On.

nullable

Optional lglCntntMGovLaw

lglCntntMGovLaw: string

Governing Law. Maximum length: 7.

nullable

Optional lglCntntMLanguage

lglCntntMLanguage: string

Language Key. Maximum length: 2.

nullable

Optional lglCntntMMainOrgCoCode

lglCntntMMainOrgCoCode: string

Entity ID. Maximum length: 10.

nullable

Optional lglCntntMMainOrgPurOrg

lglCntntMMainOrgPurOrg: string

Entity ID. Maximum length: 10.

nullable

Optional lglCntntMMainOrgSalesOrg

lglCntntMMainOrgSalesOrg: string

Entity ID. Maximum length: 10.

nullable

Optional lglCntntMProfile

lglCntntMProfile: string

Profile. Maximum length: 10.

nullable

Optional lglTransAccessLvl

lglTransAccessLvl: string

Access Level. Maximum length: 4.

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

toLglTransCategoryGroup

toLglTransCategoryGroup: LglTransCategoryGroup[]

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

toLglTransDate

toLglTransDate: LglTransDate[]

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

toLglTransEntity

toLglTransEntity: LglTransEntity[]

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

toLglTransExternalContact

toLglTransExternalContact: LglTransExternalContact[]

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

toLglTransInternalContact

toLglTransInternalContact: LglTransInternalContact[]

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

toLglTransLinkedObjects

toLglTransLinkedObjects: LglTransLinkedObjects[]

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

toLglTransRelationship

toLglTransRelationship: LglTransRelationship[]

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

All fields selector.

Static IS_END_OF_PURPOSE_BLOCKED

IS_END_OF_PURPOSE_BLOCKED: StringField<LegalTransaction> = new StringField('IsEndOfPurposeBlocked', LegalTransaction, 'Edm.String')

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

Static LEGAL_TRANSACTION

LEGAL_TRANSACTION: StringField<LegalTransaction> = new StringField('LegalTransaction', LegalTransaction, 'Edm.String')

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

Static LEGAL_TRANSACTION_HEALTH

LEGAL_TRANSACTION_HEALTH: StringField<LegalTransaction> = new StringField('LegalTransactionHealth', LegalTransaction, 'Edm.String')

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

Static LEGAL_TRANSACTION_SOURCE

LEGAL_TRANSACTION_SOURCE: StringField<LegalTransaction> = new StringField('LegalTransactionSource', LegalTransaction, 'Edm.String')

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

Static LEGAL_TRANSACTION_TITLE

LEGAL_TRANSACTION_TITLE: StringField<LegalTransaction> = new StringField('LegalTransactionTitle', LegalTransaction, 'Edm.String')

Static representation of the legalTransactionTitle 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<LegalTransaction> = new StringField('LegalTransactionUUID', LegalTransaction, '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_CHANGED_BY_USER

LGL_CNTNT_M_CHANGED_BY_USER: StringField<LegalTransaction> = new StringField('LglCntntMChangedByUser', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_CHANGED_UTC_DATE_TIME

LGL_CNTNT_M_CHANGED_UTC_DATE_TIME: DateField<LegalTransaction> = new DateField('LglCntntMChangedUTCDateTime', LegalTransaction, 'Edm.DateTimeOffset')

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

Static LGL_CNTNT_M_CONTEXT

LGL_CNTNT_M_CONTEXT: StringField<LegalTransaction> = new StringField('LglCntntMContext', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_CONTEXT_UUID

LGL_CNTNT_M_CONTEXT_UUID: StringField<LegalTransaction> = new StringField('LglCntntMContextUUID', LegalTransaction, 'Edm.Guid')

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

Static LGL_CNTNT_M_CREATED_BY_USER

LGL_CNTNT_M_CREATED_BY_USER: StringField<LegalTransaction> = new StringField('LglCntntMCreatedByUser', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_CREATED_UTC_DATE_TIME

LGL_CNTNT_M_CREATED_UTC_DATE_TIME: DateField<LegalTransaction> = new DateField('LglCntntMCreatedUTCDateTime', LegalTransaction, 'Edm.DateTimeOffset')

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

Static LGL_CNTNT_M_GOV_LAW

LGL_CNTNT_M_GOV_LAW: StringField<LegalTransaction> = new StringField('LglCntntMGovLaw', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_LANGUAGE

LGL_CNTNT_M_LANGUAGE: StringField<LegalTransaction> = new StringField('LglCntntMLanguage', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_MAIN_ORG_CO_CODE

LGL_CNTNT_M_MAIN_ORG_CO_CODE: StringField<LegalTransaction> = new StringField('LglCntntMMainOrgCoCode', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_MAIN_ORG_PUR_ORG

LGL_CNTNT_M_MAIN_ORG_PUR_ORG: StringField<LegalTransaction> = new StringField('LglCntntMMainOrgPurOrg', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_MAIN_ORG_SALES_ORG

LGL_CNTNT_M_MAIN_ORG_SALES_ORG: StringField<LegalTransaction> = new StringField('LglCntntMMainOrgSalesOrg', LegalTransaction, 'Edm.String')

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

Static LGL_CNTNT_M_PROFILE

LGL_CNTNT_M_PROFILE: StringField<LegalTransaction> = new StringField('LglCntntMProfile', LegalTransaction, 'Edm.String')

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

Static LGL_TRANS_ACCESS_LVL

LGL_TRANS_ACCESS_LVL: StringField<LegalTransaction> = new StringField('LglTransAccessLvl', LegalTransaction, 'Edm.String')

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

Static TO_LGL_TRANS_CATEGORY_GROUP

TO_LGL_TRANS_CATEGORY_GROUP: Link<LegalTransaction, LglTransCategoryGroup> = new Link('to_LglTransCategoryGroup', LegalTransaction, LglTransCategoryGroup)

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

Static TO_LGL_TRANS_DATE

TO_LGL_TRANS_DATE: Link<LegalTransaction, LglTransDate> = new Link('to_LglTransDate', LegalTransaction, LglTransDate)

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

Static TO_LGL_TRANS_ENTITY

TO_LGL_TRANS_ENTITY: Link<LegalTransaction, LglTransEntity> = new Link('to_LglTransEntity', LegalTransaction, LglTransEntity)

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

Static TO_LGL_TRANS_EXTERNAL_CONTACT

TO_LGL_TRANS_EXTERNAL_CONTACT: Link<LegalTransaction, LglTransExternalContact> = new Link('to_LglTransExternalContact', LegalTransaction, LglTransExternalContact)

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

Static TO_LGL_TRANS_INTERNAL_CONTACT

TO_LGL_TRANS_INTERNAL_CONTACT: Link<LegalTransaction, LglTransInternalContact> = new Link('to_LglTransInternalContact', LegalTransaction, LglTransInternalContact)

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

Static TO_LGL_TRANS_LINKED_OBJECTS

TO_LGL_TRANS_LINKED_OBJECTS: Link<LegalTransaction, LglTransLinkedObjects> = new Link('to_LglTransLinkedObjects', LegalTransaction, LglTransLinkedObjects)

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

Static TO_LGL_TRANS_RELATIONSHIP

TO_LGL_TRANS_RELATIONSHIP: Link<LegalTransaction, LglTransRelationship> = new Link('to_LglTransRelationship', LegalTransaction, LglTransRelationship)

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

Static _allFields

_allFields: Array<StringField<LegalTransaction> | DateField<LegalTransaction> | Link<LegalTransaction, LglTransCategoryGroup> | Link<LegalTransaction, LglTransDate> | Link<LegalTransaction, LglTransEntity> | Link<LegalTransaction, LglTransExternalContact> | Link<LegalTransaction, LglTransInternalContact> | Link<LegalTransaction, LglTransLinkedObjects> | Link<LegalTransaction, LglTransRelationship>> = [LegalTransaction.LEGAL_TRANSACTION_UUID,LegalTransaction.LEGAL_TRANSACTION,LegalTransaction.LEGAL_TRANSACTION_TITLE,LegalTransaction.LGL_CNTNT_M_CONTEXT,LegalTransaction.LGL_CNTNT_M_CONTEXT_UUID,LegalTransaction.LGL_CNTNT_M_LANGUAGE,LegalTransaction.LGL_CNTNT_M_CHANGED_BY_USER,LegalTransaction.LGL_CNTNT_M_CHANGED_UTC_DATE_TIME,LegalTransaction.LGL_CNTNT_M_CREATED_BY_USER,LegalTransaction.LGL_CNTNT_M_CREATED_UTC_DATE_TIME,LegalTransaction.LEGAL_TRANSACTION_HEALTH,LegalTransaction.LGL_CNTNT_M_PROFILE,LegalTransaction.LEGAL_TRANSACTION_SOURCE,LegalTransaction.IS_END_OF_PURPOSE_BLOCKED,LegalTransaction.LGL_CNTNT_M_GOV_LAW,LegalTransaction.LGL_TRANS_ACCESS_LVL,LegalTransaction.LGL_CNTNT_M_MAIN_ORG_CO_CODE,LegalTransaction.LGL_CNTNT_M_MAIN_ORG_SALES_ORG,LegalTransaction.LGL_CNTNT_M_MAIN_ORG_PUR_ORG,LegalTransaction.TO_LGL_TRANS_CATEGORY_GROUP,LegalTransaction.TO_LGL_TRANS_DATE,LegalTransaction.TO_LGL_TRANS_ENTITY,LegalTransaction.TO_LGL_TRANS_EXTERNAL_CONTACT,LegalTransaction.TO_LGL_TRANS_INTERNAL_CONTACT,LegalTransaction.TO_LGL_TRANS_LINKED_OBJECTS,LegalTransaction.TO_LGL_TRANS_RELATIONSHIP]

All fields of the LegalTransaction 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_LegalTransaction"

Technical entity name for LegalTransaction.

Static _keyFields

_keyFields: Array<Selectable<LegalTransaction>> = [LegalTransaction.LEGAL_TRANSACTION_UUID]

All key fields of the LegalTransaction entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_LEGAL_TRANSACTION_SRV"
deprecated

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

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

  • Returns an entity builder to construct instances LegalTransaction.

    Returns EntityBuilderType<LegalTransaction, LegalTransactionType>

    A builder that constructs instances of entity type LegalTransaction.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity LegalTransaction.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<LegalTransaction>

    A builder that constructs instances of entity type LegalTransaction.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns LegalTransactionRequestBuilder

    A LegalTransaction request builder.