Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_POSubcontractingComponent" of service "API_PURCHASEORDER_PROCESS_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), Purchase Order Integration (SAP_COM_0053). See https://api.sap.com/api/API_PURCHASEORDER_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PoSubcontractingComponent

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 baseUnit

baseUnit: undefined | string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional batch

batch: undefined | string

Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.

nullable

Optional bomItemDescription

bomItemDescription: undefined | string

BOM Item Text. Text up to 40 characters in length, which explains the item as the first of two text lines. If the BOM item text (two lines of 40 characters each) is not sufficient, you can enter an item long text as well, by going to the Extras menu and choosing the function Long Text -> Item Long Text.When creating an item long text, the BOM item text is transferred to the first 80 characters of the long text.Changing the BOM item text automatically changes the first 80 characters of an existing long text and vice versa.Note:For text items, this text is displayed as a description of the component. Maximum length: 40.

nullable

Optional entryUnit

entryUnit: undefined | string

Unit of entry. Specifies the unit of measure in which the goods movement or inventory count is entered. Enter a unit of measure here only if it differs from the default unit of measure.There are the following default units of measure:the order unit for goods receipts with reference to purchase ordersthe production unit for goods receipts with reference to production ordersthe unit of issue for other goods movementsIf the default unit of measure has not been defined in the material master record, the system will suggest the stockkeeping unit. Maximum length: 3.

nullable

Optional material

material: undefined | string

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

nullable

Optional plant

plant: undefined | string

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

nullable

purchaseOrder

purchaseOrder: string

Purchasing Document. Maximum length: 10.

purchaseOrderItem

purchaseOrderItem: string

Purchasing Document Item. Maximum length: 5.

Optional quantityInEntryUnit

quantityInEntryUnit: BigNumber

Quantity in Unit of Entry.

nullable

recordType

recordType: string

Record type. Maximum length: 1.

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 requiredQuantity

requiredQuantity: BigNumber

Requirement Quantity. Specifies the quantity in the base unit of measure, which can have various meanings, depending on the situation: In the case of a planned order or a production order, this is the quantity of the material component required to manufacture the planned order quantity.In the case of a reservation, this is the quantity reserved.

nullable

Optional requirementDate

requirementDate: Moment

Material Component Requirement Date.

nullable

reservationItem

reservationItem: string

Reservation Item. Maximum length: 4.

scheduleLine

scheduleLine: string

Delivery Schedule Line Counter. Alphanumeric key uniquely identifying the document. Maximum length: 4.

Optional withdrawnQuantity

withdrawnQuantity: BigNumber

Withdrawn Quantity.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<PoSubcontractingComponent> = new StringField('BaseUnit', PoSubcontractingComponent, 'Edm.String')

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

Static BATCH

BATCH: StringField<PoSubcontractingComponent> = new StringField('Batch', PoSubcontractingComponent, 'Edm.String')

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

Static BOM_ITEM_DESCRIPTION

BOM_ITEM_DESCRIPTION: StringField<PoSubcontractingComponent> = new StringField('BOMItemDescription', PoSubcontractingComponent, 'Edm.String')

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

Static ENTRY_UNIT

ENTRY_UNIT: StringField<PoSubcontractingComponent> = new StringField('EntryUnit', PoSubcontractingComponent, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<PoSubcontractingComponent> = new StringField('Material', PoSubcontractingComponent, '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 PLANT

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

PURCHASE_ORDER: StringField<PoSubcontractingComponent> = new StringField('PurchaseOrder', PoSubcontractingComponent, 'Edm.String')

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

Static PURCHASE_ORDER_ITEM

PURCHASE_ORDER_ITEM: StringField<PoSubcontractingComponent> = new StringField('PurchaseOrderItem', PoSubcontractingComponent, 'Edm.String')

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

Static QUANTITY_IN_ENTRY_UNIT

QUANTITY_IN_ENTRY_UNIT: BigNumberField<PoSubcontractingComponent> = new BigNumberField('QuantityInEntryUnit', PoSubcontractingComponent, 'Edm.Decimal')

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

Static RECORD_TYPE

RECORD_TYPE: StringField<PoSubcontractingComponent> = new StringField('RecordType', PoSubcontractingComponent, 'Edm.String')

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

Static REQUIRED_QUANTITY

REQUIRED_QUANTITY: BigNumberField<PoSubcontractingComponent> = new BigNumberField('RequiredQuantity', PoSubcontractingComponent, 'Edm.Decimal')

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

Static REQUIREMENT_DATE

REQUIREMENT_DATE: DateField<PoSubcontractingComponent> = new DateField('RequirementDate', PoSubcontractingComponent, 'Edm.DateTime')

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

Static RESERVATION_ITEM

RESERVATION_ITEM: StringField<PoSubcontractingComponent> = new StringField('ReservationItem', PoSubcontractingComponent, 'Edm.String')

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

Static SCHEDULE_LINE

SCHEDULE_LINE: StringField<PoSubcontractingComponent> = new StringField('ScheduleLine', PoSubcontractingComponent, 'Edm.String')

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

Static WITHDRAWN_QUANTITY

WITHDRAWN_QUANTITY: BigNumberField<PoSubcontractingComponent> = new BigNumberField('WithdrawnQuantity', PoSubcontractingComponent, 'Edm.Decimal')

Static representation of the withdrawnQuantity 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<PoSubcontractingComponent> | BigNumberField<PoSubcontractingComponent> | DateField<PoSubcontractingComponent>> = [PoSubcontractingComponent.PURCHASE_ORDER,PoSubcontractingComponent.PURCHASE_ORDER_ITEM,PoSubcontractingComponent.SCHEDULE_LINE,PoSubcontractingComponent.RESERVATION_ITEM,PoSubcontractingComponent.RECORD_TYPE,PoSubcontractingComponent.MATERIAL,PoSubcontractingComponent.BOM_ITEM_DESCRIPTION,PoSubcontractingComponent.REQUIRED_QUANTITY,PoSubcontractingComponent.BASE_UNIT,PoSubcontractingComponent.REQUIREMENT_DATE,PoSubcontractingComponent.QUANTITY_IN_ENTRY_UNIT,PoSubcontractingComponent.ENTRY_UNIT,PoSubcontractingComponent.WITHDRAWN_QUANTITY,PoSubcontractingComponent.PLANT,PoSubcontractingComponent.BATCH]

All fields of the PoSubcontractingComponent entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_POSubcontractingComponent"

Technical entity name for PoSubcontractingComponent.

Static _keyFields

_keyFields: Array<Selectable<PoSubcontractingComponent>> = [PoSubcontractingComponent.PURCHASE_ORDER, PoSubcontractingComponent.PURCHASE_ORDER_ITEM, PoSubcontractingComponent.SCHEDULE_LINE, PoSubcontractingComponent.RESERVATION_ITEM, PoSubcontractingComponent.RECORD_TYPE]

All key fields of the PoSubcontractingComponent entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASEORDER_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PoSubcontractingComponent>

    A builder that constructs instances of entity type PoSubcontractingComponent.

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

    Returns PoSubcontractingComponentRequestBuilder

    A PoSubcontractingComponent request builder.