Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurInfoRecdPrcgCndnValidity" of service "API_INFORECORD_PROCESS_SRV". This service is part of the following communication scenarios: Purchasing Info Record Integration (SAP_COM_0145). See https://api.sap.com/api/API_INFORECORD_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PurInfoRecdPrcgCndnValidity

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

Optional conditionApplication

conditionApplication: undefined | string

Application. Subdivides the usage of a condition (for example, pricing) for use in different application areas (for example, sales & distribution or purchasing). Maximum length: 2.

nullable

conditionRecord

conditionRecord: string

Number of the Condition Record. Number that uniquely identifies a condition record. The system uses the condition record number to store and retrieve information during processing (pricing, for example). Maximum length: 10.

Optional conditionType

conditionType: undefined | string

Condition Type. The key that uniquely identifies the condition. The condition type indicates, for example, whether, during pricing, the system applies a price, a discount, a surcharge, or other pricing elements, such as freight costs and sales taxes. For each of these pricing elements, there is a condition type defined in the system. Maximum length: 4.

nullable

conditionValidityEndDate

conditionValidityEndDate: Moment

Validity end date of the condition record. The date up to which the condition is valid.

Optional conditionValidityStartDate

conditionValidityStartDate: Moment

Validity start date of the condition record. Date from which the condition is valid.

nullable

Optional material

material: undefined | string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

nullable

Optional materialGroup

materialGroup: undefined | string

Material Group. Key that you use to group together several materials or services with the same attributes, and to assign them to a particular material group. You can use material groups to:Restrict the scope of analysesSearch specifically for material master records via search helps. Maximum length: 9.

nullable

Optional plant

plant: undefined | string

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

nullable

Optional purchasingInfoRecord

purchasingInfoRecord: undefined | string

Number of purchasing info record. Specifies the number that uniquely identifies a purchasing info record. Maximum length: 10.

nullable

Optional purchasingInfoRecordCategory

purchasingInfoRecordCategory: undefined | string

Purchasing info record category. The info record category enables you to create different info records for different document types. You can create purchasing info records for:Normal procurementSubcontractingPipelineConsignment. Maximum length: 1.

nullable

Optional purchasingOrganization

purchasingOrganization: undefined | string

Purchasing Organization. Denotes the purchasing organization. Maximum length: 4.

nullable

Optional purgDocOrderQuantityUnit

purgDocOrderQuantityUnit: undefined | string

Purchase Order Unit of Measure. Specifies the unit of measure in which the material is ordered. Maximum length: 3.

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 supplier

supplier: undefined | string

Supplier's Account Number. Alphanumeric key uniquely identifying the document. With the supplier number, information from the supplier master record (such as the supplier's address and bank details) is copied into a purchasing document (such as a request for quotation or a purchase order).You can use the supplier number to keep track of requests for quotation, purchase orders and outline agreements. Maximum length: 10.

nullable

toPurInfoRecdPrcgCndn

toPurInfoRecdPrcgCndn: PurInfoRecdPrcgCndn

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

toPurgInfoRecd

toPurgInfoRecd: PurchasingInfoRecord

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

toPurgInfoRecdOrgPlantData

toPurgInfoRecdOrgPlantData: PurgInfoRecdOrgPlantData

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

Static ALL_FIELDS

ALL_FIELDS: AllFields<PurInfoRecdPrcgCndnValidity> = new AllFields('*', PurInfoRecdPrcgCndnValidity)

All fields selector.

Static CONDITION_APPLICATION

CONDITION_APPLICATION: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('ConditionApplication', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static CONDITION_RECORD

CONDITION_RECORD: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('ConditionRecord', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static CONDITION_TYPE

CONDITION_TYPE: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('ConditionType', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static CONDITION_VALIDITY_END_DATE

CONDITION_VALIDITY_END_DATE: DateField<PurInfoRecdPrcgCndnValidity> = new DateField('ConditionValidityEndDate', PurInfoRecdPrcgCndnValidity, 'Edm.DateTime')

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

Static CONDITION_VALIDITY_START_DATE

CONDITION_VALIDITY_START_DATE: DateField<PurInfoRecdPrcgCndnValidity> = new DateField('ConditionValidityStartDate', PurInfoRecdPrcgCndnValidity, 'Edm.DateTime')

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

Static MATERIAL

MATERIAL: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('Material', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static MATERIAL_GROUP

MATERIAL_GROUP: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('MaterialGroup', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static PLANT

PLANT: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('Plant', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static PURCHASING_INFO_RECORD

PURCHASING_INFO_RECORD: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('PurchasingInfoRecord', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static PURCHASING_INFO_RECORD_CATEGORY

PURCHASING_INFO_RECORD_CATEGORY: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('PurchasingInfoRecordCategory', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static PURCHASING_ORGANIZATION

PURCHASING_ORGANIZATION: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('PurchasingOrganization', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static PURG_DOC_ORDER_QUANTITY_UNIT

PURG_DOC_ORDER_QUANTITY_UNIT: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('PurgDocOrderQuantityUnit', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static SUPPLIER

SUPPLIER: StringField<PurInfoRecdPrcgCndnValidity> = new StringField('Supplier', PurInfoRecdPrcgCndnValidity, 'Edm.String')

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

Static TO_PURG_INFO_RECD

TO_PURG_INFO_RECD: OneToOneLink<PurInfoRecdPrcgCndnValidity, PurchasingInfoRecord> = new OneToOneLink('to_PurgInfoRecd', PurInfoRecdPrcgCndnValidity, PurchasingInfoRecord)

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

Static TO_PURG_INFO_RECD_ORG_PLANT_DATA

TO_PURG_INFO_RECD_ORG_PLANT_DATA: OneToOneLink<PurInfoRecdPrcgCndnValidity, PurgInfoRecdOrgPlantData> = new OneToOneLink('to_PurgInfoRecdOrgPlantData', PurInfoRecdPrcgCndnValidity, PurgInfoRecdOrgPlantData)

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

Static TO_PUR_INFO_RECD_PRCG_CNDN

TO_PUR_INFO_RECD_PRCG_CNDN: OneToOneLink<PurInfoRecdPrcgCndnValidity, PurInfoRecdPrcgCndn> = new OneToOneLink('to_PurInfoRecdPrcgCndn', PurInfoRecdPrcgCndnValidity, PurInfoRecdPrcgCndn)

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

Static _allFields

_allFields: Array<StringField<PurInfoRecdPrcgCndnValidity> | DateField<PurInfoRecdPrcgCndnValidity> | OneToOneLink<PurInfoRecdPrcgCndnValidity, PurchasingInfoRecord> | OneToOneLink<PurInfoRecdPrcgCndnValidity, PurgInfoRecdOrgPlantData> | OneToOneLink<PurInfoRecdPrcgCndnValidity, PurInfoRecdPrcgCndn>> = [PurInfoRecdPrcgCndnValidity.CONDITION_RECORD,PurInfoRecdPrcgCndnValidity.CONDITION_VALIDITY_END_DATE,PurInfoRecdPrcgCndnValidity.CONDITION_VALIDITY_START_DATE,PurInfoRecdPrcgCndnValidity.CONDITION_APPLICATION,PurInfoRecdPrcgCndnValidity.CONDITION_TYPE,PurInfoRecdPrcgCndnValidity.PURG_DOC_ORDER_QUANTITY_UNIT,PurInfoRecdPrcgCndnValidity.PURCHASING_ORGANIZATION,PurInfoRecdPrcgCndnValidity.PURCHASING_INFO_RECORD_CATEGORY,PurInfoRecdPrcgCndnValidity.PURCHASING_INFO_RECORD,PurInfoRecdPrcgCndnValidity.SUPPLIER,PurInfoRecdPrcgCndnValidity.MATERIAL_GROUP,PurInfoRecdPrcgCndnValidity.MATERIAL,PurInfoRecdPrcgCndnValidity.PLANT,PurInfoRecdPrcgCndnValidity.TO_PURG_INFO_RECD,PurInfoRecdPrcgCndnValidity.TO_PURG_INFO_RECD_ORG_PLANT_DATA,PurInfoRecdPrcgCndnValidity.TO_PUR_INFO_RECD_PRCG_CNDN]

All fields of the PurInfoRecdPrcgCndnValidity entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurInfoRecdPrcgCndnValidity"

Technical entity name for PurInfoRecdPrcgCndnValidity.

Static _keyFields

_keyFields: Array<Selectable<PurInfoRecdPrcgCndnValidity>> = [PurInfoRecdPrcgCndnValidity.CONDITION_RECORD, PurInfoRecdPrcgCndnValidity.CONDITION_VALIDITY_END_DATE]

All key fields of the PurInfoRecdPrcgCndnValidity entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_INFORECORD_PROCESS_SRV"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurInfoRecdPrcgCndnValidity>

    A builder that constructs instances of entity type PurInfoRecdPrcgCndnValidity.

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

    Returns PurInfoRecdPrcgCndnValidityRequestBuilder

    A PurInfoRecdPrcgCndnValidity request builder.