Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • PlannedOrderCapacity

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns PlannedOrderCapacity

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 capacity

capacity: undefined | string

Name der Kapazität. Bezeichnung, unter der die Kapazität (z.B. eine Maschinenkapazität, eine Personalkapazität oder eine Transportkapazität) im System angelegt werden soll (beim Anlegen der Kapazität) oderim System bekannt ist (beim Ändern, Anzeigen oder bei der Verwendung der Kapazität. Maximum length: 8.

nullable

Optional capacityCategoryCode

capacityCategoryCode: undefined | string

Kapazitätsart. Maximum length: 3.

nullable

capacityRequirement

capacityRequirement: string

ID des Kapazitätsbedarfssatzes. Maximum length: 12.

capacityRequirementItem

capacityRequirementItem: string

Kapazitätsbedarfsposition. Maximum length: 8.

Optional capacityRequirementUnit

capacityRequirementUnit: undefined | string

Mengeneinheit für Kapazitätsbedarf. Diese Maßeinheit wird nur berücksichtigt, wenn Sie das Kennzeichen für die Herkunft der Maßeinheit nicht setzen. Maximum length: 3.

nullable

capacityRqmtItemCapacity

capacityRqmtItemCapacity: string

Einzelkapazität einer Kapazitätsbedarfsposition. Maximum length: 4.

Optional lastChangeDateTime

lastChangeDateTime: Moment

Letzte Aenderung Planauftrag: Zeitstempel.

nullable

Optional mrpController

mrpController: undefined | string

Disponent. Maximum length: 3.

nullable

Optional mrpPlant

mrpPlant: undefined | string

Planungswerk. Nummer, die das Werk, in dem die Bedarfsplanung, die Prognose oder die Langfristplanung durchgeführt wird, eindeutig identifziert. Maximum length: 4.

nullable

Optional operation

operation: undefined | string

Vorgangsnummer. Legt fest, in welcher Reihenfolge die Vorgänge einer Folge ausgeführt werden. Maximum length: 4.

nullable

Optional operationEarliestEndDate

operationEarliestEndDate: Moment

Frühestes Enddatum. Frühestes Enddatum eines Vorgangs.

nullable

Optional operationEarliestEndTime

operationEarliestEndTime: Time

Früheste Endezeit. Frühestes Ende (Uhrzeit) eines Vorgangs.

nullable

Optional operationEarliestStartDate

operationEarliestStartDate: Moment

Frühester Starttermin. Frühestes Startdatum eines Vorgangs.

nullable

Optional operationEarliestStartTime

operationEarliestStartTime: Time

Früheste Startzeit. Früheste Startuhrzeit eines Vorgangs.

nullable

Optional operationLatestEndDate

operationLatestEndDate: Moment

Spätestes Enddatum. Spätestes Ende eines Vorgangs (Datum).

nullable

Optional operationLatestEndTime

operationLatestEndTime: Time

Späteste Endzeit. Spätestes Ende eines Vorgangs (Uhrzeit).

nullable

Optional operationLatestStartDate

operationLatestStartDate: Moment

Spätestes Startdatum. In dieser Spalte wird der vom System errechnete späteste Starttermin (Datum) für den Auftrag angezeigt.

nullable

Optional operationLatestStartTime

operationLatestStartTime: Time

Späteste Startzeit. In dieser Spalte wird der vom System errechnete späteste Starttermin (Uhrzeit) für den Auftrag angezeigt.

nullable

Optional operationText

operationText: undefined | string

Kurztext Vorgang. Beschreibt den Vorgang oder Untervorgang. Dieser Text wird in die erste Zeile des Langtexts zum Vorgang oder Untervorgang übernommen.Zeichenformate wie z.B. fett oder kursiv werden im Kurztext nicht unterstützt. Wenn Sie im Langtext Zeichenformate verwenden, werden im Kurztext die zugehörigen Steuerkennzeichen ausgegeben. Maximum length: 40.

nullable

Optional plannedOrder

plannedOrder: undefined | string

Planauftrag. Identifiziert den Planauftrag zu einem Material eindeutig. Maximum length: 10.

nullable

Optional plannedOrderType

plannedOrderType: undefined | string

Planauftragsart. Steuert, für welche Auftragsart (z.B. Normalbestellung, Lagerauftrag) der Planauftrag vorgesehen ist. Maximum length: 4.

nullable

Optional remainingCapReqOpSegProcgDurn

remainingCapReqOpSegProcgDurn: undefined | number

Restkapazitätsbedarf für Bearbeitung.

nullable

Optional remainingCapReqOpSegSetupDurn

remainingCapReqOpSegSetupDurn: undefined | number

Restkapazitätsbedarf für Rüsten.

nullable

Optional remainingCapReqOpSegTrdwnDurn

remainingCapReqOpSegTrdwnDurn: undefined | number

Restkapazitätsbedarf für Abrüsten.

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 scheduledCapReqOpSegProcgDurn

scheduledCapReqOpSegProcgDurn: undefined | number

Geplanter Kapazitätsbedarf für Bearbeitung.

nullable

Optional scheduledCapReqOpSegSetupDurn

scheduledCapReqOpSegSetupDurn: undefined | number

Geplanter Kapazitätsbedarf für Rüsten.

nullable

Optional scheduledCapReqOpSegTrdwnDurn

scheduledCapReqOpSegTrdwnDurn: undefined | number

Geplanter Kapazitätsbedarf für Abrüsten.

nullable

Optional sequence

sequence: undefined | string

Folge. Identifiziert eine Folge von Vorgängen innerhalb eines Planes. Maximum length: 6.

nullable

Optional subOperation

subOperation: undefined | string

Untervorgang. Legt fest, in welcher Reihenfolge die Untervorgänge eines Vorgangs aufgelistet werden. Maximum length: 4.

nullable

Optional unitOfMeasureIsoCode

unitOfMeasureIsoCode: undefined | string

ISO-Code Maßeinheit. ISO-Code für Maßeinheiten. Ein ISO-Code kann mehreren internen Maßeinheiten einer Dimension zugeordnet sein. Der ISO-Code ist für EDI wichtig. Er dient der Umsetzung der SAP-internen Maßeinheiten in genormte Maßeinheiten. Ein Austausch von Daten über EDI macht eine Umsetzung der internen Maßeinheiten in den ISO-Code unerläßlich.Eine aktuelle Liste der zur Zeit international festgelegten ISO-Codes kann bei der entsprechenden UN-Kommission (WP.4 Trade Facilitation Recommendations, Recommendation 20) angefordert werden:UN Economic Commission for EuropeInformation OfficePalais des Nations1211 GenevaSwitzerlande-mail: info.ece@unece.orgoder direkt über internet eingesehen werden:http://www.unece.org/cefact/codesfortrade/codes_index.htmWeitere Informationen sind im OSS-Hinweis 69063 hinterlegt. Maximum length: 3.

nullable

Optional workCenter

workCenter: undefined | string

Arbeitsplatz. Maximum length: 8.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CAPACITY

CAPACITY: StringField<PlannedOrderCapacity> = new StringField('Capacity', PlannedOrderCapacity, 'Edm.String')

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

Static CAPACITY_CATEGORY_CODE

CAPACITY_CATEGORY_CODE: StringField<PlannedOrderCapacity> = new StringField('CapacityCategoryCode', PlannedOrderCapacity, 'Edm.String')

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

Static CAPACITY_REQUIREMENT

CAPACITY_REQUIREMENT: StringField<PlannedOrderCapacity> = new StringField('CapacityRequirement', PlannedOrderCapacity, 'Edm.String')

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

Static CAPACITY_REQUIREMENT_ITEM

CAPACITY_REQUIREMENT_ITEM: StringField<PlannedOrderCapacity> = new StringField('CapacityRequirementItem', PlannedOrderCapacity, 'Edm.String')

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

Static CAPACITY_REQUIREMENT_UNIT

CAPACITY_REQUIREMENT_UNIT: StringField<PlannedOrderCapacity> = new StringField('CapacityRequirementUnit', PlannedOrderCapacity, 'Edm.String')

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

Static CAPACITY_RQMT_ITEM_CAPACITY

CAPACITY_RQMT_ITEM_CAPACITY: StringField<PlannedOrderCapacity> = new StringField('CapacityRqmtItemCapacity', PlannedOrderCapacity, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<PlannedOrderCapacity> = new DateField('LastChangeDateTime', PlannedOrderCapacity, 'Edm.DateTimeOffset')

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

Static MRP_CONTROLLER

MRP_CONTROLLER: StringField<PlannedOrderCapacity> = new StringField('MRPController', PlannedOrderCapacity, 'Edm.String')

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

Static MRP_PLANT

MRP_PLANT: StringField<PlannedOrderCapacity> = new StringField('MRPPlant', PlannedOrderCapacity, 'Edm.String')

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

Static OPERATION

OPERATION: StringField<PlannedOrderCapacity> = new StringField('Operation', PlannedOrderCapacity, 'Edm.String')

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

Static OPERATION_EARLIEST_END_DATE

OPERATION_EARLIEST_END_DATE: DateField<PlannedOrderCapacity> = new DateField('OperationEarliestEndDate', PlannedOrderCapacity, 'Edm.DateTime')

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

Static OPERATION_EARLIEST_END_TIME

OPERATION_EARLIEST_END_TIME: TimeField<PlannedOrderCapacity> = new TimeField('OperationEarliestEndTime', PlannedOrderCapacity, 'Edm.Time')

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

Static OPERATION_EARLIEST_START_DATE

OPERATION_EARLIEST_START_DATE: DateField<PlannedOrderCapacity> = new DateField('OperationEarliestStartDate', PlannedOrderCapacity, 'Edm.DateTime')

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

Static OPERATION_EARLIEST_START_TIME

OPERATION_EARLIEST_START_TIME: TimeField<PlannedOrderCapacity> = new TimeField('OperationEarliestStartTime', PlannedOrderCapacity, 'Edm.Time')

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

Static OPERATION_LATEST_END_DATE

OPERATION_LATEST_END_DATE: DateField<PlannedOrderCapacity> = new DateField('OperationLatestEndDate', PlannedOrderCapacity, 'Edm.DateTime')

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

Static OPERATION_LATEST_END_TIME

OPERATION_LATEST_END_TIME: TimeField<PlannedOrderCapacity> = new TimeField('OperationLatestEndTime', PlannedOrderCapacity, 'Edm.Time')

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

Static OPERATION_LATEST_START_DATE

OPERATION_LATEST_START_DATE: DateField<PlannedOrderCapacity> = new DateField('OperationLatestStartDate', PlannedOrderCapacity, 'Edm.DateTime')

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

Static OPERATION_LATEST_START_TIME

OPERATION_LATEST_START_TIME: TimeField<PlannedOrderCapacity> = new TimeField('OperationLatestStartTime', PlannedOrderCapacity, 'Edm.Time')

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

Static OPERATION_TEXT

OPERATION_TEXT: StringField<PlannedOrderCapacity> = new StringField('OperationText', PlannedOrderCapacity, 'Edm.String')

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

Static PLANNED_ORDER

PLANNED_ORDER: StringField<PlannedOrderCapacity> = new StringField('PlannedOrder', PlannedOrderCapacity, 'Edm.String')

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

Static PLANNED_ORDER_TYPE

PLANNED_ORDER_TYPE: StringField<PlannedOrderCapacity> = new StringField('PlannedOrderType', PlannedOrderCapacity, 'Edm.String')

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

Static REMAINING_CAP_REQ_OP_SEG_PROCG_DURN

REMAINING_CAP_REQ_OP_SEG_PROCG_DURN: NumberField<PlannedOrderCapacity> = new NumberField('RemainingCapReqOpSegProcgDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static REMAINING_CAP_REQ_OP_SEG_SETUP_DURN

REMAINING_CAP_REQ_OP_SEG_SETUP_DURN: NumberField<PlannedOrderCapacity> = new NumberField('RemainingCapReqOpSegSetupDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static REMAINING_CAP_REQ_OP_SEG_TRDWN_DURN

REMAINING_CAP_REQ_OP_SEG_TRDWN_DURN: NumberField<PlannedOrderCapacity> = new NumberField('RemainingCapReqOpSegTrdwnDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static SCHEDULED_CAP_REQ_OP_SEG_PROCG_DURN

SCHEDULED_CAP_REQ_OP_SEG_PROCG_DURN: NumberField<PlannedOrderCapacity> = new NumberField('ScheduledCapReqOpSegProcgDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static SCHEDULED_CAP_REQ_OP_SEG_SETUP_DURN

SCHEDULED_CAP_REQ_OP_SEG_SETUP_DURN: NumberField<PlannedOrderCapacity> = new NumberField('ScheduledCapReqOpSegSetupDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static SCHEDULED_CAP_REQ_OP_SEG_TRDWN_DURN

SCHEDULED_CAP_REQ_OP_SEG_TRDWN_DURN: NumberField<PlannedOrderCapacity> = new NumberField('ScheduledCapReqOpSegTrdwnDurn', PlannedOrderCapacity, 'Edm.Double')

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

Static SEQUENCE

SEQUENCE: StringField<PlannedOrderCapacity> = new StringField('Sequence', PlannedOrderCapacity, 'Edm.String')

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

Static SUB_OPERATION

SUB_OPERATION: StringField<PlannedOrderCapacity> = new StringField('SubOperation', PlannedOrderCapacity, 'Edm.String')

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

Static UNIT_OF_MEASURE_ISO_CODE

UNIT_OF_MEASURE_ISO_CODE: StringField<PlannedOrderCapacity> = new StringField('UnitOfMeasureISOCode', PlannedOrderCapacity, 'Edm.String')

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

Static WORK_CENTER

WORK_CENTER: StringField<PlannedOrderCapacity> = new StringField('WorkCenter', PlannedOrderCapacity, 'Edm.String')

Static representation of the workCenter 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<PlannedOrderCapacity> | DateField<PlannedOrderCapacity> | TimeField<PlannedOrderCapacity> | NumberField<PlannedOrderCapacity>> = [PlannedOrderCapacity.CAPACITY_REQUIREMENT,PlannedOrderCapacity.CAPACITY_REQUIREMENT_ITEM,PlannedOrderCapacity.CAPACITY_RQMT_ITEM_CAPACITY,PlannedOrderCapacity.PLANNED_ORDER,PlannedOrderCapacity.PLANNED_ORDER_TYPE,PlannedOrderCapacity.SEQUENCE,PlannedOrderCapacity.OPERATION,PlannedOrderCapacity.SUB_OPERATION,PlannedOrderCapacity.WORK_CENTER,PlannedOrderCapacity.CAPACITY_CATEGORY_CODE,PlannedOrderCapacity.CAPACITY,PlannedOrderCapacity.MRP_CONTROLLER,PlannedOrderCapacity.MRP_PLANT,PlannedOrderCapacity.OPERATION_LATEST_START_DATE,PlannedOrderCapacity.OPERATION_LATEST_START_TIME,PlannedOrderCapacity.OPERATION_LATEST_END_DATE,PlannedOrderCapacity.OPERATION_LATEST_END_TIME,PlannedOrderCapacity.OPERATION_EARLIEST_START_DATE,PlannedOrderCapacity.OPERATION_EARLIEST_START_TIME,PlannedOrderCapacity.OPERATION_EARLIEST_END_DATE,PlannedOrderCapacity.OPERATION_EARLIEST_END_TIME,PlannedOrderCapacity.CAPACITY_REQUIREMENT_UNIT,PlannedOrderCapacity.SCHEDULED_CAP_REQ_OP_SEG_SETUP_DURN,PlannedOrderCapacity.REMAINING_CAP_REQ_OP_SEG_SETUP_DURN,PlannedOrderCapacity.SCHEDULED_CAP_REQ_OP_SEG_PROCG_DURN,PlannedOrderCapacity.REMAINING_CAP_REQ_OP_SEG_PROCG_DURN,PlannedOrderCapacity.SCHEDULED_CAP_REQ_OP_SEG_TRDWN_DURN,PlannedOrderCapacity.REMAINING_CAP_REQ_OP_SEG_TRDWN_DURN,PlannedOrderCapacity.UNIT_OF_MEASURE_ISO_CODE,PlannedOrderCapacity.OPERATION_TEXT,PlannedOrderCapacity.LAST_CHANGE_DATE_TIME]

All fields of the PlannedOrderCapacity entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PlannedOrderCapacity"

Technical entity name for PlannedOrderCapacity.

Static _keyFields

_keyFields: Array<Selectable<PlannedOrderCapacity>> = [PlannedOrderCapacity.CAPACITY_REQUIREMENT, PlannedOrderCapacity.CAPACITY_REQUIREMENT_ITEM, PlannedOrderCapacity.CAPACITY_RQMT_ITEM_CAPACITY]

All key fields of the PlannedOrderCapacity entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PLANNED_ORDERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PlannedOrderCapacity>

    A builder that constructs instances of entity type PlannedOrderCapacity.

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

    Returns PlannedOrderCapacityRequestBuilder

    A PlannedOrderCapacity request builder.