Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_LegalCategory" of service "API_LEGAL_CATEGORY_SRV". This service is part of the following communication scenarios: Enterprise Contract Management and Assembly Integration (SAP_COM_0437). See https://api.sap.com/api/API_LEGAL_CATEGORY_SRV for more information.

Hierarchy

  • Entity
    • LegalCategory

Implements

Index

Constructors

constructor

  • Returns LegalCategory

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 lglCntntMCatIsMultiSelection

lglCntntMCatIsMultiSelection: undefined | false | true

Multiple Selection of Categories.

nullable

Optional lglCntntMCatIsObsolete

lglCntntMCatIsObsolete: undefined | false | true

Category Is Obsolete.

nullable

Optional lglCntntMCatIsSelect

lglCntntMCatIsSelect: undefined | false | true

Category Is Selectable.

nullable

Optional lglCntntMCatLevel

lglCntntMCatLevel: undefined | number

Category Level.

nullable

Optional lglCntntMCatModel

lglCntntMCatModel: undefined | string

Model for Dynamic Categories. Maximum length: 120.

nullable

Optional lglCntntMCatType

lglCntntMCatType: undefined | string

Category Type. Maximum length: 1.

nullable

lglCntntMCategory

lglCntntMCategory: string

Category ID. Maximum length: 6.

Optional lglCntntMCategoryValue

lglCntntMCategoryValue: undefined | string

Category Value. Maximum length: 15.

nullable

Optional lglCntntMChangedByUser

lglCntntMChangedByUser: undefined | string

Changed By User. Maximum length: 12.

nullable

Optional lglCntntMChangedUtcDateTime

lglCntntMChangedUtcDateTime: Moment

Changed UTC Date Time.

nullable

Optional lglCntntMCreatedByUser

lglCntntMCreatedByUser: undefined | string

Created By. Maximum length: 12.

nullable

Optional lglCntntMCreatedUtcDateTime

lglCntntMCreatedUtcDateTime: Moment

Created On.

nullable

Optional lglCntntMParentCategory

lglCntntMParentCategory: undefined | string

Parent Category ID. Maximum length: 6.

nullable

Optional lglCntntMRootCategory

lglCntntMRootCategory: undefined | string

Root Category ID. Maximum length: 6.

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

toLegalCategoryText

toLegalCategoryText: LegalCategoryText[]

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

Static ALL_FIELDS

ALL_FIELDS: AllFields<LegalCategory> = new AllFields('*', LegalCategory)

All fields selector.

Static LGL_CNTNT_M_CATEGORY

LGL_CNTNT_M_CATEGORY: StringField<LegalCategory> = new StringField('LglCntntMCategory', LegalCategory, 'Edm.String')

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

Static LGL_CNTNT_M_CATEGORY_VALUE

LGL_CNTNT_M_CATEGORY_VALUE: StringField<LegalCategory> = new StringField('LglCntntMCategoryValue', LegalCategory, 'Edm.String')

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

Static LGL_CNTNT_M_CAT_IS_MULTI_SELECTION

LGL_CNTNT_M_CAT_IS_MULTI_SELECTION: BooleanField<LegalCategory> = new BooleanField('LglCntntMCatIsMultiSelection', LegalCategory, 'Edm.Boolean')

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

Static LGL_CNTNT_M_CAT_IS_OBSOLETE

LGL_CNTNT_M_CAT_IS_OBSOLETE: BooleanField<LegalCategory> = new BooleanField('LglCntntMCatIsObsolete', LegalCategory, 'Edm.Boolean')

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

Static LGL_CNTNT_M_CAT_IS_SELECT

LGL_CNTNT_M_CAT_IS_SELECT: BooleanField<LegalCategory> = new BooleanField('LglCntntMCatIsSelect', LegalCategory, 'Edm.Boolean')

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

Static LGL_CNTNT_M_CAT_LEVEL

LGL_CNTNT_M_CAT_LEVEL: NumberField<LegalCategory> = new NumberField('LglCntntMCatLevel', LegalCategory, 'Edm.Byte')

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

Static LGL_CNTNT_M_CAT_MODEL

LGL_CNTNT_M_CAT_MODEL: StringField<LegalCategory> = new StringField('LglCntntMCatModel', LegalCategory, 'Edm.String')

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

Static LGL_CNTNT_M_CAT_TYPE

LGL_CNTNT_M_CAT_TYPE: StringField<LegalCategory> = new StringField('LglCntntMCatType', LegalCategory, 'Edm.String')

Static representation of the lglCntntMCatType 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<LegalCategory> = new StringField('LglCntntMChangedByUser', LegalCategory, '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<LegalCategory> = new DateField('LglCntntMChangedUTCDateTime', LegalCategory, '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_CREATED_BY_USER

LGL_CNTNT_M_CREATED_BY_USER: StringField<LegalCategory> = new StringField('LglCntntMCreatedByUser', LegalCategory, '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<LegalCategory> = new DateField('LglCntntMCreatedUTCDateTime', LegalCategory, '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_PARENT_CATEGORY

LGL_CNTNT_M_PARENT_CATEGORY: StringField<LegalCategory> = new StringField('LglCntntMParentCategory', LegalCategory, 'Edm.String')

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

Static LGL_CNTNT_M_ROOT_CATEGORY

LGL_CNTNT_M_ROOT_CATEGORY: StringField<LegalCategory> = new StringField('LglCntntMRootCategory', LegalCategory, 'Edm.String')

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

Static TO_LEGAL_CATEGORY_TEXT

TO_LEGAL_CATEGORY_TEXT: Link<LegalCategory, LegalCategoryText> = new Link('to_LegalCategoryText', LegalCategory, LegalCategoryText)

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

Static _allFields

_allFields: Array<StringField<LegalCategory> | BooleanField<LegalCategory> | NumberField<LegalCategory> | DateField<LegalCategory> | Link<LegalCategory, LegalCategoryText>> = [LegalCategory.LGL_CNTNT_M_CATEGORY,LegalCategory.LGL_CNTNT_M_CAT_TYPE,LegalCategory.LGL_CNTNT_M_CAT_IS_SELECT,LegalCategory.LGL_CNTNT_M_CAT_IS_MULTI_SELECTION,LegalCategory.LGL_CNTNT_M_CAT_LEVEL,LegalCategory.LGL_CNTNT_M_CAT_IS_OBSOLETE,LegalCategory.LGL_CNTNT_M_CAT_MODEL,LegalCategory.LGL_CNTNT_M_CATEGORY_VALUE,LegalCategory.LGL_CNTNT_M_CHANGED_BY_USER,LegalCategory.LGL_CNTNT_M_CHANGED_UTC_DATE_TIME,LegalCategory.LGL_CNTNT_M_CREATED_BY_USER,LegalCategory.LGL_CNTNT_M_CREATED_UTC_DATE_TIME,LegalCategory.LGL_CNTNT_M_PARENT_CATEGORY,LegalCategory.LGL_CNTNT_M_ROOT_CATEGORY,LegalCategory.TO_LEGAL_CATEGORY_TEXT]

All fields of the LegalCategory entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_LegalCategory"

Technical entity name for LegalCategory.

Static _keyFields

_keyFields: Array<Selectable<LegalCategory>> = [LegalCategory.LGL_CNTNT_M_CATEGORY]

All key fields of the LegalCategory entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_LEGAL_CATEGORY_SRV"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<LegalCategory>

    A builder that constructs instances of entity type LegalCategory.

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

    Returns LegalCategoryRequestBuilder

    A LegalCategory request builder.