Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ClfnCharacteristicForKeyDate" of service "API_CLFN_CHARACTERISTIC_SRV". This service is part of the following communication scenarios: Classification Systems OData Integration (SAP_COM_0163). See https://api.sap.com/api/API_CLFN_CHARACTERISTIC_SRV for more information.

Hierarchy

  • Entity
    • ClfnCharacteristicForKeyDate

Implements

Index

Constructors

Properties

Accessors

Methods

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

Optional additionalValueIsAllowed

additionalValueIsAllowed: undefined | false | true

Checkbox.

nullable

Optional changeNumber

changeNumber: undefined | string

Change Number. Number used to uniquely identify a change master record. If you make a change with reference to a change number, or create anobject with a change number, the following functions are at your disposal:The system determines the effectivity parametersThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date effectivity (valid from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation for the changesRevision level to indicate the change status of a material or documentChanges released for the different areas in the company. Maximum length: 12.

nullable

Optional characteristic

characteristic: undefined | string

Characteristic Name. Name that uniquely identifies a characteristic. Maximum length: 30.

nullable

Optional charcDataType

charcDataType: undefined | string

Data type of characteristic. Data type of a characteristic's values. The data type defines whether a characteristic value is a character string, a number, a date, or a time. Maximum length: 4.

nullable

Optional charcDecimals

charcDecimals: undefined | number

Number of Decimal Places. Number of decimal places which can be entered when you assign a value to this characteristic. The number of decimal places must be less than the number of characters.

nullable

Optional charcEntryIsNotFormatCtrld

charcEntryIsNotFormatCtrld: undefined | false | true

Checkbox.

nullable

Optional charcExponentFormat

charcExponentFormat: undefined | string

Exponent Display Format. Specifies how the numerical value of a characteristic is to be displayed with an exponent. The indicators mean the following:0 = Display without an exponent1 = Exponent is set automatically.There is always one place before the decimal point.Example: ,__E+2 = Display with exponent entered.Example: _,____E+333 = Display in scientific format (3, 6, 9)There are always three places before the decimal point.Example: _,_____E+SS. Maximum length: 1.

nullable

Optional charcExponentValue

charcExponentValue: undefined | number

Exponent display. Exponent used when characteristic value is dislayed.

nullable

Optional charcGroup

charcGroup: undefined | string

Characteristics Group. The characteristics group can be used to group together similar characteristics. It is used to make finding characteristics easier. Maximum length: 10.

nullable

Optional charcGroupName

charcGroupName: undefined | string

Characteristics Group Description. Maximum length: 40.

nullable

charcInternalId

charcInternalId: string

Internal characteristic number without conversion routine. Maximum length: 10.

Optional charcIsHidden

charcIsHidden: undefined | false | true

Checkbox.

nullable

Optional charcIsReadOnly

charcIsReadOnly: undefined | false | true

Checkbox.

nullable

Optional charcLastChangedDateTime

charcLastChangedDateTime: Moment

UTC Time Stamp in Long Form (YYYYMMDDhhmmssmmmuuun). The UTC timestamp displays date and time according to UTC (Universal Coordinated Time). In order to convert local time into a UTC time stamp, which makes it easier to compare times, the local time must be converted according to your time zone. The ABAP command convert is available for this purpose.Even if the time zone that the conversion is based on can be redetermined from Customizing or master data, we still recommend that you save the time zone.The internal structure of the high-resolution UTC time stamp is logically organized in date and time sections in a packed decimal format (YYYYMMDDhhmmssmmmuuun), which depicts the year, month, day, hour,second, millisecond, microsecond and the first decimal of the nanoseconds. Please note that the hardware that is normally used does not fully support a resolution of 100 nanoseconds, which is available in the structure.See also GET TIME STAMPA UTC time stamp in short form is also available.

nullable

Optional charcLength

charcLength: undefined | number

Number of Characters. Total number of characters that you can enter when you assign a value to this characteristic. This figure includes the number of decimal places. This figure does not include plus or minus signs or decimal points.Further HintsIf a characteristic has data type "character" (CHAR), you can maintain a language-dependent description for values. This description can be up to 30 characters long, regardless of the number you enter here.

nullable

Optional charcMaintAuthGrp

charcMaintAuthGrp: undefined | string

Authorization Group for Characteristics Maintenance. This key defines whether a user is allowed to maintain this characteristic. This authorization must be defined in the user master record.The authorization object is C_CABN_GRP. Maximum length: 3.

nullable

Optional charcStatus

charcStatus: undefined | string

Status of a characteristic. The characteristic status gives information on the processing status of the characteristic and determines whether it can be used elsewhere in the system. Maximum length: 1.

nullable

Optional charcStatusName

charcStatusName: undefined | string

Characteristic Status. Maximum length: 20.

nullable

Optional charcTemplate

charcTemplate: undefined | string

Value with template. Entries for this characteristic are checked against this template. Numeric format (NUM):You can maintain a numeric template during characteristic maintenance on the Basic Data tab.The separator for thousands (period or comma) is taken from the values in the user master record. Manual entry of this separator is optional.If you want negative values to be allowed, this can be defined by entering a left-justified or right-justified minus sign.There are three options for displaying figures with an exponent:1. Standard formatThe exponent is set automatically. There is exactly one place before the decimal point.2. Predefined exponentEach figure is automatically scaled to the predefined exponent.3. Scientific formatThe exponent is set automatically in steps of 3. There are exactly three places before the decimal point.The exponent must always be positioned directly after the mantissa.As an aid to entry, you also have the option of entering a unit directly next to the exponent. This unit is subsequently ignored in characteristics maintenance in template selection. Maximum length: 70.

nullable

Optional charcTemplateIsDisplayed

charcTemplateIsDisplayed: undefined | false | true

Checkbox.

nullable

Optional charcValueUnit

charcValueUnit: undefined | string

Unit of Measurement. Internal, language-independent, measurement unit format. This format is used for internal processing.The internal format is automatically replaced by either the external commercial (three-character) or technical (six-character) format before output to the screen. Maximum length: 3.

nullable

Optional creationDate

creationDate: Moment

Date on Which Record Was Created.

nullable

Optional currency

currency: undefined | string

Currency Key. Key for the currency in which the amounts are managed in the system. Maximum length: 5.

nullable

Optional currencyIsoCode

currencyIsoCode: undefined | string

ISO Currency Code. International standardized currency key Enter the ISO codeif you do not already use the global standard currency key as the currency keyif you use the EDI application. Here the ISO code is used for exchanging information. Maximum length: 3.

nullable

Optional docNumber

docNumber: undefined | string

Document number. This number is the main part of the document key, which is used to identify the document. Maximum length: 25.

nullable

Optional documentPart

documentPart: undefined | string

Document part. Section of a document which is maintained as an independent document. Design departments, for example, can use document parts to divide up large documents such as design drawings into pages. Maximum length: 3.

nullable

Optional documentType

documentType: undefined | string

Document Type. Part of the document key, which categorizes documents according to their distinguishing features and the organizational procedures which result from them. Maximum length: 3.

nullable

Optional documentVersion

documentVersion: undefined | string

Document version. Number which identifies the version of a document. A new version is assigned after the original files have been edited in the following processing situations:The new processing status varies from the original in a certain way (for example, text change sin a text file).You want the original processing status to remain the same (for example, documentation of project progress). Maximum length: 2.

nullable

Optional entryIsRequired

entryIsRequired: undefined | false | true

Checkbox.

nullable

Optional keyDate

keyDate: Moment

Key Date.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional multipleValuesAreAllowed

multipleValuesAreAllowed: undefined | false | true

Checkbox.

nullable

Optional negativeValueIsAllowed

negativeValueIsAllowed: undefined | false | true

Value with Plus or Minus Sign. Defines whether negative values can be assigned to a characteristic.

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

toCharacteristicDesc

toCharacteristicDesc: ClfnCharcDescForKeyDate[]

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

toCharacteristicReference

toCharacteristicReference: ClfnCharcRefForKeyDate[]

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

toCharacteristicRestriction

toCharacteristicRestriction: ClfnCharcRstrcnForKeyDate[]

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

toCharacteristicValue

toCharacteristicValue: ClfnCharcValueForKeyDate[]

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

Optional unitOfMeasureIsoCode

unitOfMeasureIsoCode: undefined | string

ISO code for unit of measurement. ISO code for measurement units. An ISO code can be assigned to several internal measurement units of a dimension. The ISO code is important for EDI. It is used to convert the internal SAP measurement units into standard measurement units. Data exchange via EDI requires internal measurement units to be converted into standard measurement units.A list of the current internationally agreed ISO codes can be ordered from the UN commission responsible (WP.4 Trade Facilitation Recommendations, Recommendation 20):UN Economic Commission for EuropeInformation OfficePalais des Nations1211 GenevaSwitzerlande-mail: info.ece@unece.orgor viewed directly on the Internet:http://www.unece.org/cefact/codesfortrade/codes_index.htmFor more information, see SAP Note 69063. Maximum length: 3.

nullable

Optional validityEndDate

validityEndDate: Moment

Valid-to date. End of validity period of an object (such as material, BOM, or routing) in the SAP System.

nullable

Optional validityStartDate

validityStartDate: Moment

Valid-From Date. Specifies the start date for the validity period of an object (such as material, BOM, or routing).

nullable

Optional valueIntervalIsAllowed

valueIntervalIsAllowed: undefined | false | true

Checkbox.

nullable

Optional valueIsCaseSensitive

valueIsCaseSensitive: undefined | false | true

Case Sensitive. This indicator determines whether lower-case letters can be entered in characteristic values. If this field is blank, the characteristic values entered are automatically converted into upper-case letters.

nullable

Static ADDITIONAL_VALUE_IS_ALLOWED

ADDITIONAL_VALUE_IS_ALLOWED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('AdditionalValueIsAllowed', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static ALL_FIELDS

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

All fields selector.

Static CHANGE_NUMBER

CHANGE_NUMBER: StringField<ClfnCharacteristicForKeyDate> = new StringField('ChangeNumber', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARACTERISTIC

CHARACTERISTIC: StringField<ClfnCharacteristicForKeyDate> = new StringField('Characteristic', ClfnCharacteristicForKeyDate, '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 CHARC_DATA_TYPE

CHARC_DATA_TYPE: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcDataType', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_DECIMALS

CHARC_DECIMALS: NumberField<ClfnCharacteristicForKeyDate> = new NumberField('CharcDecimals', ClfnCharacteristicForKeyDate, 'Edm.Int16')

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

Static CHARC_ENTRY_IS_NOT_FORMAT_CTRLD

CHARC_ENTRY_IS_NOT_FORMAT_CTRLD: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('CharcEntryIsNotFormatCtrld', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static CHARC_EXPONENT_FORMAT

CHARC_EXPONENT_FORMAT: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcExponentFormat', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_EXPONENT_VALUE

CHARC_EXPONENT_VALUE: NumberField<ClfnCharacteristicForKeyDate> = new NumberField('CharcExponentValue', ClfnCharacteristicForKeyDate, 'Edm.Int16')

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

Static CHARC_GROUP

CHARC_GROUP: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcGroup', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_GROUP_NAME

CHARC_GROUP_NAME: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcGroupName', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_INTERNAL_ID

CHARC_INTERNAL_ID: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcInternalID', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_IS_HIDDEN

CHARC_IS_HIDDEN: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('CharcIsHidden', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static CHARC_IS_READ_ONLY

CHARC_IS_READ_ONLY: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('CharcIsReadOnly', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static CHARC_LAST_CHANGED_DATE_TIME

CHARC_LAST_CHANGED_DATE_TIME: DateField<ClfnCharacteristicForKeyDate> = new DateField('CharcLastChangedDateTime', ClfnCharacteristicForKeyDate, 'Edm.DateTimeOffset')

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

Static CHARC_LENGTH

CHARC_LENGTH: NumberField<ClfnCharacteristicForKeyDate> = new NumberField('CharcLength', ClfnCharacteristicForKeyDate, 'Edm.Int16')

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

Static CHARC_MAINT_AUTH_GRP

CHARC_MAINT_AUTH_GRP: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcMaintAuthGrp', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_STATUS

CHARC_STATUS: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcStatus', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_STATUS_NAME

CHARC_STATUS_NAME: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcStatusName', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_TEMPLATE

CHARC_TEMPLATE: StringField<ClfnCharacteristicForKeyDate> = new StringField('CharcTemplate', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CHARC_TEMPLATE_IS_DISPLAYED

CHARC_TEMPLATE_IS_DISPLAYED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('CharcTemplateIsDisplayed', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

Static representation of the charcTemplateIsDisplayed 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<ClfnCharacteristicForKeyDate> = new StringField('CharcValueUnit', ClfnCharacteristicForKeyDate, '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 CREATION_DATE

CREATION_DATE: DateField<ClfnCharacteristicForKeyDate> = new DateField('CreationDate', ClfnCharacteristicForKeyDate, 'Edm.DateTime')

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

Static CURRENCY

CURRENCY: StringField<ClfnCharacteristicForKeyDate> = new StringField('Currency', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static CURRENCY_ISO_CODE

CURRENCY_ISO_CODE: StringField<ClfnCharacteristicForKeyDate> = new StringField('CurrencyISOCode', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static DOCUMENT_PART

DOCUMENT_PART: StringField<ClfnCharacteristicForKeyDate> = new StringField('DocumentPart', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static DOCUMENT_TYPE

DOCUMENT_TYPE: StringField<ClfnCharacteristicForKeyDate> = new StringField('DocumentType', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static DOCUMENT_VERSION

DOCUMENT_VERSION: StringField<ClfnCharacteristicForKeyDate> = new StringField('DocumentVersion', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static DOC_NUMBER

DOC_NUMBER: StringField<ClfnCharacteristicForKeyDate> = new StringField('DocNumber', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static ENTRY_IS_REQUIRED

ENTRY_IS_REQUIRED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('EntryIsRequired', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static KEY_DATE

KEY_DATE: DateField<ClfnCharacteristicForKeyDate> = new DateField('KeyDate', ClfnCharacteristicForKeyDate, 'Edm.DateTime')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<ClfnCharacteristicForKeyDate> = new DateField('LastChangeDate', ClfnCharacteristicForKeyDate, 'Edm.DateTime')

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

Static MULTIPLE_VALUES_ARE_ALLOWED

MULTIPLE_VALUES_ARE_ALLOWED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('MultipleValuesAreAllowed', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static NEGATIVE_VALUE_IS_ALLOWED

NEGATIVE_VALUE_IS_ALLOWED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('NegativeValueIsAllowed', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static TO_CHARACTERISTIC_DESC

TO_CHARACTERISTIC_DESC: Link<ClfnCharacteristicForKeyDate, ClfnCharcDescForKeyDate> = new Link('to_CharacteristicDesc', ClfnCharacteristicForKeyDate, ClfnCharcDescForKeyDate)

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

Static TO_CHARACTERISTIC_REFERENCE

TO_CHARACTERISTIC_REFERENCE: Link<ClfnCharacteristicForKeyDate, ClfnCharcRefForKeyDate> = new Link('to_CharacteristicReference', ClfnCharacteristicForKeyDate, ClfnCharcRefForKeyDate)

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

Static TO_CHARACTERISTIC_RESTRICTION

TO_CHARACTERISTIC_RESTRICTION: Link<ClfnCharacteristicForKeyDate, ClfnCharcRstrcnForKeyDate> = new Link('to_CharacteristicRestriction', ClfnCharacteristicForKeyDate, ClfnCharcRstrcnForKeyDate)

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

Static TO_CHARACTERISTIC_VALUE

TO_CHARACTERISTIC_VALUE: Link<ClfnCharacteristicForKeyDate, ClfnCharcValueForKeyDate> = new Link('to_CharacteristicValue', ClfnCharacteristicForKeyDate, ClfnCharcValueForKeyDate)

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

Static UNIT_OF_MEASURE_ISO_CODE

UNIT_OF_MEASURE_ISO_CODE: StringField<ClfnCharacteristicForKeyDate> = new StringField('UnitOfMeasureISOCode', ClfnCharacteristicForKeyDate, 'Edm.String')

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<ClfnCharacteristicForKeyDate> = new DateField('ValidityEndDate', ClfnCharacteristicForKeyDate, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<ClfnCharacteristicForKeyDate> = new DateField('ValidityStartDate', ClfnCharacteristicForKeyDate, 'Edm.DateTime')

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

Static VALUE_INTERVAL_IS_ALLOWED

VALUE_INTERVAL_IS_ALLOWED: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('ValueIntervalIsAllowed', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

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

Static VALUE_IS_CASE_SENSITIVE

VALUE_IS_CASE_SENSITIVE: BooleanField<ClfnCharacteristicForKeyDate> = new BooleanField('ValueIsCaseSensitive', ClfnCharacteristicForKeyDate, 'Edm.Boolean')

Static representation of the valueIsCaseSensitive 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<ClfnCharacteristicForKeyDate> | NumberField<ClfnCharacteristicForKeyDate> | BooleanField<ClfnCharacteristicForKeyDate> | DateField<ClfnCharacteristicForKeyDate> | Link<ClfnCharacteristicForKeyDate, ClfnCharcDescForKeyDate> | Link<ClfnCharacteristicForKeyDate, ClfnCharcRefForKeyDate> | Link<ClfnCharacteristicForKeyDate, ClfnCharcRstrcnForKeyDate> | Link<ClfnCharacteristicForKeyDate, ClfnCharcValueForKeyDate>> = [ClfnCharacteristicForKeyDate.CHARC_INTERNAL_ID,ClfnCharacteristicForKeyDate.CHARACTERISTIC,ClfnCharacteristicForKeyDate.CHARC_STATUS,ClfnCharacteristicForKeyDate.CHARC_STATUS_NAME,ClfnCharacteristicForKeyDate.CHARC_DATA_TYPE,ClfnCharacteristicForKeyDate.CHARC_LENGTH,ClfnCharacteristicForKeyDate.CHARC_DECIMALS,ClfnCharacteristicForKeyDate.CHARC_TEMPLATE,ClfnCharacteristicForKeyDate.VALUE_IS_CASE_SENSITIVE,ClfnCharacteristicForKeyDate.CHARC_GROUP,ClfnCharacteristicForKeyDate.CHARC_GROUP_NAME,ClfnCharacteristicForKeyDate.ENTRY_IS_REQUIRED,ClfnCharacteristicForKeyDate.MULTIPLE_VALUES_ARE_ALLOWED,ClfnCharacteristicForKeyDate.CHARC_VALUE_UNIT,ClfnCharacteristicForKeyDate.UNIT_OF_MEASURE_ISO_CODE,ClfnCharacteristicForKeyDate.CURRENCY,ClfnCharacteristicForKeyDate.CURRENCY_ISO_CODE,ClfnCharacteristicForKeyDate.CHARC_EXPONENT_VALUE,ClfnCharacteristicForKeyDate.VALUE_INTERVAL_IS_ALLOWED,ClfnCharacteristicForKeyDate.ADDITIONAL_VALUE_IS_ALLOWED,ClfnCharacteristicForKeyDate.NEGATIVE_VALUE_IS_ALLOWED,ClfnCharacteristicForKeyDate.VALIDITY_START_DATE,ClfnCharacteristicForKeyDate.VALIDITY_END_DATE,ClfnCharacteristicForKeyDate.CHANGE_NUMBER,ClfnCharacteristicForKeyDate.DOCUMENT_TYPE,ClfnCharacteristicForKeyDate.DOC_NUMBER,ClfnCharacteristicForKeyDate.DOCUMENT_VERSION,ClfnCharacteristicForKeyDate.DOCUMENT_PART,ClfnCharacteristicForKeyDate.CHARC_MAINT_AUTH_GRP,ClfnCharacteristicForKeyDate.CHARC_IS_READ_ONLY,ClfnCharacteristicForKeyDate.CHARC_IS_HIDDEN,ClfnCharacteristicForKeyDate.CHARC_EXPONENT_FORMAT,ClfnCharacteristicForKeyDate.CHARC_ENTRY_IS_NOT_FORMAT_CTRLD,ClfnCharacteristicForKeyDate.CHARC_TEMPLATE_IS_DISPLAYED,ClfnCharacteristicForKeyDate.CREATION_DATE,ClfnCharacteristicForKeyDate.LAST_CHANGE_DATE,ClfnCharacteristicForKeyDate.CHARC_LAST_CHANGED_DATE_TIME,ClfnCharacteristicForKeyDate.KEY_DATE,ClfnCharacteristicForKeyDate.TO_CHARACTERISTIC_DESC,ClfnCharacteristicForKeyDate.TO_CHARACTERISTIC_REFERENCE,ClfnCharacteristicForKeyDate.TO_CHARACTERISTIC_RESTRICTION,ClfnCharacteristicForKeyDate.TO_CHARACTERISTIC_VALUE]

All fields of the ClfnCharacteristicForKeyDate entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ClfnCharacteristicForKeyDate"

Technical entity name for ClfnCharacteristicForKeyDate.

Static _keyFields

_keyFields: Array<Selectable<ClfnCharacteristicForKeyDate>> = [ClfnCharacteristicForKeyDate.CHARC_INTERNAL_ID]

All key fields of the ClfnCharacteristicForKeyDate entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CLFN_CHARACTERISTIC_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ClfnCharacteristicForKeyDate>

    A builder that constructs instances of entity type ClfnCharacteristicForKeyDate.

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

    Returns ClfnCharacteristicForKeyDateRequestBuilder

    A ClfnCharacteristicForKeyDate request builder.