Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_DocumentInfoRecordCharcValue" of service "API_DMS_PROCESS_SRV". This service is part of the following communication scenarios: Product Lifecycle Management - Master Data Integration (SAP_COM_0105). See https://api.sap.com/api/API_DMS_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • DocumentInfoRecordCharcValue

Implements

Index

Constructors

constructor

  • Returns DocumentInfoRecordCharcValue

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 characteristicAuthor

characteristicAuthor: string

Classification: Author. Maximum length: 1.

nullable

Optional charcFromAmount

charcFromAmount: BigNumber

Lower Boundary for Currency Field.

nullable

Optional charcFromDate

charcFromDate: Moment

Lower Boundary for Date-Interval.

nullable

Optional charcFromDecimalValue

charcFromDecimalValue: BigNumber

Lower Boundary for Numeric Field.

nullable

Optional charcFromNumericValue

charcFromNumericValue: number

Internal floating point from.

nullable

Optional charcFromNumericValueUnit

charcFromNumericValueUnit: 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 charcFromTime

charcFromTime: Time

Lower Boundary for Time-Interval.

nullable

charcInternalId

charcInternalId: string

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

Optional charcMaintAuthGrp

charcMaintAuthGrp: 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 charcToAmount

charcToAmount: BigNumber

Upper Boundary for Currency Field.

nullable

Optional charcToDate

charcToDate: Moment

Upper Boundary for Date-Interval.

nullable

Optional charcToDecimalValue

charcToDecimalValue: BigNumber

Upper Boundary for Numeric Field.

nullable

Optional charcToNumericValue

charcToNumericValue: number

Internal floating point value to.

nullable

Optional charcToNumericValueUnit

charcToNumericValueUnit: 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 charcToTime

charcToTime: Time

Upper Boundary for Time-Interval.

nullable

Optional charcValue

charcValue: string

Characteristic Value. Value of a characteristic. If the characteristic has character format (CHAR), this field contains a single character string.Values in time format (TIME) must have the format HH:MM:SS. The separators are set automatically. Example: 112855 --> 11:28:55The values in date format (DATE) must have the format DD.MM.YYYY. The separators are set automatically. Example: 110100 --> 11.01.2000NoteIf you valuate validity parameters, you cannot specify intervals. You can only specify individual values.The following description does not apply to the valuation of validity parameters:If the characteristic format is numeric (NUM), time (TIME), or date (DATE), you can enter a number or (if allowed) an interval.Intervals are written in the following format:Value1 - Value2 (from Value1 to Value2)>Value1 (greater than Value1)>=Value1 (greater than or equal to Value1)<Value2 (less than Value2)<=Value2 (less than or equal to Value2)>Value1 - <Value2 (greater than Value1 and less than Value2)Value1 - <Value2 (greater than or equal to Value1 and less thanValue2)>Value1 - Value2 (greater than Value1 and less than or equal toValue2)If the characteristic has more than one value, you can enter multiple values separated by semicolons.If you have maintained a unit of measure for numeric values in the formatting data of the characteristic, the unit is displayed automatically when you confirm.NoteIf you want to define intervals as allowed values of a characteristic, you must define the characteristic as "multiple-value" when you maintain the characteristic in the Classification System. This also allows you to enter more than one interval.However, if you assign more than one interval to a characteristic of a class during configuration (for example, 1-2 and 5-6 for characteristic LENGTH), the system only reads one of the intervals when generating an inspection lot in QM. To avoid this problem, do NOT assign more than one interval to a characteristic. Maximum length: 70.

nullable

Optional charcValueDependency

charcValueDependency: string

Code for value dependency. When defining values, intervals can be defined such that the FROM value or TO value is given an operator. Example: 1.54>-<2.088The coding of the individual possible entries is described below.Code Operator Value1 Operator Value21 EQ2 GE LT3 GE LE4 GT LT5 GT LE6 LT7 LE8 GT9 GE. Maximum length: 1.

nullable

charcValuePositionNumber

charcValuePositionNumber: string

Characteristic value counter. Maximum length: 3.

classType

classType: string

Class Type. Uniquely identifies the class type. Maximum length: 3.

Optional currency

currency: string

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

nullable

documentInfoRecordDocNumber

documentInfoRecordDocNumber: string

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

documentInfoRecordDocPart

documentInfoRecordDocPart: 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.

documentInfoRecordDocType

documentInfoRecordDocType: 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.

documentInfoRecordDocVersion

documentInfoRecordDocVersion: 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.

Optional keyDate

keyDate: Moment

Key Date.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static CHARACTERISTIC_AUTHOR

CHARACTERISTIC_AUTHOR: StringField<DocumentInfoRecordCharcValue> = new StringField('CharacteristicAuthor', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CHARC_FROM_AMOUNT

CHARC_FROM_AMOUNT: BigNumberField<DocumentInfoRecordCharcValue> = new BigNumberField('CharcFromAmount', DocumentInfoRecordCharcValue, 'Edm.Decimal')

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

Static CHARC_FROM_DATE

CHARC_FROM_DATE: DateField<DocumentInfoRecordCharcValue> = new DateField('CharcFromDate', DocumentInfoRecordCharcValue, 'Edm.DateTime')

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

Static CHARC_FROM_DECIMAL_VALUE

CHARC_FROM_DECIMAL_VALUE: BigNumberField<DocumentInfoRecordCharcValue> = new BigNumberField('CharcFromDecimalValue', DocumentInfoRecordCharcValue, 'Edm.Decimal')

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

Static CHARC_FROM_NUMERIC_VALUE

CHARC_FROM_NUMERIC_VALUE: NumberField<DocumentInfoRecordCharcValue> = new NumberField('CharcFromNumericValue', DocumentInfoRecordCharcValue, 'Edm.Double')

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

Static CHARC_FROM_NUMERIC_VALUE_UNIT

CHARC_FROM_NUMERIC_VALUE_UNIT: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcFromNumericValueUnit', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CHARC_FROM_TIME

CHARC_FROM_TIME: TimeField<DocumentInfoRecordCharcValue> = new TimeField('CharcFromTime', DocumentInfoRecordCharcValue, 'Edm.Time')

Static representation of the charcFromTime 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<DocumentInfoRecordCharcValue> = new StringField('CharcInternalID', DocumentInfoRecordCharcValue, '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_MAINT_AUTH_GRP

CHARC_MAINT_AUTH_GRP: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcMaintAuthGrp', DocumentInfoRecordCharcValue, '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_TO_AMOUNT

CHARC_TO_AMOUNT: BigNumberField<DocumentInfoRecordCharcValue> = new BigNumberField('CharcToAmount', DocumentInfoRecordCharcValue, 'Edm.Decimal')

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

Static CHARC_TO_DATE

CHARC_TO_DATE: DateField<DocumentInfoRecordCharcValue> = new DateField('CharcToDate', DocumentInfoRecordCharcValue, 'Edm.DateTime')

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

Static CHARC_TO_DECIMAL_VALUE

CHARC_TO_DECIMAL_VALUE: BigNumberField<DocumentInfoRecordCharcValue> = new BigNumberField('CharcToDecimalValue', DocumentInfoRecordCharcValue, 'Edm.Decimal')

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

Static CHARC_TO_NUMERIC_VALUE

CHARC_TO_NUMERIC_VALUE: NumberField<DocumentInfoRecordCharcValue> = new NumberField('CharcToNumericValue', DocumentInfoRecordCharcValue, 'Edm.Double')

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

Static CHARC_TO_NUMERIC_VALUE_UNIT

CHARC_TO_NUMERIC_VALUE_UNIT: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcToNumericValueUnit', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CHARC_TO_TIME

CHARC_TO_TIME: TimeField<DocumentInfoRecordCharcValue> = new TimeField('CharcToTime', DocumentInfoRecordCharcValue, 'Edm.Time')

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

Static CHARC_VALUE

CHARC_VALUE: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcValue', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CHARC_VALUE_DEPENDENCY

CHARC_VALUE_DEPENDENCY: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcValueDependency', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CHARC_VALUE_POSITION_NUMBER

CHARC_VALUE_POSITION_NUMBER: StringField<DocumentInfoRecordCharcValue> = new StringField('CharcValuePositionNumber', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CLASS_TYPE

CLASS_TYPE: StringField<DocumentInfoRecordCharcValue> = new StringField('ClassType', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static CURRENCY

CURRENCY: StringField<DocumentInfoRecordCharcValue> = new StringField('Currency', DocumentInfoRecordCharcValue, '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 DOCUMENT_INFO_RECORD_DOC_NUMBER

DOCUMENT_INFO_RECORD_DOC_NUMBER: StringField<DocumentInfoRecordCharcValue> = new StringField('DocumentInfoRecordDocNumber', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_PART

DOCUMENT_INFO_RECORD_DOC_PART: StringField<DocumentInfoRecordCharcValue> = new StringField('DocumentInfoRecordDocPart', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_TYPE

DOCUMENT_INFO_RECORD_DOC_TYPE: StringField<DocumentInfoRecordCharcValue> = new StringField('DocumentInfoRecordDocType', DocumentInfoRecordCharcValue, 'Edm.String')

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

Static DOCUMENT_INFO_RECORD_DOC_VERSION

DOCUMENT_INFO_RECORD_DOC_VERSION: StringField<DocumentInfoRecordCharcValue> = new StringField('DocumentInfoRecordDocVersion', DocumentInfoRecordCharcValue, 'Edm.String')

Static representation of the documentInfoRecordDocVersion 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<DocumentInfoRecordCharcValue> = new DateField('KeyDate', DocumentInfoRecordCharcValue, '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 _allFields

_allFields: Array<StringField<DocumentInfoRecordCharcValue> | DateField<DocumentInfoRecordCharcValue> | NumberField<DocumentInfoRecordCharcValue> | BigNumberField<DocumentInfoRecordCharcValue> | TimeField<DocumentInfoRecordCharcValue>> = [DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_TYPE,DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_NUMBER,DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_VERSION,DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_PART,DocumentInfoRecordCharcValue.CLASS_TYPE,DocumentInfoRecordCharcValue.CHARC_INTERNAL_ID,DocumentInfoRecordCharcValue.CHARC_VALUE_POSITION_NUMBER,DocumentInfoRecordCharcValue.KEY_DATE,DocumentInfoRecordCharcValue.CHARC_VALUE_DEPENDENCY,DocumentInfoRecordCharcValue.CHARC_VALUE,DocumentInfoRecordCharcValue.CHARC_FROM_NUMERIC_VALUE,DocumentInfoRecordCharcValue.CHARC_FROM_NUMERIC_VALUE_UNIT,DocumentInfoRecordCharcValue.CHARC_TO_NUMERIC_VALUE,DocumentInfoRecordCharcValue.CHARC_TO_NUMERIC_VALUE_UNIT,DocumentInfoRecordCharcValue.CHARC_FROM_DECIMAL_VALUE,DocumentInfoRecordCharcValue.CHARC_TO_DECIMAL_VALUE,DocumentInfoRecordCharcValue.CHARC_FROM_AMOUNT,DocumentInfoRecordCharcValue.CHARC_TO_AMOUNT,DocumentInfoRecordCharcValue.CURRENCY,DocumentInfoRecordCharcValue.CHARC_FROM_DATE,DocumentInfoRecordCharcValue.CHARC_TO_DATE,DocumentInfoRecordCharcValue.CHARC_FROM_TIME,DocumentInfoRecordCharcValue.CHARC_TO_TIME,DocumentInfoRecordCharcValue.CHARACTERISTIC_AUTHOR,DocumentInfoRecordCharcValue.CHARC_MAINT_AUTH_GRP]

All fields of the DocumentInfoRecordCharcValue entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_DocumentInfoRecordCharcValue"

Technical entity name for DocumentInfoRecordCharcValue.

Static _keyFields

_keyFields: Array<Selectable<DocumentInfoRecordCharcValue>> = [DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_TYPE, DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_NUMBER, DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_VERSION, DocumentInfoRecordCharcValue.DOCUMENT_INFO_RECORD_DOC_PART, DocumentInfoRecordCharcValue.CLASS_TYPE, DocumentInfoRecordCharcValue.CHARC_INTERNAL_ID, DocumentInfoRecordCharcValue.CHARC_VALUE_POSITION_NUMBER]

All key fields of the DocumentInfoRecordCharcValue entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_DMS_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<DocumentInfoRecordCharcValue>

    A builder that constructs instances of entity type DocumentInfoRecordCharcValue.

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

    Returns DocumentInfoRecordCharcValueRequestBuilder

    A DocumentInfoRecordCharcValue request builder.