Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CharcAttribSeldCodeSet" 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
    • CharcAttribSeldCodeSet

Implements

Index

Constructors

constructor

  • Returns CharcAttribSeldCodeSet

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 charcAttribSeldSetCreatedBy

charcAttribSeldSetCreatedBy: 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 charcAttribSeldSetCrtedOn

charcAttribSeldSetCrtedOn: 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 charcAttribSeldSetLastChgdBy

charcAttribSeldSetLastChgdBy: 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 charcAttribSeldSetLastChgdOn

charcAttribSeldSetLastChgdOn: 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 inspectionSelectedSetStatus

inspectionSelectedSetStatus: string

Status of Master Record. This status indicates the processing status of the inspection catalog. You cannot reference a master record with status 1 (being created).Before you can reference a master record, you must first release it by setting its status to 2 (released).You should not reference master records with status 3 (can no longer be used) These master records may, however, already be in use.Master records with status 4 (deletion flag) are deleted during the next archiving run. The system then checks whether the master record is still being used. If the master record is not referenced, it is deleted. If it is referenced, it cannot be deleted. Maximum length: 1.

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

All fields selector.

Static CHARC_ATTRIB_SELD_SET_CREATED_BY

CHARC_ATTRIB_SELD_SET_CREATED_BY: StringField<CharcAttribSeldCodeSet> = new StringField('CharcAttribSeldSetCreatedBy', CharcAttribSeldCodeSet, 'Edm.String')

Static representation of the charcAttribSeldSetCreatedBy 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_CRTED_ON

CHARC_ATTRIB_SELD_SET_CRTED_ON: DateField<CharcAttribSeldCodeSet> = new DateField('CharcAttribSeldSetCrtedOn', CharcAttribSeldCodeSet, 'Edm.DateTime')

Static representation of the charcAttribSeldSetCrtedOn 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_LAST_CHGD_BY

CHARC_ATTRIB_SELD_SET_LAST_CHGD_BY: StringField<CharcAttribSeldCodeSet> = new StringField('CharcAttribSeldSetLastChgdBy', CharcAttribSeldCodeSet, 'Edm.String')

Static representation of the charcAttribSeldSetLastChgdBy 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_LAST_CHGD_ON

CHARC_ATTRIB_SELD_SET_LAST_CHGD_ON: DateField<CharcAttribSeldCodeSet> = new DateField('CharcAttribSeldSetLastChgdOn', CharcAttribSeldCodeSet, 'Edm.DateTime')

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

Static INSPECTION_SELECTED_SET_STATUS

INSPECTION_SELECTED_SET_STATUS: StringField<CharcAttribSeldCodeSet> = new StringField('InspectionSelectedSetStatus', CharcAttribSeldCodeSet, 'Edm.String')

Static representation of the inspectionSelectedSetStatus 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<CharcAttribSeldCodeSet> = new StringField('SelectedCodeSet', CharcAttribSeldCodeSet, '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<CharcAttribSeldCodeSet> = new StringField('SelectedCodeSetPlant', CharcAttribSeldCodeSet, '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<CharcAttribSeldCodeSet> | DateField<CharcAttribSeldCodeSet>> = [CharcAttribSeldCodeSet.SELECTED_CODE_SET_PLANT,CharcAttribSeldCodeSet.SELECTED_CODE_SET,CharcAttribSeldCodeSet.INSPECTION_SELECTED_SET_STATUS,CharcAttribSeldCodeSet.CHARC_ATTRIB_SELD_SET_CREATED_BY,CharcAttribSeldCodeSet.CHARC_ATTRIB_SELD_SET_CRTED_ON,CharcAttribSeldCodeSet.CHARC_ATTRIB_SELD_SET_LAST_CHGD_BY,CharcAttribSeldCodeSet.CHARC_ATTRIB_SELD_SET_LAST_CHGD_ON]

All fields of the CharcAttribSeldCodeSet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CharcAttribSeldCodeSet"

Technical entity name for CharcAttribSeldCodeSet.

Static _keyFields

_keyFields: Array<Selectable<CharcAttribSeldCodeSet>> = [CharcAttribSeldCodeSet.SELECTED_CODE_SET_PLANT, CharcAttribSeldCodeSet.SELECTED_CODE_SET]

All key fields of the CharcAttribSeldCodeSet entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_CHARCATTRIBUTECATALOG_SRV_01"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CharcAttribSeldCodeSet>

    A builder that constructs instances of entity type CharcAttribSeldCodeSet.

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

    Returns CharcAttribSeldCodeSetRequestBuilder

    A CharcAttribSeldCodeSet request builder.