Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductionRsceTools" of service "API_PRODUCTION_ORDERS". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PRODUCTION_ORDERS for more information.

Hierarchy

  • Entity
    • ProductionRsceTools

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ProductionRsceTools

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 confirmedProdnRsceToolQty

confirmedProdnRsceToolQty: BigNumber

Actual Quantity of Production Resource/Tool. Quantity of production resources/tools that has already been confirmed in the order.

nullable

Optional confirmedProdnRsceToolQtyUnit

confirmedProdnRsceToolQtyUnit: string

Unit for Actual Quantity of Production Resource/Tool. Maximum length: 3.

nullable

Optional earliestSchedldUsageEndDate

earliestSchedldUsageEndDate: Moment

Earliest Scheduled End Date of PRT Usage.

nullable

Optional earliestSchedldUsageEndTime

earliestSchedldUsageEndTime: Time

Earliest Scheduled End Time of PRT Usage.

nullable

Optional earliestSchedldUsageStartDate

earliestSchedldUsageStartDate: Moment

Earliest Scheduled Start Date for PRT Usage.

nullable

Optional earliestSchedldUsageStartTime

earliestSchedldUsageStartTime: Time

Earliest Scheduled Start Time for PRT Usage.

nullable

Optional latestSchedldUsageEndDate

latestSchedldUsageEndDate: Moment

Latest Scheduled End Date for PRT Usage.

nullable

Optional latestSchedldUsageEndTime

latestSchedldUsageEndTime: Time

Latest Scheduled End Time for PRT Usage.

nullable

Optional latestSchedldUsageStartDate

latestSchedldUsageStartDate: Moment

Latest Scheduled Start Date for PRT Usage.

nullable

Optional latestSchedldUsageStartTime

latestSchedldUsageStartTime: Time

Latest Scheduled Start Time for PRT Usage.

nullable

Optional manufacturingOrder

manufacturingOrder: string

Manufacturing Order ID. Maximum length: 12.

nullable

Optional manufacturingOrderCategory

manufacturingOrderCategory: string

Manufacturing Order Category. Maximum length: 2.

nullable

Optional manufacturingOrderType

manufacturingOrderType: string

Manufacturing Order Type. Maximum length: 4.

nullable

mfgOrderOpProdnRsceToolIntId

mfgOrderOpProdnRsceToolIntId: string

Item Counter for Production Resources/Tools. Serial counter which is used for the unique identification of production resources/tools. The item counter is entered as a key element in various data structures of PRT management. Maximum length: 8.

orderInternalBillOfOperations

orderInternalBillOfOperations: string

Order Internal ID. Maximum length: 10.

Optional plannedProdnRsceToolQtyUnit

plannedProdnRsceToolQtyUnit: string

Unit for Total Planned Quantity of Production Resource/Tool. Maximum length: 3.

nullable

Optional plannedTotalProdnRsceToolQty

plannedTotalProdnRsceToolQty: BigNumber

Total Planned Quantity of Production Resource/Tool. Quantity of production resources/tools needed to produce the number required in the order.

nullable

Optional prodnRsceToolCategory

prodnRsceToolCategory: string

Production Resources/Tools Category. Key which distinguishes the master record category for production resources/tools. Based on the category, you can see whether the production resource/tool is a material or not. Maximum length: 1.

nullable

Optional prodnRsceToolCategoryName

prodnRsceToolCategoryName: string

Language-dependent description of the PRT category. Text which describes the production resources/tools category in more detail. You can maintain this text in different languages with a length of 40 characters. Maximum length: 40.

nullable

Optional prodnRsceToolUsageQuantity

prodnRsceToolUsageQuantity: BigNumber

Standard Usage Value for Production Resources/Tools. Determines the wear and tear on the production resources/tools. Usage value refers to the base quantity in the operation.

nullable

Optional prodnRsceToolUsageQuantityUnit

prodnRsceToolUsageQuantityUnit: string

Usage Value Unit of the Production Resource/Tool. Unit in which the usage value of production resources/tools is defined. Maximum length: 3.

nullable

Optional productionPlant

productionPlant: string

Production Plant in Planned Order. Plant in which the order quantity of the internally produced material is to be produced according to the planned order. Maximum length: 4.

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

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

All fields selector.

Static CONFIRMED_PRODN_RSCE_TOOL_QTY

CONFIRMED_PRODN_RSCE_TOOL_QTY: BigNumberField<ProductionRsceTools> = new BigNumberField('ConfirmedProdnRsceToolQty', ProductionRsceTools, 'Edm.Decimal')

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

Static CONFIRMED_PRODN_RSCE_TOOL_QTY_UNIT

CONFIRMED_PRODN_RSCE_TOOL_QTY_UNIT: StringField<ProductionRsceTools> = new StringField('ConfirmedProdnRsceToolQtyUnit', ProductionRsceTools, 'Edm.String')

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

Static EARLIEST_SCHEDLD_USAGE_END_DATE

EARLIEST_SCHEDLD_USAGE_END_DATE: DateField<ProductionRsceTools> = new DateField('EarliestSchedldUsageEndDate', ProductionRsceTools, 'Edm.DateTime')

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

Static EARLIEST_SCHEDLD_USAGE_END_TIME

EARLIEST_SCHEDLD_USAGE_END_TIME: TimeField<ProductionRsceTools> = new TimeField('EarliestSchedldUsageEndTime', ProductionRsceTools, 'Edm.Time')

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

Static EARLIEST_SCHEDLD_USAGE_START_DATE

EARLIEST_SCHEDLD_USAGE_START_DATE: DateField<ProductionRsceTools> = new DateField('EarliestSchedldUsageStartDate', ProductionRsceTools, 'Edm.DateTime')

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

Static EARLIEST_SCHEDLD_USAGE_START_TIME

EARLIEST_SCHEDLD_USAGE_START_TIME: TimeField<ProductionRsceTools> = new TimeField('EarliestSchedldUsageStartTime', ProductionRsceTools, 'Edm.Time')

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

Static LATEST_SCHEDLD_USAGE_END_DATE

LATEST_SCHEDLD_USAGE_END_DATE: DateField<ProductionRsceTools> = new DateField('LatestSchedldUsageEndDate', ProductionRsceTools, 'Edm.DateTime')

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

Static LATEST_SCHEDLD_USAGE_END_TIME

LATEST_SCHEDLD_USAGE_END_TIME: TimeField<ProductionRsceTools> = new TimeField('LatestSchedldUsageEndTime', ProductionRsceTools, 'Edm.Time')

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

Static LATEST_SCHEDLD_USAGE_START_DATE

LATEST_SCHEDLD_USAGE_START_DATE: DateField<ProductionRsceTools> = new DateField('LatestSchedldUsageStartDate', ProductionRsceTools, 'Edm.DateTime')

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

Static LATEST_SCHEDLD_USAGE_START_TIME

LATEST_SCHEDLD_USAGE_START_TIME: TimeField<ProductionRsceTools> = new TimeField('LatestSchedldUsageStartTime', ProductionRsceTools, 'Edm.Time')

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

Static MANUFACTURING_ORDER

MANUFACTURING_ORDER: StringField<ProductionRsceTools> = new StringField('ManufacturingOrder', ProductionRsceTools, 'Edm.String')

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

Static MANUFACTURING_ORDER_CATEGORY

MANUFACTURING_ORDER_CATEGORY: StringField<ProductionRsceTools> = new StringField('ManufacturingOrderCategory', ProductionRsceTools, 'Edm.String')

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

Static MANUFACTURING_ORDER_TYPE

MANUFACTURING_ORDER_TYPE: StringField<ProductionRsceTools> = new StringField('ManufacturingOrderType', ProductionRsceTools, 'Edm.String')

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

Static MFG_ORDER_OP_PRODN_RSCE_TOOL_INT_ID

MFG_ORDER_OP_PRODN_RSCE_TOOL_INT_ID: StringField<ProductionRsceTools> = new StringField('MfgOrderOpProdnRsceToolIntID', ProductionRsceTools, 'Edm.String')

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

Static ORDER_INTERNAL_BILL_OF_OPERATIONS

ORDER_INTERNAL_BILL_OF_OPERATIONS: StringField<ProductionRsceTools> = new StringField('OrderInternalBillOfOperations', ProductionRsceTools, 'Edm.String')

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

Static PLANNED_PRODN_RSCE_TOOL_QTY_UNIT

PLANNED_PRODN_RSCE_TOOL_QTY_UNIT: StringField<ProductionRsceTools> = new StringField('PlannedProdnRsceToolQtyUnit', ProductionRsceTools, 'Edm.String')

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

Static PLANNED_TOTAL_PRODN_RSCE_TOOL_QTY

PLANNED_TOTAL_PRODN_RSCE_TOOL_QTY: BigNumberField<ProductionRsceTools> = new BigNumberField('PlannedTotalProdnRsceToolQty', ProductionRsceTools, 'Edm.Decimal')

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

Static PRODN_RSCE_TOOL_CATEGORY

PRODN_RSCE_TOOL_CATEGORY: StringField<ProductionRsceTools> = new StringField('ProdnRsceToolCategory', ProductionRsceTools, 'Edm.String')

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

Static PRODN_RSCE_TOOL_CATEGORY_NAME

PRODN_RSCE_TOOL_CATEGORY_NAME: StringField<ProductionRsceTools> = new StringField('ProdnRsceToolCategoryName', ProductionRsceTools, 'Edm.String')

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

Static PRODN_RSCE_TOOL_USAGE_QUANTITY

PRODN_RSCE_TOOL_USAGE_QUANTITY: BigNumberField<ProductionRsceTools> = new BigNumberField('ProdnRsceToolUsageQuantity', ProductionRsceTools, 'Edm.Decimal')

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

Static PRODN_RSCE_TOOL_USAGE_QUANTITY_UNIT

PRODN_RSCE_TOOL_USAGE_QUANTITY_UNIT: StringField<ProductionRsceTools> = new StringField('ProdnRsceToolUsageQuantityUnit', ProductionRsceTools, 'Edm.String')

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

Static PRODUCTION_PLANT

PRODUCTION_PLANT: StringField<ProductionRsceTools> = new StringField('ProductionPlant', ProductionRsceTools, 'Edm.String')

Static representation of the productionPlant 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<ProductionRsceTools> | BigNumberField<ProductionRsceTools> | DateField<ProductionRsceTools> | TimeField<ProductionRsceTools>> = [ProductionRsceTools.ORDER_INTERNAL_BILL_OF_OPERATIONS,ProductionRsceTools.MFG_ORDER_OP_PRODN_RSCE_TOOL_INT_ID,ProductionRsceTools.MANUFACTURING_ORDER,ProductionRsceTools.PRODN_RSCE_TOOL_CATEGORY,ProductionRsceTools.PRODN_RSCE_TOOL_CATEGORY_NAME,ProductionRsceTools.PLANNED_PRODN_RSCE_TOOL_QTY_UNIT,ProductionRsceTools.PLANNED_TOTAL_PRODN_RSCE_TOOL_QTY,ProductionRsceTools.CONFIRMED_PRODN_RSCE_TOOL_QTY_UNIT,ProductionRsceTools.CONFIRMED_PRODN_RSCE_TOOL_QTY,ProductionRsceTools.PRODN_RSCE_TOOL_USAGE_QUANTITY_UNIT,ProductionRsceTools.PRODN_RSCE_TOOL_USAGE_QUANTITY,ProductionRsceTools.EARLIEST_SCHEDLD_USAGE_START_DATE,ProductionRsceTools.EARLIEST_SCHEDLD_USAGE_START_TIME,ProductionRsceTools.EARLIEST_SCHEDLD_USAGE_END_DATE,ProductionRsceTools.EARLIEST_SCHEDLD_USAGE_END_TIME,ProductionRsceTools.LATEST_SCHEDLD_USAGE_START_DATE,ProductionRsceTools.LATEST_SCHEDLD_USAGE_START_TIME,ProductionRsceTools.LATEST_SCHEDLD_USAGE_END_DATE,ProductionRsceTools.LATEST_SCHEDLD_USAGE_END_TIME,ProductionRsceTools.MANUFACTURING_ORDER_TYPE,ProductionRsceTools.MANUFACTURING_ORDER_CATEGORY,ProductionRsceTools.PRODUCTION_PLANT]

All fields of the ProductionRsceTools entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductionRsceTools"

Technical entity name for ProductionRsceTools.

Static _keyFields

_keyFields: Array<Selectable<ProductionRsceTools>> = [ProductionRsceTools.ORDER_INTERNAL_BILL_OF_OPERATIONS, ProductionRsceTools.MFG_ORDER_OP_PRODN_RSCE_TOOL_INT_ID]

All key fields of the ProductionRsceTools entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCTION_ORDERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductionRsceTools>

    A builder that constructs instances of entity type ProductionRsceTools.

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

    Returns ProductionRsceToolsRequestBuilder

    A ProductionRsceTools request builder.