Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ChangeMstrObjectMgmtRecord" of service "API_CHANGEMASTER". 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_CHANGEMASTER;v=0002 for more information.

Hierarchy

  • Entity
    • ChangeMstrObjectMgmtRecord

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

changeNumber

changeNumber: 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 an object with a change number, the following functions are at your disposal:The system determines the validity conditionsThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date validity (valid-from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation of the changesAssignment of a revision level to a change state of a material or documentRelease of changes for the different areas in the company. Maximum length: 12.

Optional changeNumberLastChgdDateTime

changeNumberLastChgdDateTime: 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 chgNmbrAlternativeDateId

chgNmbrAlternativeDateId: string

Alternative date external key. Key that uniquely identifies a valid-from date that differs from the valid-from date (change header). Maximum length: 18.

nullable

Optional objMgmtRecdCreatedBy

objMgmtRecdCreatedBy: string

User who created record. Name of the person who created the record. Maximum length: 12.

nullable

Optional objMgmtRecdCreationDate

objMgmtRecdCreationDate: Moment

Date record created on. Date on which the record was created.

nullable

Optional objMgmtRecdDescription

objMgmtRecdDescription: string

Object management record description. Description of a single change that is made to a certain object. You can enter or edit a long text by choosing the Object longtext function in the Extras menu. Maximum length: 40.

nullable

Optional objMgmtRecdItemUuid

objMgmtRecdItemUuid: string

Object Management Record Item GUID.

nullable

Optional objMgmtRecdLastChangedAt

objMgmtRecdLastChangedAt: Moment

Date of Last Change.

nullable

Optional objMgmtRecdLastChangedBy

objMgmtRecdLastChangedBy: string

Name of person who changed object. Maximum length: 12.

nullable

Optional objMgmtRecdObjIsBaselined

objMgmtRecdObjIsBaselined: string

Baselining for object was performed. Specifies that the object has been frozen in a Baseline. The indicator is set by the system when you create a Baseline. This results in the following:You can no longer process this object with reference to a change number.You can carry out no more date shifts for this change number. Maximum length: 1.

nullable

Optional objMgmtRecdObjIsLockedForChg

objMgmtRecdObjIsLockedForChg: string

Indicator: Object locked for changes. Indication that no changes can be made to this object with reference to this change number. Maximum length: 1.

nullable

Optional objMgmtRecdObjIsPlanned

objMgmtRecdObjIsPlanned: string

Indicator: planned record. Indicator set by the system for a management record if the following apply: no master record yet exists for this object andno changes have been entered for the object with this change number. Maximum length: 1.

nullable

Optional objMgmtRecdObjLastChangedAt

objMgmtRecdObjLastChangedAt: Moment

Date on Which Object Was Last Changed.

nullable

Optional objMgmtRecdObjLastChangedBy

objMgmtRecdObjLastChangedBy: string

User who last changed the object. Maximum length: 12.

nullable

Optional objMgmtRecdObjRevisionLevel

objMgmtRecdObjRevisionLevel: string

Revision Level. Indicates a material or document's change status in addition to the change number. You can assign a revision level when you make a change with reference to a change number with a particular valid-from date.To do this, proceed as follows:Change a MaterialYou can assign a revision level directly during processing in the material master record or in the material BOM header.Change a DocumentWith documents, you can control whether a revision level is assigned, according to the document type. In this case you define a document status and set the release indicator for it. As soon as you process a document of this type, with reference to a change number and set this status for the first time, the revision level is assigned automatically.To enable you to enter a revision level, you first have to define it. To do this choose Logistics -> Central functions -> Engineering change management and then the menu path Revision level -> Material rev. level or Document rev. level.In the Setup control data section you can define how you want the assignment to be made. 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

Optional sapObjectReadableId

sapObjectReadableId: string

SAPconnect/phone: Character 90. Maximum length: 90.

nullable

sapObjectTechnicalId

sapObjectTechnicalId: string

Identification of object to be changed. Maximum length: 90.

sapObjectType

sapObjectType: string

SAP Object Type. Indicates the name of the business object type. Maximum length: 30.

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

All fields selector.

Static CHANGE_NUMBER

CHANGE_NUMBER: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ChangeNumber', ChangeMstrObjectMgmtRecord, '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 CHANGE_NUMBER_LAST_CHGD_DATE_TIME

CHANGE_NUMBER_LAST_CHGD_DATE_TIME: DateField<ChangeMstrObjectMgmtRecord> = new DateField('ChangeNumberLastChgdDateTime', ChangeMstrObjectMgmtRecord, 'Edm.DateTimeOffset')

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

Static CHG_NMBR_ALTERNATIVE_DATE_ID

CHG_NMBR_ALTERNATIVE_DATE_ID: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ChgNmbrAlternativeDateID', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_CREATED_BY

OBJ_MGMT_RECD_CREATED_BY: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdCreatedBy', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_CREATION_DATE

OBJ_MGMT_RECD_CREATION_DATE: DateField<ChangeMstrObjectMgmtRecord> = new DateField('ObjMgmtRecdCreationDate', ChangeMstrObjectMgmtRecord, 'Edm.DateTime')

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

Static OBJ_MGMT_RECD_DESCRIPTION

OBJ_MGMT_RECD_DESCRIPTION: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdDescription', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_ITEM_UUID

OBJ_MGMT_RECD_ITEM_UUID: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdItemUUID', ChangeMstrObjectMgmtRecord, 'Edm.Guid')

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

Static OBJ_MGMT_RECD_LAST_CHANGED_AT

OBJ_MGMT_RECD_LAST_CHANGED_AT: DateField<ChangeMstrObjectMgmtRecord> = new DateField('ObjMgmtRecdLastChangedAt', ChangeMstrObjectMgmtRecord, 'Edm.DateTime')

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

Static OBJ_MGMT_RECD_LAST_CHANGED_BY

OBJ_MGMT_RECD_LAST_CHANGED_BY: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdLastChangedBy', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_OBJ_IS_BASELINED

OBJ_MGMT_RECD_OBJ_IS_BASELINED: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdObjIsBaselined', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_OBJ_IS_LOCKED_FOR_CHG

OBJ_MGMT_RECD_OBJ_IS_LOCKED_FOR_CHG: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdObjIsLockedForChg', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_OBJ_IS_PLANNED

OBJ_MGMT_RECD_OBJ_IS_PLANNED: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdObjIsPlanned', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_OBJ_LAST_CHANGED_AT

OBJ_MGMT_RECD_OBJ_LAST_CHANGED_AT: DateField<ChangeMstrObjectMgmtRecord> = new DateField('ObjMgmtRecdObjLastChangedAt', ChangeMstrObjectMgmtRecord, 'Edm.DateTime')

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

Static OBJ_MGMT_RECD_OBJ_LAST_CHANGED_BY

OBJ_MGMT_RECD_OBJ_LAST_CHANGED_BY: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdObjLastChangedBy', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static OBJ_MGMT_RECD_OBJ_REVISION_LEVEL

OBJ_MGMT_RECD_OBJ_REVISION_LEVEL: StringField<ChangeMstrObjectMgmtRecord> = new StringField('ObjMgmtRecdObjRevisionLevel', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static SAP_OBJECT_READABLE_ID

SAP_OBJECT_READABLE_ID: StringField<ChangeMstrObjectMgmtRecord> = new StringField('SAPObjectReadableID', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static SAP_OBJECT_TECHNICAL_ID

SAP_OBJECT_TECHNICAL_ID: StringField<ChangeMstrObjectMgmtRecord> = new StringField('SAPObjectTechnicalID', ChangeMstrObjectMgmtRecord, 'Edm.String')

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

Static SAP_OBJECT_TYPE

SAP_OBJECT_TYPE: StringField<ChangeMstrObjectMgmtRecord> = new StringField('SAPObjectType', ChangeMstrObjectMgmtRecord, 'Edm.String')

Static representation of the sapObjectType 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<ChangeMstrObjectMgmtRecord> | DateField<ChangeMstrObjectMgmtRecord>> = [ChangeMstrObjectMgmtRecord.CHANGE_NUMBER,ChangeMstrObjectMgmtRecord.SAP_OBJECT_TYPE,ChangeMstrObjectMgmtRecord.SAP_OBJECT_TECHNICAL_ID,ChangeMstrObjectMgmtRecord.SAP_OBJECT_READABLE_ID,ChangeMstrObjectMgmtRecord.CHG_NMBR_ALTERNATIVE_DATE_ID,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_DESCRIPTION,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_ITEM_UUID,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_LAST_CHANGED_AT,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_LAST_CHANGED_BY,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_CREATION_DATE,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_CREATED_BY,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_LAST_CHANGED_AT,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_LAST_CHANGED_BY,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_IS_LOCKED_FOR_CHG,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_IS_BASELINED,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_IS_PLANNED,ChangeMstrObjectMgmtRecord.OBJ_MGMT_RECD_OBJ_REVISION_LEVEL,ChangeMstrObjectMgmtRecord.CHANGE_NUMBER_LAST_CHGD_DATE_TIME]

All fields of the ChangeMstrObjectMgmtRecord entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_CHANGEMASTER;v=0002"

Default url path for the according service.

Static _entityName

_entityName: string = "A_ChangeMstrObjectMgmtRecord"

Technical entity name for ChangeMstrObjectMgmtRecord.

Static _keyFields

_keyFields: Array<Selectable<ChangeMstrObjectMgmtRecord>> = [ChangeMstrObjectMgmtRecord.CHANGE_NUMBER, ChangeMstrObjectMgmtRecord.SAP_OBJECT_TYPE, ChangeMstrObjectMgmtRecord.SAP_OBJECT_TECHNICAL_ID]

All key fields of the ChangeMstrObjectMgmtRecord entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CHANGEMASTER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ChangeMstrObjectMgmtRecord>

    A builder that constructs instances of entity type ChangeMstrObjectMgmtRecord.

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, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the ChangeMstrObjectMgmtRecord entity type.

    Returns ChangeMstrObjectMgmtRecordRequestBuilder

    A ChangeMstrObjectMgmtRecord request builder.