Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ChangeMasterObjTypeAssgmt" 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 for more information.

Hierarchy

  • Entity
    • ChangeMasterObjTypeAssgmt

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.

changeNumberObjectType

changeNumberObjectType: string

Object Type. Categorization of change objects (such as material BOM, document structure, routing, material) according to their distinguishing features. This categorization allows you to process changes to different objects in different ways with the same change number.For example, you can identify different change statuses of materials by using defined revision levels.2 - Material BOM4 - Document structure12 - Routing41 - MaterialYou cannot change this categorization. Maximum length: 2.

Optional isActiveForChangeNumber

isActiveForChangeNumber: boolean

Object Type Active for Change Number.

nullable

Optional isLockedForChanges

isLockedForChanges: string

Indicator: Object type locked for changes. Indicator prevents changes being made with this change number for thecorresponding object type This lock remains until you delete the indicator. Maximum length: 1.

nullable

Optional isPartiallyDisplayed

isPartiallyDisplayed: string

Indicator: display partial objects for object. Maximum length: 1.

nullable

Optional objMgmtRecdIsAutomlyCrted

objMgmtRecdIsAutomlyCrted: string

ID: Mgmt record generated automatically only for new objs. For all objects with this object type (such as bill of material), this indicator can be selected so that management records are only generated automatically for new objects. When you process an object with reference to a change number that already exists in the system,An object management record is not generated automaticallyYou first have to add the management record for this object manually, before you can process the object with reference to a change numberYou can only select this indicator if further indicators are set for this object type:object type active for change numberA management record is required for each objectObject management record generated. Maximum length: 1.

nullable

Optional objMgmtRecdIsAutomlyCrtedByDlg

objMgmtRecdIsAutomlyCrtedByDlg: string

Indicator: Automatic generation with dialog box. For all objects with this object type (such as bill of material), this indicator can be selected so that by using this change number management records are created via a dialog box. Immediately describe the reason for change, for the individual object, in a dialog box.You can only select this indicator if further indicators are set for this object type:object type active for change numberA management record is required for each objectObject management record generated. Maximum length: 1.

nullable

Optional objMgmtRecdIsGenerated

objMgmtRecdIsGenerated: boolean

Object Management Record Was Generated.

nullable

Optional objMgmtRecdIsRequired

objMgmtRecdIsRequired: boolean

Management Record Is Required for Each Object.

nullable

Optional objectTypeCreatedByUser

objectTypeCreatedByUser: string

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

nullable

Optional objectTypeCreationDate

objectTypeCreationDate: Moment

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

nullable

Optional objectTypeLastChangedByUser

objectTypeLastChangedByUser: string

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

nullable

Optional objectTypeLastChangedDate

objectTypeLastChangedDate: Moment

Date of Last Change.

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

toChangeMaster

toChangeMaster: ChangeMaster

One-to-one navigation property to the ChangeMaster entity.

toChangeMasterObjectType

toChangeMasterObjectType: ChangeMasterObjectType

One-to-one navigation property to the ChangeMasterObjectType entity.

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

All fields selector.

Static CHANGE_NUMBER

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

CHANGE_NUMBER_OBJECT_TYPE: StringField<ChangeMasterObjTypeAssgmt> = new StringField('ChangeNumberObjectType', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static IS_ACTIVE_FOR_CHANGE_NUMBER

IS_ACTIVE_FOR_CHANGE_NUMBER: BooleanField<ChangeMasterObjTypeAssgmt> = new BooleanField('IsActiveForChangeNumber', ChangeMasterObjTypeAssgmt, 'Edm.Boolean')

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

Static IS_LOCKED_FOR_CHANGES

IS_LOCKED_FOR_CHANGES: StringField<ChangeMasterObjTypeAssgmt> = new StringField('IsLockedForChanges', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static IS_PARTIALLY_DISPLAYED

IS_PARTIALLY_DISPLAYED: StringField<ChangeMasterObjTypeAssgmt> = new StringField('IsPartiallyDisplayed', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static OBJECT_TYPE_CREATED_BY_USER

OBJECT_TYPE_CREATED_BY_USER: StringField<ChangeMasterObjTypeAssgmt> = new StringField('ObjectTypeCreatedByUser', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static OBJECT_TYPE_CREATION_DATE

OBJECT_TYPE_CREATION_DATE: DateField<ChangeMasterObjTypeAssgmt> = new DateField('ObjectTypeCreationDate', ChangeMasterObjTypeAssgmt, 'Edm.DateTime')

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

Static OBJECT_TYPE_LAST_CHANGED_BY_USER

OBJECT_TYPE_LAST_CHANGED_BY_USER: StringField<ChangeMasterObjTypeAssgmt> = new StringField('ObjectTypeLastChangedByUser', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static OBJECT_TYPE_LAST_CHANGED_DATE

OBJECT_TYPE_LAST_CHANGED_DATE: DateField<ChangeMasterObjTypeAssgmt> = new DateField('ObjectTypeLastChangedDate', ChangeMasterObjTypeAssgmt, 'Edm.DateTime')

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

Static OBJ_MGMT_RECD_IS_AUTOMLY_CRTED

OBJ_MGMT_RECD_IS_AUTOMLY_CRTED: StringField<ChangeMasterObjTypeAssgmt> = new StringField('ObjMgmtRecdIsAutomlyCrted', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static OBJ_MGMT_RECD_IS_AUTOMLY_CRTED_BY_DLG

OBJ_MGMT_RECD_IS_AUTOMLY_CRTED_BY_DLG: StringField<ChangeMasterObjTypeAssgmt> = new StringField('ObjMgmtRecdIsAutomlyCrtedByDlg', ChangeMasterObjTypeAssgmt, 'Edm.String')

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

Static OBJ_MGMT_RECD_IS_GENERATED

OBJ_MGMT_RECD_IS_GENERATED: BooleanField<ChangeMasterObjTypeAssgmt> = new BooleanField('ObjMgmtRecdIsGenerated', ChangeMasterObjTypeAssgmt, 'Edm.Boolean')

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

Static OBJ_MGMT_RECD_IS_REQUIRED

OBJ_MGMT_RECD_IS_REQUIRED: BooleanField<ChangeMasterObjTypeAssgmt> = new BooleanField('ObjMgmtRecdIsRequired', ChangeMasterObjTypeAssgmt, 'Edm.Boolean')

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

Static TO_CHANGE_MASTER

TO_CHANGE_MASTER: OneToOneLink<ChangeMasterObjTypeAssgmt, ChangeMaster> = new OneToOneLink('to_ChangeMaster', ChangeMasterObjTypeAssgmt, ChangeMaster)

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

Static TO_CHANGE_MASTER_OBJECT_TYPE

TO_CHANGE_MASTER_OBJECT_TYPE: OneToOneLink<ChangeMasterObjTypeAssgmt, ChangeMasterObjectType> = new OneToOneLink('to_ChangeMasterObjectType', ChangeMasterObjTypeAssgmt, ChangeMasterObjectType)

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

Static _allFields

_allFields: Array<StringField<ChangeMasterObjTypeAssgmt> | BooleanField<ChangeMasterObjTypeAssgmt> | DateField<ChangeMasterObjTypeAssgmt> | OneToOneLink<ChangeMasterObjTypeAssgmt, ChangeMaster> | OneToOneLink<ChangeMasterObjTypeAssgmt, ChangeMasterObjectType>> = [ChangeMasterObjTypeAssgmt.CHANGE_NUMBER,ChangeMasterObjTypeAssgmt.CHANGE_NUMBER_OBJECT_TYPE,ChangeMasterObjTypeAssgmt.IS_ACTIVE_FOR_CHANGE_NUMBER,ChangeMasterObjTypeAssgmt.IS_LOCKED_FOR_CHANGES,ChangeMasterObjTypeAssgmt.IS_PARTIALLY_DISPLAYED,ChangeMasterObjTypeAssgmt.OBJ_MGMT_RECD_IS_REQUIRED,ChangeMasterObjTypeAssgmt.OBJ_MGMT_RECD_IS_GENERATED,ChangeMasterObjTypeAssgmt.OBJ_MGMT_RECD_IS_AUTOMLY_CRTED,ChangeMasterObjTypeAssgmt.OBJ_MGMT_RECD_IS_AUTOMLY_CRTED_BY_DLG,ChangeMasterObjTypeAssgmt.OBJECT_TYPE_CREATION_DATE,ChangeMasterObjTypeAssgmt.OBJECT_TYPE_CREATED_BY_USER,ChangeMasterObjTypeAssgmt.OBJECT_TYPE_LAST_CHANGED_DATE,ChangeMasterObjTypeAssgmt.OBJECT_TYPE_LAST_CHANGED_BY_USER,ChangeMasterObjTypeAssgmt.TO_CHANGE_MASTER,ChangeMasterObjTypeAssgmt.TO_CHANGE_MASTER_OBJECT_TYPE]

All fields of the ChangeMasterObjTypeAssgmt entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ChangeMasterObjTypeAssgmt"

Technical entity name for ChangeMasterObjTypeAssgmt.

Static _keyFields

_keyFields: Array<Selectable<ChangeMasterObjTypeAssgmt>> = [ChangeMasterObjTypeAssgmt.CHANGE_NUMBER, ChangeMasterObjTypeAssgmt.CHANGE_NUMBER_OBJECT_TYPE]

All key fields of the ChangeMasterObjTypeAssgmt entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CHANGEMASTER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ChangeMasterObjTypeAssgmt>

    A builder that constructs instances of entity type ChangeMasterObjTypeAssgmt.

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

    Returns ChangeMasterObjTypeAssgmtRequestBuilder

    A ChangeMasterObjTypeAssgmt request builder.