Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ChangeMaster" 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
    • ChangeMaster

Implements

Index

Constructors

constructor

  • Returns ChangeMaster

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 authorizationGroup

authorizationGroup: string

Authorization group for change master record. Maximum length: 4.

nullable

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 changeNumberCreatedByUser

changeNumberCreatedByUser: string

User Who Created Record. Maximum length: 12.

nullable

Optional changeNumberCreationDate

changeNumberCreationDate: Moment

Date on Which Record Was Created.

nullable

Optional changeNumberDescription

changeNumberDescription: string

Change Number Description. Text that describes the change number. The information entered is valid for all changes that are carried out using this change number.For the change master you canEnter a long text by choosing the function Chg header long text in the Extras menu.Change or display a long text if the Indicator: Long text exists for change master was set by the system. Maximum length: 40.

nullable

Optional changeNumberFunction

changeNumberFunction: string

Change number function. Determination of the task that copies the change master record to the change process. The change master record function determines, for example,which data is processedwhether change objects (for example, BOMs, task lists) can be processed with reference to the change master recordThe following functions are supported:Change number release indicator (Blank)Change master record that is automatically released for later application areas (no release procedure)Change number with release indicator (Value: 1)Change master record that you release for later application areas, using a release procedureChange package (Value: 2)Change master record that controls the individual object changes in the change processDetermines how and which change objects should be processedAllocation ti a change package is essentialLeading change master record (Value: 3)Change master record that groups together several change packages in the change processDetermines when the change should take effect (Date Valid- from)You cannot process the change objectsYou cannot create an ECR or an ECO with the Leading change master record function. Maximum length: 1.

nullable

Optional changeNumberIsMrkdForDeletion

changeNumberIsMrkdForDeletion: boolean

Deletion Flag for Change Number (Reorganization).

nullable

Optional changeNumberLastChangedByUser

changeNumberLastChangedByUser: string

Name of Person Who Changed Object. Maximum length: 12.

nullable

Optional changeNumberLastChangedDate

changeNumberLastChangedDate: Moment

Changed On.

nullable

Optional changeNumberReleaseKey

changeNumberReleaseKey: string

Release Key for Change Master Record. Key that reproduces the release procedure for different areas of the company. For example, enter one of the following values:No release (blank)The changes are not released for other areas of the companyGlobal release (value 1)The changes are released for all areas of the company.Release for one or more areasFor example: costing, planning, productionRelease key 20 is defined in such a way that the changes are only released for costing. This means that the changes (for example, exchanging a cheap material for a more expensive one) are taken into account in costing, but not in planning or production. Maximum length: 2.

nullable

Optional changeNumberStatus

changeNumberStatus: string

Status of Change Number. Maximum length: 2.

nullable

Optional changeNumberValidFromDate

changeNumberValidFromDate: Moment

Valid-From Date. Date, from which the change object (for example, document) change is effective with the corresponding change number. The system determines the date from the corresponding change master record. If the change object is not assigned to an alternative date, the date is then the valid-from date in the change header.

nullable

Optional isTechnicallyReleased

isTechnicallyReleased: string

Indicator: Technical release occurs. Indication that the changes have been technically released. Maximum length: 1.

nullable

Optional isUsedForDataDefinition

isUsedForDataDefinition: boolean

Change Number Is Currently Being Used in Objects.

nullable

Optional reasonForChangeText

reasonForChangeText: string

Reason for change. General information about the reason for change, that is relevant for all objects that are changed with this change number. You have the following options for documenting the change in more detail:You can create any document info records you need in document management and enter them as accompanying documents for the change master record.You link a document info record to a change master record by choosing the function Extras -> Accompanying docs.In the object-related management record you can additionally maintain information using the corresponding single change. Maximum length: 40.

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

toAlternativeDate

toAlternativeDate: ChangeMasterAltDate[]

One-to-many navigation property to the ChangeMasterAltDate entity.

toChangeNumberStatus

toChangeNumberStatus: ChangeMasterStatus

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

toObjTypeAssignment

toObjTypeAssignment: ChangeMasterObjTypeAssgmt[]

One-to-many navigation property to the ChangeMasterObjTypeAssgmt 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<ChangeMaster> = new AllFields('*', ChangeMaster)

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<ChangeMaster> = new StringField('AuthorizationGroup', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER

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

CHANGE_NUMBER_CREATED_BY_USER: StringField<ChangeMaster> = new StringField('ChangeNumberCreatedByUser', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_CREATION_DATE

CHANGE_NUMBER_CREATION_DATE: DateField<ChangeMaster> = new DateField('ChangeNumberCreationDate', ChangeMaster, 'Edm.DateTime')

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

Static CHANGE_NUMBER_DESCRIPTION

CHANGE_NUMBER_DESCRIPTION: StringField<ChangeMaster> = new StringField('ChangeNumberDescription', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_FUNCTION

CHANGE_NUMBER_FUNCTION: StringField<ChangeMaster> = new StringField('ChangeNumberFunction', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_IS_MRKD_FOR_DELETION

CHANGE_NUMBER_IS_MRKD_FOR_DELETION: BooleanField<ChangeMaster> = new BooleanField('ChangeNumberIsMrkdForDeletion', ChangeMaster, 'Edm.Boolean')

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

Static CHANGE_NUMBER_LAST_CHANGED_BY_USER

CHANGE_NUMBER_LAST_CHANGED_BY_USER: StringField<ChangeMaster> = new StringField('ChangeNumberLastChangedByUser', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_LAST_CHANGED_DATE

CHANGE_NUMBER_LAST_CHANGED_DATE: DateField<ChangeMaster> = new DateField('ChangeNumberLastChangedDate', ChangeMaster, 'Edm.DateTime')

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

Static CHANGE_NUMBER_RELEASE_KEY

CHANGE_NUMBER_RELEASE_KEY: StringField<ChangeMaster> = new StringField('ChangeNumberReleaseKey', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_STATUS

CHANGE_NUMBER_STATUS: StringField<ChangeMaster> = new StringField('ChangeNumberStatus', ChangeMaster, 'Edm.String')

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

Static CHANGE_NUMBER_VALID_FROM_DATE

CHANGE_NUMBER_VALID_FROM_DATE: DateField<ChangeMaster> = new DateField('ChangeNumberValidFromDate', ChangeMaster, 'Edm.DateTime')

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

Static IS_TECHNICALLY_RELEASED

IS_TECHNICALLY_RELEASED: StringField<ChangeMaster> = new StringField('IsTechnicallyReleased', ChangeMaster, 'Edm.String')

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

Static IS_USED_FOR_DATA_DEFINITION

IS_USED_FOR_DATA_DEFINITION: BooleanField<ChangeMaster> = new BooleanField('IsUsedForDataDefinition', ChangeMaster, 'Edm.Boolean')

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

Static REASON_FOR_CHANGE_TEXT

REASON_FOR_CHANGE_TEXT: StringField<ChangeMaster> = new StringField('ReasonForChangeText', ChangeMaster, 'Edm.String')

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

Static TO_ALTERNATIVE_DATE

TO_ALTERNATIVE_DATE: Link<ChangeMaster, ChangeMasterAltDate> = new Link('to_AlternativeDate', ChangeMaster, ChangeMasterAltDate)

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

Static TO_CHANGE_NUMBER_STATUS

TO_CHANGE_NUMBER_STATUS: OneToOneLink<ChangeMaster, ChangeMasterStatus> = new OneToOneLink('to_ChangeNumberStatus', ChangeMaster, ChangeMasterStatus)

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

Static TO_OBJ_TYPE_ASSIGNMENT

TO_OBJ_TYPE_ASSIGNMENT: Link<ChangeMaster, ChangeMasterObjTypeAssgmt> = new Link('to_ObjTypeAssignment', ChangeMaster, ChangeMasterObjTypeAssgmt)

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

Static _allFields

_allFields: Array<StringField<ChangeMaster> | DateField<ChangeMaster> | BooleanField<ChangeMaster> | Link<ChangeMaster, ChangeMasterAltDate> | OneToOneLink<ChangeMaster, ChangeMasterStatus> | Link<ChangeMaster, ChangeMasterObjTypeAssgmt>> = [ChangeMaster.CHANGE_NUMBER,ChangeMaster.CHANGE_NUMBER_STATUS,ChangeMaster.AUTHORIZATION_GROUP,ChangeMaster.CHANGE_NUMBER_FUNCTION,ChangeMaster.IS_TECHNICALLY_RELEASED,ChangeMaster.CHANGE_NUMBER_RELEASE_KEY,ChangeMaster.REASON_FOR_CHANGE_TEXT,ChangeMaster.CHANGE_NUMBER_DESCRIPTION,ChangeMaster.CHANGE_NUMBER_VALID_FROM_DATE,ChangeMaster.CHANGE_NUMBER_CREATION_DATE,ChangeMaster.CHANGE_NUMBER_CREATED_BY_USER,ChangeMaster.CHANGE_NUMBER_LAST_CHANGED_DATE,ChangeMaster.CHANGE_NUMBER_LAST_CHANGED_BY_USER,ChangeMaster.IS_USED_FOR_DATA_DEFINITION,ChangeMaster.CHANGE_NUMBER_IS_MRKD_FOR_DELETION,ChangeMaster.TO_ALTERNATIVE_DATE,ChangeMaster.TO_CHANGE_NUMBER_STATUS,ChangeMaster.TO_OBJ_TYPE_ASSIGNMENT]

All fields of the ChangeMaster entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ChangeMaster"

Technical entity name for ChangeMaster.

Static _keyFields

_keyFields: Array<Selectable<ChangeMaster>> = [ChangeMaster.CHANGE_NUMBER]

All key fields of the ChangeMaster entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CHANGEMASTER"
deprecated

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

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

  • Returns an entity builder to construct instances ChangeMaster.

    Returns EntityBuilderType<ChangeMaster, ChangeMasterType>

    A builder that constructs instances of entity type ChangeMaster.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ChangeMaster.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ChangeMaster>

    A builder that constructs instances of entity type ChangeMaster.

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

    Returns ChangeMasterRequestBuilder

    A ChangeMaster request builder.