Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CharcAttribSeldSetCode" of service "API_CHARCATTRIBUTECATALOG_SRV_01". This service is part of the following communication scenarios: Inspection Master Data Integration (SAP_COM_0110). See https://api.sap.com/api/API_CHARCATTRIBUTECATALOG_SRV for more information.

Hierarchy

  • Entity
    • CharcAttribSeldSetCode

Implements

Index

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

characteristicAttributeCode

characteristicAttributeCode: string

Code. Represents the lowest level within the hierarchy of catalog type, code group and code. A code refers to the actual coding for the attribute. For example, in a code group of colors, the code BL can represent the color blue, GR can represent the color green, and so forth. The code can be uniquely identified only with the catalog type and code group. Maximum length: 4.

characteristicAttributeCodeGrp

characteristicAttributeCodeGrp: string

Code Group. Key for the code group. Maximum length: 8.

Optional charcAttribSeldSetCodeChgdBy

charcAttribSeldSetCodeChgdBy: undefined | string

Name of User Who Last Changed Data Record. Name of the user who made the last change to this data record. Maximum length: 12.

nullable

Optional charcAttribSeldSetCodeChgdOn

charcAttribSeldSetCodeChgdOn: Moment

Date on Which Data Record Was Changed. Date on which the data record was last changed. The system enters the current system date.

nullable

Optional charcAttribSeldSetCodeCrtedBy

charcAttribSeldSetCodeCrtedBy: undefined | string

Name of User Who Created the Data Record. Name of the user who created this data record. The system automatically enters the user name. Maximum length: 12.

nullable

Optional charcAttribSeldSetCodeCrtedOn

charcAttribSeldSetCodeCrtedOn: Moment

Date on Which Data Record Was Created. Date on which the data record was created. The system enters the current system date.

nullable

Optional charcAttributeValuation

charcAttributeValuation: undefined | string

Code Valuation. Specifies the valuation of a code from the inspection catalog. Maximum length: 1.

nullable

Optional defectClass

defectClass: undefined | string

Defect Class. Categorizes the possible defects into classes according to a defect valuation based on the results caused by the defect. Defects are usually assigned to one of three classes: critical defect, major defect, or minor defect. Maximum length: 2.

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

selectedCodeSet

selectedCodeSet: string

Selected Set. Key for the selected set. Maximum length: 8.

selectedCodeSetPlant

selectedCodeSetPlant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

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

All fields selector.

Static CHARACTERISTIC_ATTRIBUTE_CODE

CHARACTERISTIC_ATTRIBUTE_CODE: StringField<CharcAttribSeldSetCode> = new StringField('CharacteristicAttributeCode', CharcAttribSeldSetCode, 'Edm.String')

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

Static CHARACTERISTIC_ATTRIBUTE_CODE_GRP

CHARACTERISTIC_ATTRIBUTE_CODE_GRP: StringField<CharcAttribSeldSetCode> = new StringField('CharacteristicAttributeCodeGrp', CharcAttribSeldSetCode, 'Edm.String')

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

Static CHARC_ATTRIBUTE_VALUATION

CHARC_ATTRIBUTE_VALUATION: StringField<CharcAttribSeldSetCode> = new StringField('CharcAttributeValuation', CharcAttribSeldSetCode, 'Edm.String')

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

Static CHARC_ATTRIB_SELD_SET_CODE_CHGD_BY

CHARC_ATTRIB_SELD_SET_CODE_CHGD_BY: StringField<CharcAttribSeldSetCode> = new StringField('CharcAttribSeldSetCodeChgdBy', CharcAttribSeldSetCode, 'Edm.String')

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

Static CHARC_ATTRIB_SELD_SET_CODE_CHGD_ON

CHARC_ATTRIB_SELD_SET_CODE_CHGD_ON: DateField<CharcAttribSeldSetCode> = new DateField('CharcAttribSeldSetCodeChgdOn', CharcAttribSeldSetCode, 'Edm.DateTime')

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

Static CHARC_ATTRIB_SELD_SET_CODE_CRTED_BY

CHARC_ATTRIB_SELD_SET_CODE_CRTED_BY: StringField<CharcAttribSeldSetCode> = new StringField('CharcAttribSeldSetCodeCrtedBy', CharcAttribSeldSetCode, 'Edm.String')

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

Static CHARC_ATTRIB_SELD_SET_CODE_CRTED_ON

CHARC_ATTRIB_SELD_SET_CODE_CRTED_ON: DateField<CharcAttribSeldSetCode> = new DateField('CharcAttribSeldSetCodeCrtedOn', CharcAttribSeldSetCode, 'Edm.DateTime')

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

Static DEFECT_CLASS

DEFECT_CLASS: StringField<CharcAttribSeldSetCode> = new StringField('DefectClass', CharcAttribSeldSetCode, 'Edm.String')

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

Static SELECTED_CODE_SET

SELECTED_CODE_SET: StringField<CharcAttribSeldSetCode> = new StringField('SelectedCodeSet', CharcAttribSeldSetCode, 'Edm.String')

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

Static SELECTED_CODE_SET_PLANT

SELECTED_CODE_SET_PLANT: StringField<CharcAttribSeldSetCode> = new StringField('SelectedCodeSetPlant', CharcAttribSeldSetCode, 'Edm.String')

Static representation of the selectedCodeSetPlant 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<CharcAttribSeldSetCode> | DateField<CharcAttribSeldSetCode>> = [CharcAttribSeldSetCode.SELECTED_CODE_SET_PLANT,CharcAttribSeldSetCode.SELECTED_CODE_SET,CharcAttribSeldSetCode.CHARACTERISTIC_ATTRIBUTE_CODE_GRP,CharcAttribSeldSetCode.CHARACTERISTIC_ATTRIBUTE_CODE,CharcAttribSeldSetCode.CHARC_ATTRIBUTE_VALUATION,CharcAttribSeldSetCode.DEFECT_CLASS,CharcAttribSeldSetCode.CHARC_ATTRIB_SELD_SET_CODE_CRTED_BY,CharcAttribSeldSetCode.CHARC_ATTRIB_SELD_SET_CODE_CRTED_ON,CharcAttribSeldSetCode.CHARC_ATTRIB_SELD_SET_CODE_CHGD_BY,CharcAttribSeldSetCode.CHARC_ATTRIB_SELD_SET_CODE_CHGD_ON]

All fields of the CharcAttribSeldSetCode entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CharcAttribSeldSetCode"

Technical entity name for CharcAttribSeldSetCode.

Static _keyFields

_keyFields: Array<Selectable<CharcAttribSeldSetCode>> = [CharcAttribSeldSetCode.SELECTED_CODE_SET_PLANT, CharcAttribSeldSetCode.SELECTED_CODE_SET, CharcAttribSeldSetCode.CHARACTERISTIC_ATTRIBUTE_CODE_GRP, CharcAttribSeldSetCode.CHARACTERISTIC_ATTRIBUTE_CODE]

All key fields of the CharcAttribSeldSetCode entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CHARCATTRIBUTECATALOG_SRV_01"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CharcAttribSeldSetCode>

    A builder that constructs instances of entity type CharcAttribSeldSetCode.

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

    Returns CharcAttribSeldSetCodeRequestBuilder

    A CharcAttribSeldSetCode request builder.