Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductPlantProcurement" of service "API_CLFN_PRODUCT_SRV". This service is part of the following communication scenarios: Product Classification Integration (SAP_COM_0309). See https://api.sap.com/api/API_CLFN_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductPlantProcurement

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 isAutoPurOrdCreationAllowed

isAutoPurOrdCreationAllowed: undefined | false | true

Indicator: "automatic purchase order allowed". Defines that purchase orders are generated automatically when purchase requsisitions are converted into purchase orders. If this indicator is flagged, the system does not display the purchase orders on the screen before they are saved. In the master record for the vendor with whom the material is ordered, the field "Automatic purchase order" must be flagged in the control data for the purchasing data.

nullable

Optional isSourceListRequired

isSourceListRequired: undefined | false | true

Indicator: Source list requirement. Specifies that the source list must have been maintained in the case of external procurement for a certain plant. If the indicator has been set for a plant, a source of supply must be entered in the source list before a purchase order can be created for issue to the source for the plant.

nullable

plant

plant: string

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

product

product: string

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

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 sourceOfSupplyCategory

sourceOfSupplyCategory: undefined | string

Source of Supply. Restricts the search for sources of supply for this material to external (normal) or internal (stock transfer) sources of supply, and also allows you to define a search sequence. The entry you make is used by the system in source determination if it cannot find a unique source of supply in the quota arrangement and source list. If the plant to be supplied is assigned to a supply region, the system chooses a potential source of supply only if the source of supply is valid for the plant's supply region. Maximum length: 1.

nullable

Static ALL_FIELDS

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

All fields selector.

Static IS_AUTO_PUR_ORD_CREATION_ALLOWED

IS_AUTO_PUR_ORD_CREATION_ALLOWED: BooleanField<ProductPlantProcurement> = new BooleanField('IsAutoPurOrdCreationAllowed', ProductPlantProcurement, 'Edm.Boolean')

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

Static IS_SOURCE_LIST_REQUIRED

IS_SOURCE_LIST_REQUIRED: BooleanField<ProductPlantProcurement> = new BooleanField('IsSourceListRequired', ProductPlantProcurement, 'Edm.Boolean')

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

Static PLANT

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

PRODUCT: StringField<ProductPlantProcurement> = new StringField('Product', ProductPlantProcurement, 'Edm.String')

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

Static SOURCE_OF_SUPPLY_CATEGORY

SOURCE_OF_SUPPLY_CATEGORY: StringField<ProductPlantProcurement> = new StringField('SourceOfSupplyCategory', ProductPlantProcurement, 'Edm.String')

Static representation of the sourceOfSupplyCategory 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<ProductPlantProcurement> | BooleanField<ProductPlantProcurement>> = [ProductPlantProcurement.PRODUCT,ProductPlantProcurement.PLANT,ProductPlantProcurement.IS_AUTO_PUR_ORD_CREATION_ALLOWED,ProductPlantProcurement.IS_SOURCE_LIST_REQUIRED,ProductPlantProcurement.SOURCE_OF_SUPPLY_CATEGORY]

All fields of the ProductPlantProcurement entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductPlantProcurement"

Technical entity name for ProductPlantProcurement.

Static _keyFields

_keyFields: Array<Selectable<ProductPlantProcurement>> = [ProductPlantProcurement.PRODUCT, ProductPlantProcurement.PLANT]

All key fields of the ProductPlantProcurement entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CLFN_PRODUCT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductPlantProcurement>

    A builder that constructs instances of entity type ProductPlantProcurement.

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

    Returns ProductPlantProcurementRequestBuilder

    A ProductPlantProcurement request builder.