Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_SupplierOplScoresAVResults" of service "A_SUPPLIEROPLSCORESAV_CDS". This service is part of the following communication scenarios: Procurement - Operational Supplier Evaluation Score Integration (SAP_COM_0324). See https://api.sap.com/api/A_SUPPLIEROPLSCORESAV_CDS for more information.

Hierarchy

  • Entity
    • SupplierOplScoresAvResults

Implements

Index

Constructors

Properties

Methods

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 calendarMonth

calendarMonth: string

Calendar Month. Maximum length: 2.

nullable

Optional calendarQuarter

calendarQuarter: string

Calendar Quarter. Maximum length: 1.

nullable

Optional calendarWeek

calendarWeek: string

Calendar Week. Maximum length: 2.

nullable

Optional calendarYear

calendarYear: string

Calendar Year. Maximum length: 4.

nullable

Optional companyCode

companyCode: string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

nullable

Optional countryName

countryName: string

Country Name (Max. 50 Characters). Tthe country description (short form) The country description is used in the address format and on the user interface instead of the country key, or in addition to the country key.There are two fields for the country description. This fifty-character field, and a shorter fifteen-character field.Both fields contain the short description of the country, according to ISO 3166-1.For some countries, the fifteen-character field contains only a shortened form of the description, due to the field length.The fifty-character field contains the short description without abbreviations (but not the official, complete country name). Maximum length: 50.

nullable

id

id: string

Id.

Optional inspectionLotQualityScore

inspectionLotQualityScore: number

Inspection Lot Score.

nullable

Optional material

material: string

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

nullable

Optional materialGroup

materialGroup: 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 materialGroupName

materialGroupName: string

Product Group Description. Maximum length: 20.

nullable

Optional materialName

materialName: string

Material Description. Text containing up to 40 characters that describes the material in more detail. You can enter one material description in each of any number of languages.In principle, you enter the material description on the data screen of the first user department for which you enter data, and in your logon language. You can overwrite the material description on the Basic Data screen. Maximum length: 40.

nullable

parameters

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

Optional plant

plant: string

Plant. Specifies the key for a production facility or branch office within the company (that is, the company code). You use the plant key to determine, for instance, which plant is to receive ordered goods. Maximum length: 4.

nullable

Optional plantName

plantName: string

Plant Name. Maximum length: 30.

nullable

Optional priceVarianceScore

priceVarianceScore: number

Price Variance Score.

nullable

Optional purchaseOrderNetPriceAmount

purchaseOrderNetPriceAmount: BigNumber

Purchase Order Net Amount.

nullable

Optional purchasingCategory

purchasingCategory: string

Purchasing Category ID. Maximum length: 20.

nullable

Optional purchasingDocument

purchasingDocument: string

Purchasing Document. Maximum length: 10.

nullable

Optional purchasingDocumentItem

purchasingDocumentItem: string

Purchasing Document Item. Maximum length: 5.

nullable

Optional purchasingGroup

purchasingGroup: string

Purchasing Group. Key for a buyer or a group of buyers, who is/are responsible for certain purchasing activities. Frequently, purchasing documents (such as purchase orders) are monitored by the purchasing group. Urging letters (in the case of overdue deliveries) fall also within the group's scope of activities.For each purchasing group, statistical analyses can be performed. The purchasing group can be used as a sort criterion when creating purchasing-specific reports. Maximum length: 3.

nullable

Optional purchasingGroupName

purchasingGroupName: string

Purchasing Group Name. Maximum length: 18.

nullable

Optional purchasingOrganization

purchasingOrganization: string

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

nullable

Optional purchasingOrganizationName

purchasingOrganizationName: string

Purchasing Organization Name. Maximum length: 20.

nullable

Optional purgCatName

purgCatName: string

Name of Purchasing Category. Maximum length: 60.

nullable

Optional qualityNotificationScore

qualityNotificationScore: number

Quality Notification Score.

nullable

Optional quantityVarianceScore

quantityVarianceScore: number

Quantity Variance Score.

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: string

Supplier. Maximum length: 10.

nullable

Optional supplierCountry

supplierCountry: string

Supplier Country. Maximum length: 3.

nullable

Optional supplierName

supplierName: string

Supplier Name. Maximum length: 80.

nullable

Optional supplierOperationalScore

supplierOperationalScore: BigNumber

Supplier Operational Score.

nullable

Optional timeVarianceScore

timeVarianceScore: number

Time Variance Score.

nullable

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

All fields selector.

Static CALENDAR_MONTH

CALENDAR_MONTH: StringField<SupplierOplScoresAvResults> = new StringField('CalendarMonth', SupplierOplScoresAvResults, 'Edm.String')

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

Static CALENDAR_QUARTER

CALENDAR_QUARTER: StringField<SupplierOplScoresAvResults> = new StringField('CalendarQuarter', SupplierOplScoresAvResults, 'Edm.String')

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

Static CALENDAR_WEEK

CALENDAR_WEEK: StringField<SupplierOplScoresAvResults> = new StringField('CalendarWeek', SupplierOplScoresAvResults, 'Edm.String')

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

Static CALENDAR_YEAR

CALENDAR_YEAR: StringField<SupplierOplScoresAvResults> = new StringField('CalendarYear', SupplierOplScoresAvResults, 'Edm.String')

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

Static COMPANY_CODE

COMPANY_CODE: StringField<SupplierOplScoresAvResults> = new StringField('CompanyCode', SupplierOplScoresAvResults, 'Edm.String')

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

Static COUNTRY_NAME

COUNTRY_NAME: StringField<SupplierOplScoresAvResults> = new StringField('CountryName', SupplierOplScoresAvResults, 'Edm.String')

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

Static ID

ID: StringField<SupplierOplScoresAvResults> = new StringField('ID', SupplierOplScoresAvResults, 'Edm.String')

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

Static INSPECTION_LOT_QUALITY_SCORE

INSPECTION_LOT_QUALITY_SCORE: NumberField<SupplierOplScoresAvResults> = new NumberField('InspectionLotQualityScore', SupplierOplScoresAvResults, 'Edm.Double')

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

Static MATERIAL

MATERIAL: StringField<SupplierOplScoresAvResults> = new StringField('Material', SupplierOplScoresAvResults, '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<SupplierOplScoresAvResults> = new StringField('MaterialGroup', SupplierOplScoresAvResults, '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 MATERIAL_GROUP_NAME

MATERIAL_GROUP_NAME: StringField<SupplierOplScoresAvResults> = new StringField('MaterialGroupName', SupplierOplScoresAvResults, 'Edm.String')

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

Static MATERIAL_NAME

MATERIAL_NAME: StringField<SupplierOplScoresAvResults> = new StringField('MaterialName', SupplierOplScoresAvResults, 'Edm.String')

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

Static PARAMETERS

PARAMETERS: OneToOneLink<SupplierOplScoresAvResults, SupplierOplScoresAv> = new OneToOneLink('Parameters', SupplierOplScoresAvResults, SupplierOplScoresAv)

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

Static PLANT

PLANT: StringField<SupplierOplScoresAvResults> = new StringField('Plant', SupplierOplScoresAvResults, '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 PLANT_NAME

PLANT_NAME: StringField<SupplierOplScoresAvResults> = new StringField('PlantName', SupplierOplScoresAvResults, 'Edm.String')

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

Static PRICE_VARIANCE_SCORE

PRICE_VARIANCE_SCORE: NumberField<SupplierOplScoresAvResults> = new NumberField('PriceVarianceScore', SupplierOplScoresAvResults, 'Edm.Double')

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

Static PURCHASE_ORDER_NET_PRICE_AMOUNT

PURCHASE_ORDER_NET_PRICE_AMOUNT: BigNumberField<SupplierOplScoresAvResults> = new BigNumberField('PurchaseOrderNetPriceAmount', SupplierOplScoresAvResults, 'Edm.Decimal')

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

Static PURCHASING_CATEGORY

PURCHASING_CATEGORY: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingCategory', SupplierOplScoresAvResults, 'Edm.String')

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

Static PURCHASING_DOCUMENT

PURCHASING_DOCUMENT: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingDocument', SupplierOplScoresAvResults, 'Edm.String')

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

Static PURCHASING_DOCUMENT_ITEM

PURCHASING_DOCUMENT_ITEM: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingDocumentItem', SupplierOplScoresAvResults, 'Edm.String')

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

Static PURCHASING_GROUP

PURCHASING_GROUP: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingGroup', SupplierOplScoresAvResults, 'Edm.String')

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

Static PURCHASING_GROUP_NAME

PURCHASING_GROUP_NAME: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingGroupName', SupplierOplScoresAvResults, 'Edm.String')

Static representation of the purchasingGroupName 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<SupplierOplScoresAvResults> = new StringField('PurchasingOrganization', SupplierOplScoresAvResults, '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 PURCHASING_ORGANIZATION_NAME

PURCHASING_ORGANIZATION_NAME: StringField<SupplierOplScoresAvResults> = new StringField('PurchasingOrganizationName', SupplierOplScoresAvResults, 'Edm.String')

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

Static PURG_CAT_NAME

PURG_CAT_NAME: StringField<SupplierOplScoresAvResults> = new StringField('PurgCatName', SupplierOplScoresAvResults, 'Edm.String')

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

Static QUALITY_NOTIFICATION_SCORE

QUALITY_NOTIFICATION_SCORE: NumberField<SupplierOplScoresAvResults> = new NumberField('QualityNotificationScore', SupplierOplScoresAvResults, 'Edm.Double')

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

Static QUANTITY_VARIANCE_SCORE

QUANTITY_VARIANCE_SCORE: NumberField<SupplierOplScoresAvResults> = new NumberField('QuantityVarianceScore', SupplierOplScoresAvResults, 'Edm.Double')

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

Static SUPPLIER

SUPPLIER: StringField<SupplierOplScoresAvResults> = new StringField('Supplier', SupplierOplScoresAvResults, '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 SUPPLIER_COUNTRY

SUPPLIER_COUNTRY: StringField<SupplierOplScoresAvResults> = new StringField('SupplierCountry', SupplierOplScoresAvResults, 'Edm.String')

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

Static SUPPLIER_NAME

SUPPLIER_NAME: StringField<SupplierOplScoresAvResults> = new StringField('SupplierName', SupplierOplScoresAvResults, 'Edm.String')

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

Static SUPPLIER_OPERATIONAL_SCORE

SUPPLIER_OPERATIONAL_SCORE: BigNumberField<SupplierOplScoresAvResults> = new BigNumberField('SupplierOperationalScore', SupplierOplScoresAvResults, 'Edm.Decimal')

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

Static TIME_VARIANCE_SCORE

TIME_VARIANCE_SCORE: NumberField<SupplierOplScoresAvResults> = new NumberField('TimeVarianceScore', SupplierOplScoresAvResults, 'Edm.Double')

Static representation of the timeVarianceScore 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<SupplierOplScoresAvResults> | BigNumberField<SupplierOplScoresAvResults> | NumberField<SupplierOplScoresAvResults> | OneToOneLink<SupplierOplScoresAvResults, SupplierOplScoresAv>> = [SupplierOplScoresAvResults.ID,SupplierOplScoresAvResults.PURCHASING_DOCUMENT,SupplierOplScoresAvResults.PURCHASING_DOCUMENT_ITEM,SupplierOplScoresAvResults.CALENDAR_YEAR,SupplierOplScoresAvResults.CALENDAR_QUARTER,SupplierOplScoresAvResults.CALENDAR_MONTH,SupplierOplScoresAvResults.CALENDAR_WEEK,SupplierOplScoresAvResults.PURCHASING_ORGANIZATION,SupplierOplScoresAvResults.PURCHASING_ORGANIZATION_NAME,SupplierOplScoresAvResults.PURCHASING_GROUP,SupplierOplScoresAvResults.PURCHASING_GROUP_NAME,SupplierOplScoresAvResults.COMPANY_CODE,SupplierOplScoresAvResults.SUPPLIER,SupplierOplScoresAvResults.SUPPLIER_NAME,SupplierOplScoresAvResults.SUPPLIER_COUNTRY,SupplierOplScoresAvResults.COUNTRY_NAME,SupplierOplScoresAvResults.MATERIAL,SupplierOplScoresAvResults.MATERIAL_NAME,SupplierOplScoresAvResults.MATERIAL_GROUP,SupplierOplScoresAvResults.MATERIAL_GROUP_NAME,SupplierOplScoresAvResults.PLANT,SupplierOplScoresAvResults.PLANT_NAME,SupplierOplScoresAvResults.PURCHASING_CATEGORY,SupplierOplScoresAvResults.PURG_CAT_NAME,SupplierOplScoresAvResults.PURCHASE_ORDER_NET_PRICE_AMOUNT,SupplierOplScoresAvResults.TIME_VARIANCE_SCORE,SupplierOplScoresAvResults.PRICE_VARIANCE_SCORE,SupplierOplScoresAvResults.QUANTITY_VARIANCE_SCORE,SupplierOplScoresAvResults.INSPECTION_LOT_QUALITY_SCORE,SupplierOplScoresAvResults.QUALITY_NOTIFICATION_SCORE,SupplierOplScoresAvResults.SUPPLIER_OPERATIONAL_SCORE,SupplierOplScoresAvResults.PARAMETERS]

All fields of the SupplierOplScoresAvResults entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_SupplierOplScoresAVResults"

Technical entity name for SupplierOplScoresAvResults.

Static _keyFields

_keyFields: Array<Selectable<SupplierOplScoresAvResults>> = [SupplierOplScoresAvResults.ID]

All key fields of the SupplierOplScoresAvResults entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "A_SUPPLIEROPLSCORESAV_CDS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<SupplierOplScoresAvResults>

    A builder that constructs instances of entity type SupplierOplScoresAvResults.

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

    Returns SupplierOplScoresAvResultsRequestBuilder

    A SupplierOplScoresAvResults request builder.