Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SpecCharByValueAssgmtInst" of service "API_REALSUBSTANCE". See https://api.sap.com/api/API_REALSUBSTANCE for more information.

Hierarchy

  • Entity
    • SpecCharByValueAssgmtInst

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns SpecCharByValueAssgmtInst

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 characteristic

characteristic: string

Characteristic Name. Maximum length: 30.

nullable

Optional characteristicFormat

characteristicFormat: string

Data type of characteristic. Maximum length: 4.

nullable

Optional characteristicInternalId

characteristicInternalId: string

Internal characteristic. Maximum length: 30.

nullable

Optional characteristicIsDeleted

characteristicIsDeleted: boolean

Deletion Indicator.

nullable

Optional characteristicMaximumValueUnit

characteristicMaximumValueUnit: string

Unit of Measurement. Maximum length: 3.

nullable

Optional characteristicMinimumValueUnit

characteristicMinimumValueUnit: string

Unit of Measurement. Maximum length: 3.

nullable

Optional characteristicValue

characteristicValue: string

Characteristic Value. Maximum length: 70.

nullable

Optional characteristicValueDpndcyCode

characteristicValueDpndcyCode: string

Code for value dependency. Maximum length: 1.

nullable

Optional charcCurrencyMinimumValue

charcCurrencyMinimumValue: BigNumber

Lower Boundary for Currency Field.

nullable

Optional charcDateMinimumValue

charcDateMinimumValue: Moment

Lower Boundary for Date-Interval.

nullable

Optional charcDecimalMaximumValue

charcDecimalMaximumValue: BigNumber

Upper Boundary for Numeric Field.

nullable

Optional charcDecimalMinimumValue

charcDecimalMinimumValue: BigNumber

Lower Boundary for Numeric Field.

nullable

Optional charcTimeMinimumValue

charcTimeMinimumValue: Time

Lower Boundary for Time-Interval.

nullable

Optional charcValidityEndDate

charcValidityEndDate: Moment

Valid-to date.

nullable

Optional charcValidityStartDate

charcValidityStartDate: Moment

Valid-From Date.

nullable

Optional charcValueUnit

charcValueUnit: string

Unit of Measurement. Maximum length: 3.

nullable

Optional inhtdSpecValAssgmtIsPermChgd

inhtdSpecValAssgmtIsPermChgd: boolean

Indicator for Permanent Inheritance Overwriting.

nullable

Optional inhtdSpecValAssgmtIsTmpChgd

inhtdSpecValAssgmtIsTmpChgd: boolean

Indicator for Temporary Inheritance Overwriting.

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

Optional specInheritanceTemplate

specInheritanceTemplate: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmt

specValAssgmt: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmtHdr

specValAssgmtHdr: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmtInheritanceParent

specValAssgmtInheritanceParent: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmtInheritanceRoot

specValAssgmtInheritanceRoot: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmtIsInhtncSource

specValAssgmtIsInhtncSource: boolean

Truth Value.

nullable

Optional specValAssgmtRootSpecIntId

specValAssgmtRootSpecIntId: string

Sequential Number of Data Record. Maximum length: 20.

nullable

Optional specValAssgmtSortSequence

specValAssgmtSortSequence: string

Sort Order. Maximum length: 4.

nullable

specValAssgmtType

specValAssgmtType: string

Value Assignment Type. Maximum length: 30.

Optional specValAssgmtUnitRefDimension

specValAssgmtUnitRefDimension: string

Reference Value for Component Specification. Maximum length: 10.

nullable

Optional specValAssgmtUsageIsActive

specValAssgmtUsageIsActive: boolean

Activate Usage.

nullable

Optional specValAssgmtUsageIsExcluded

specValAssgmtUsageIsExcluded: boolean

Validity Area is Excluded.

nullable

Optional specValAssgmtUsageIsRelevant

specValAssgmtUsageIsRelevant: boolean

Relevant Change Has Been Made.

nullable

Optional specificationAuthznGroup

specificationAuthznGroup: string

Recipe Authorization Group. Maximum length: 10.

nullable

specificationInternalId

specificationInternalId: string

Sequential Number of Data Record. Maximum length: 20.

specificationRating

specificationRating: string

Rating. Maximum length: 10.

Optional specificationType

specificationType: string

Specification Type. Maximum length: 10.

nullable

specificationValidityArea

specificationValidityArea: string

Validity Area. Maximum length: 10.

Optional valueAssignmentSource

valueAssignmentSource: string

Value Assignment Source. Maximum length: 6.

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

All fields selector.

Static CHARACTERISTIC

CHARACTERISTIC: StringField<SpecCharByValueAssgmtInst> = new StringField('Characteristic', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_FORMAT

CHARACTERISTIC_FORMAT: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicFormat', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_INTERNAL_ID

CHARACTERISTIC_INTERNAL_ID: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicInternalID', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_IS_DELETED

CHARACTERISTIC_IS_DELETED: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('CharacteristicIsDeleted', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static CHARACTERISTIC_MAXIMUM_VALUE_UNIT

CHARACTERISTIC_MAXIMUM_VALUE_UNIT: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicMaximumValueUnit', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_MINIMUM_VALUE_UNIT

CHARACTERISTIC_MINIMUM_VALUE_UNIT: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicMinimumValueUnit', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_VALUE

CHARACTERISTIC_VALUE: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicValue', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARACTERISTIC_VALUE_DPNDCY_CODE

CHARACTERISTIC_VALUE_DPNDCY_CODE: StringField<SpecCharByValueAssgmtInst> = new StringField('CharacteristicValueDpndcyCode', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static CHARC_CURRENCY_MINIMUM_VALUE

CHARC_CURRENCY_MINIMUM_VALUE: BigNumberField<SpecCharByValueAssgmtInst> = new BigNumberField('CharcCurrencyMinimumValue', SpecCharByValueAssgmtInst, 'Edm.Decimal')

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

Static CHARC_DATE_MINIMUM_VALUE

CHARC_DATE_MINIMUM_VALUE: DateField<SpecCharByValueAssgmtInst> = new DateField('CharcDateMinimumValue', SpecCharByValueAssgmtInst, 'Edm.DateTime')

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

Static CHARC_DECIMAL_MAXIMUM_VALUE

CHARC_DECIMAL_MAXIMUM_VALUE: BigNumberField<SpecCharByValueAssgmtInst> = new BigNumberField('CharcDecimalMaximumValue', SpecCharByValueAssgmtInst, 'Edm.Decimal')

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

Static CHARC_DECIMAL_MINIMUM_VALUE

CHARC_DECIMAL_MINIMUM_VALUE: BigNumberField<SpecCharByValueAssgmtInst> = new BigNumberField('CharcDecimalMinimumValue', SpecCharByValueAssgmtInst, 'Edm.Decimal')

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

Static CHARC_TIME_MINIMUM_VALUE

CHARC_TIME_MINIMUM_VALUE: TimeField<SpecCharByValueAssgmtInst> = new TimeField('CharcTimeMinimumValue', SpecCharByValueAssgmtInst, 'Edm.Time')

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

Static CHARC_VALIDITY_END_DATE

CHARC_VALIDITY_END_DATE: DateField<SpecCharByValueAssgmtInst> = new DateField('CharcValidityEndDate', SpecCharByValueAssgmtInst, 'Edm.DateTime')

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

Static CHARC_VALIDITY_START_DATE

CHARC_VALIDITY_START_DATE: DateField<SpecCharByValueAssgmtInst> = new DateField('CharcValidityStartDate', SpecCharByValueAssgmtInst, 'Edm.DateTime')

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

Static CHARC_VALUE_UNIT

CHARC_VALUE_UNIT: StringField<SpecCharByValueAssgmtInst> = new StringField('CharcValueUnit', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static INHTD_SPEC_VAL_ASSGMT_IS_PERM_CHGD

INHTD_SPEC_VAL_ASSGMT_IS_PERM_CHGD: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('InhtdSpecValAssgmtIsPermChgd', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static INHTD_SPEC_VAL_ASSGMT_IS_TMP_CHGD

INHTD_SPEC_VAL_ASSGMT_IS_TMP_CHGD: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('InhtdSpecValAssgmtIsTmpChgd', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static SPECIFICATION_AUTHZN_GROUP

SPECIFICATION_AUTHZN_GROUP: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecificationAuthznGroup', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPECIFICATION_INTERNAL_ID

SPECIFICATION_INTERNAL_ID: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecificationInternalID', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPECIFICATION_RATING

SPECIFICATION_RATING: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecificationRating', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPECIFICATION_TYPE

SPECIFICATION_TYPE: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecificationType', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPECIFICATION_VALIDITY_AREA

SPECIFICATION_VALIDITY_AREA: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecificationValidityArea', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_INHERITANCE_TEMPLATE

SPEC_INHERITANCE_TEMPLATE: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecInheritanceTemplate', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT

SPEC_VAL_ASSGMT: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmt', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_HDR

SPEC_VAL_ASSGMT_HDR: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtHdr', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_INHERITANCE_PARENT

SPEC_VAL_ASSGMT_INHERITANCE_PARENT: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtInheritanceParent', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_INHERITANCE_ROOT

SPEC_VAL_ASSGMT_INHERITANCE_ROOT: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtInheritanceRoot', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_IS_INHTNC_SOURCE

SPEC_VAL_ASSGMT_IS_INHTNC_SOURCE: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('SpecValAssgmtIsInhtncSource', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static SPEC_VAL_ASSGMT_ROOT_SPEC_INT_ID

SPEC_VAL_ASSGMT_ROOT_SPEC_INT_ID: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtRootSpecIntID', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_SORT_SEQUENCE

SPEC_VAL_ASSGMT_SORT_SEQUENCE: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtSortSequence', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_TYPE

SPEC_VAL_ASSGMT_TYPE: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtType', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_UNIT_REF_DIMENSION

SPEC_VAL_ASSGMT_UNIT_REF_DIMENSION: StringField<SpecCharByValueAssgmtInst> = new StringField('SpecValAssgmtUnitRefDimension', SpecCharByValueAssgmtInst, 'Edm.String')

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

Static SPEC_VAL_ASSGMT_USAGE_IS_ACTIVE

SPEC_VAL_ASSGMT_USAGE_IS_ACTIVE: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('SpecValAssgmtUsageIsActive', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static SPEC_VAL_ASSGMT_USAGE_IS_EXCLUDED

SPEC_VAL_ASSGMT_USAGE_IS_EXCLUDED: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('SpecValAssgmtUsageIsExcluded', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static SPEC_VAL_ASSGMT_USAGE_IS_RELEVANT

SPEC_VAL_ASSGMT_USAGE_IS_RELEVANT: BooleanField<SpecCharByValueAssgmtInst> = new BooleanField('SpecValAssgmtUsageIsRelevant', SpecCharByValueAssgmtInst, 'Edm.Boolean')

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

Static VALUE_ASSIGNMENT_SOURCE

VALUE_ASSIGNMENT_SOURCE: StringField<SpecCharByValueAssgmtInst> = new StringField('ValueAssignmentSource', SpecCharByValueAssgmtInst, 'Edm.String')

Static representation of the valueAssignmentSource 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<SpecCharByValueAssgmtInst> | BooleanField<SpecCharByValueAssgmtInst> | BigNumberField<SpecCharByValueAssgmtInst> | DateField<SpecCharByValueAssgmtInst> | TimeField<SpecCharByValueAssgmtInst>> = [SpecCharByValueAssgmtInst.SPECIFICATION_INTERNAL_ID,SpecCharByValueAssgmtInst.SPEC_INHERITANCE_TEMPLATE,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_INHERITANCE_PARENT,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_INHERITANCE_ROOT,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_ROOT_SPEC_INT_ID,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_SORT_SEQUENCE,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_UNIT_REF_DIMENSION,SpecCharByValueAssgmtInst.VALUE_ASSIGNMENT_SOURCE,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_USAGE_IS_EXCLUDED,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_USAGE_IS_ACTIVE,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_USAGE_IS_RELEVANT,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_TYPE,SpecCharByValueAssgmtInst.SPECIFICATION_AUTHZN_GROUP,SpecCharByValueAssgmtInst.SPECIFICATION_TYPE,SpecCharByValueAssgmtInst.CHARACTERISTIC,SpecCharByValueAssgmtInst.CHARACTERISTIC_FORMAT,SpecCharByValueAssgmtInst.CHARACTERISTIC_VALUE,SpecCharByValueAssgmtInst.CHARC_DECIMAL_MINIMUM_VALUE,SpecCharByValueAssgmtInst.CHARACTERISTIC_MINIMUM_VALUE_UNIT,SpecCharByValueAssgmtInst.CHARC_DECIMAL_MAXIMUM_VALUE,SpecCharByValueAssgmtInst.CHARACTERISTIC_MAXIMUM_VALUE_UNIT,SpecCharByValueAssgmtInst.CHARACTERISTIC_VALUE_DPNDCY_CODE,SpecCharByValueAssgmtInst.SPECIFICATION_RATING,SpecCharByValueAssgmtInst.CHARC_VALIDITY_START_DATE,SpecCharByValueAssgmtInst.CHARC_VALIDITY_END_DATE,SpecCharByValueAssgmtInst.CHARACTERISTIC_IS_DELETED,SpecCharByValueAssgmtInst.CHARC_CURRENCY_MINIMUM_VALUE,SpecCharByValueAssgmtInst.CHARC_VALUE_UNIT,SpecCharByValueAssgmtInst.CHARC_DATE_MINIMUM_VALUE,SpecCharByValueAssgmtInst.CHARC_TIME_MINIMUM_VALUE,SpecCharByValueAssgmtInst.CHARACTERISTIC_INTERNAL_ID,SpecCharByValueAssgmtInst.SPECIFICATION_VALIDITY_AREA,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_HDR,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT,SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_IS_INHTNC_SOURCE,SpecCharByValueAssgmtInst.INHTD_SPEC_VAL_ASSGMT_IS_TMP_CHGD,SpecCharByValueAssgmtInst.INHTD_SPEC_VAL_ASSGMT_IS_PERM_CHGD]

All fields of the SpecCharByValueAssgmtInst entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SpecCharByValueAssgmtInst"

Technical entity name for SpecCharByValueAssgmtInst.

Static _keyFields

_keyFields: Array<Selectable<SpecCharByValueAssgmtInst>> = [SpecCharByValueAssgmtInst.SPECIFICATION_INTERNAL_ID, SpecCharByValueAssgmtInst.SPEC_VAL_ASSGMT_TYPE, SpecCharByValueAssgmtInst.SPECIFICATION_RATING, SpecCharByValueAssgmtInst.SPECIFICATION_VALIDITY_AREA]

All key fields of the SpecCharByValueAssgmtInst entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_REALSUBSTANCE"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SpecCharByValueAssgmtInst>

    A builder that constructs instances of entity type SpecCharByValueAssgmtInst.

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

    Returns SpecCharByValueAssgmtInstRequestBuilder

    A SpecCharByValueAssgmtInst request builder.