Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • WorkCenterCapDayOp

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns WorkCenterCapDayOp

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

capacityInternalId

capacityInternalId: string

Capacity ID. Maximum length: 8.

capacityRequirement

capacityRequirement: string

ID of the Capacity Requirements Record. Maximum length: 12.

Optional capacityRequirementOrigin

capacityRequirementOrigin: string

Capacity Requirement Origin. Maximum length: 1.

nullable

Optional capacityRequirementUnit

capacityRequirementUnit: string

Unit of Measure for Capacity Requirements. This unit of measure is only taken into account if you have not set the indicator for the origin of the unit of measure. Maximum length: 3.

nullable

Optional capacityRequirementsAreDtmnd

capacityRequirementsAreDtmnd: BigNumber

Capacity Requirements Are Dtmnd.

nullable

material

material: string

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

mrpController

mrpController: string

Mrp Controller. Maximum length: 3.

Optional opLtstSchedldProcgStrtDte

opLtstSchedldProcgStrtDte: string

Op Ltst Schedld Procg Strt Dte. Maximum length: 8.

nullable

Optional opLtstSchedldProcgStrtTme

opLtstSchedldProcgStrtTme: string

Op Ltst Schedld Procg Strt Tme. Maximum length: 6.

nullable

Optional opLtstSchedldTrdwnStrtDte

opLtstSchedldTrdwnStrtDte: string

Op Ltst Schedld Trdwn Strt Dte. Maximum length: 8.

nullable

Optional opLtstSchedldTrdwnStrtTme

opLtstSchedldTrdwnStrtTme: string

Op Ltst Schedld Trdwn Strt Tme. Maximum length: 6.

nullable

operation

operation: string

Operation/Activity Number. Production Planning Determines in which order the operations of a sequence are carried out.Project SystemNumber that identifies an activity. Maximum length: 4.

Optional operationLatestEndDate

operationLatestEndDate: string

Operation Latest End Date. Maximum length: 8.

nullable

Optional operationLatestEndTime

operationLatestEndTime: string

Operation Latest End Time. Maximum length: 6.

nullable

Optional operationLatestStartDate

operationLatestStartDate: string

Operation Latest Start Date. Maximum length: 8.

nullable

Optional operationLatestStartTime

operationLatestStartTime: string

Operation Latest Start Time. Maximum length: 6.

nullable

Optional operationPlanningStatusCode

operationPlanningStatusCode: string

Operation Planning Status Code. Maximum length: 4.

nullable

Optional operationPlanningStatusText

operationPlanningStatusText: string

Short Text for Fixed Values. This text appears when fixed values are displayed in the F4 help. It explains the possible input values. SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains. Maximum length: 60.

nullable

Optional orderFirmingStatusText

orderFirmingStatusText: string

Short Text for Fixed Values. This text appears when fixed values are displayed in the F4 help. It explains the possible input values. SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains. Maximum length: 60.

nullable

orderId

orderId: string

Order Id. Maximum length: 12.

Optional orderInternalId

orderInternalId: string

Order Internal ID. Maximum length: 10.

nullable

Optional orderPlannedTotalQty

orderPlannedTotalQty: BigNumber

Order Planned Total Qty.

nullable

Optional orderStatusCode

orderStatusCode: string

Order Status Code. Maximum length: 5.

nullable

Optional orderStatusText

orderStatusText: string

Object status. Key with informs you of the current status of an object. A status can either be activated internally (system status) or externally (user status) for information and control purposes. Maximum length: 30.

nullable

Optional orderType

orderType: string

Order Type. Maximum length: 4.

nullable

Optional orderTypeName

orderTypeName: string

Planned Order Type Name. Maximum length: 60.

nullable

plant

plant: string

Plant. Maximum length: 4.

Optional productionVersion

productionVersion: string

Production Version. Key which determines the various production techniques according to which a material can be manufactured. The production version determines the following:the BOM alternative for a BOM explosionthe task list type, the task list group and the task list group counter for allocation to task listslot-size restrictions for repetitive manufacturing. Maximum length: 4.

nullable

Optional remainingCapReqOpSegProcgDurn

remainingCapReqOpSegProcgDurn: BigNumber

Remaining Cap Req Op Seg Procg Durn.

nullable

Optional remainingCapReqOpSegSetupDurn

remainingCapReqOpSegSetupDurn: BigNumber

Remaining Cap Req Op Seg Setup Durn.

nullable

Optional remainingCapReqOpSegTrdwnDurn

remainingCapReqOpSegTrdwnDurn: BigNumber

Remaining Cap Req Op Seg Trdwn Durn.

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

workCenter

workCenter: string

Work Center. Maximum length: 8.

Optional workCenterCategoryCode

workCenterCategoryCode: string

Work Center Category. Key which distinguishes the work centers by their category (for example, production work center, maintenance work center). The work center category determines which data can be maintained in the master record for the work center. Maximum length: 4.

nullable

Optional workCenterDesc

workCenterDesc: string

Work Center Text. Maximum length: 40.

nullable

Optional workCenterInternalId

workCenterInternalId: string

Object ID of the resource. This internally used number and the object type identify the operating resource (for example, the work center or production resource/tool). The number is only used internally but the system displays it within matchcode selection for technical reasons. You do not have to make an entry. Maximum length: 8.

nullable

Optional workCenterResponsible

workCenterResponsible: string

Person Responsible for the Work Center. The person or group of people who are responsible for the maintenance of the work center master files. Maximum length: 3.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<WorkCenterCapDayOp> = new StringField('BaseUnit', WorkCenterCapDayOp, '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 CAPACITY_INTERNAL_ID

CAPACITY_INTERNAL_ID: StringField<WorkCenterCapDayOp> = new StringField('CapacityInternalID', WorkCenterCapDayOp, 'Edm.String')

Static representation of the capacityInternalId 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<WorkCenterCapDayOp> = new StringField('CapacityRequirement', WorkCenterCapDayOp, '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_REQUIREMENTS_ARE_DTMND

CAPACITY_REQUIREMENTS_ARE_DTMND: BigNumberField<WorkCenterCapDayOp> = new BigNumberField('CapacityRequirementsAreDtmnd', WorkCenterCapDayOp, 'Edm.Decimal')

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

Static CAPACITY_REQUIREMENT_ORIGIN

CAPACITY_REQUIREMENT_ORIGIN: StringField<WorkCenterCapDayOp> = new StringField('CapacityRequirementOrigin', WorkCenterCapDayOp, 'Edm.String')

Static representation of the capacityRequirementOrigin 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<WorkCenterCapDayOp> = new StringField('CapacityRequirementUnit', WorkCenterCapDayOp, '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 MATERIAL

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

MRP_CONTROLLER: StringField<WorkCenterCapDayOp> = new StringField('MRPController', WorkCenterCapDayOp, '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 OPERATION

OPERATION: StringField<WorkCenterCapDayOp> = new StringField('Operation', WorkCenterCapDayOp, '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_LATEST_END_DATE

OPERATION_LATEST_END_DATE: StringField<WorkCenterCapDayOp> = new StringField('OperationLatestEndDate', WorkCenterCapDayOp, 'Edm.String')

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: StringField<WorkCenterCapDayOp> = new StringField('OperationLatestEndTime', WorkCenterCapDayOp, 'Edm.String')

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: StringField<WorkCenterCapDayOp> = new StringField('OperationLatestStartDate', WorkCenterCapDayOp, 'Edm.String')

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: StringField<WorkCenterCapDayOp> = new StringField('OperationLatestStartTime', WorkCenterCapDayOp, 'Edm.String')

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_PLANNING_STATUS_CODE

OPERATION_PLANNING_STATUS_CODE: StringField<WorkCenterCapDayOp> = new StringField('OperationPlanningStatusCode', WorkCenterCapDayOp, 'Edm.String')

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

Static OPERATION_PLANNING_STATUS_TEXT

OPERATION_PLANNING_STATUS_TEXT: StringField<WorkCenterCapDayOp> = new StringField('OperationPlanningStatusText', WorkCenterCapDayOp, 'Edm.String')

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

Static OP_LTST_SCHEDLD_PROCG_STRT_DTE

OP_LTST_SCHEDLD_PROCG_STRT_DTE: StringField<WorkCenterCapDayOp> = new StringField('OpLtstSchedldProcgStrtDte', WorkCenterCapDayOp, 'Edm.String')

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

Static OP_LTST_SCHEDLD_PROCG_STRT_TME

OP_LTST_SCHEDLD_PROCG_STRT_TME: StringField<WorkCenterCapDayOp> = new StringField('OpLtstSchedldProcgStrtTme', WorkCenterCapDayOp, 'Edm.String')

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

Static OP_LTST_SCHEDLD_TRDWN_STRT_DTE

OP_LTST_SCHEDLD_TRDWN_STRT_DTE: StringField<WorkCenterCapDayOp> = new StringField('OpLtstSchedldTrdwnStrtDte', WorkCenterCapDayOp, 'Edm.String')

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

Static OP_LTST_SCHEDLD_TRDWN_STRT_TME

OP_LTST_SCHEDLD_TRDWN_STRT_TME: StringField<WorkCenterCapDayOp> = new StringField('OpLtstSchedldTrdwnStrtTme', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_FIRMING_STATUS_TEXT

ORDER_FIRMING_STATUS_TEXT: StringField<WorkCenterCapDayOp> = new StringField('OrderFirmingStatusText', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_ID

ORDER_ID: StringField<WorkCenterCapDayOp> = new StringField('OrderID', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_INTERNAL_ID

ORDER_INTERNAL_ID: StringField<WorkCenterCapDayOp> = new StringField('OrderInternalID', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_PLANNED_TOTAL_QTY

ORDER_PLANNED_TOTAL_QTY: BigNumberField<WorkCenterCapDayOp> = new BigNumberField('OrderPlannedTotalQty', WorkCenterCapDayOp, 'Edm.Decimal')

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

Static ORDER_STATUS_CODE

ORDER_STATUS_CODE: StringField<WorkCenterCapDayOp> = new StringField('OrderStatusCode', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_STATUS_TEXT

ORDER_STATUS_TEXT: StringField<WorkCenterCapDayOp> = new StringField('OrderStatusText', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_TYPE

ORDER_TYPE: StringField<WorkCenterCapDayOp> = new StringField('OrderType', WorkCenterCapDayOp, 'Edm.String')

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

Static ORDER_TYPE_NAME

ORDER_TYPE_NAME: StringField<WorkCenterCapDayOp> = new StringField('OrderTypeName', WorkCenterCapDayOp, 'Edm.String')

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

Static PLANT

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

PRODUCTION_VERSION: StringField<WorkCenterCapDayOp> = new StringField('ProductionVersion', WorkCenterCapDayOp, 'Edm.String')

Static representation of the productionVersion 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: BigNumberField<WorkCenterCapDayOp> = new BigNumberField('RemainingCapReqOpSegProcgDurn', WorkCenterCapDayOp, 'Edm.Decimal')

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: BigNumberField<WorkCenterCapDayOp> = new BigNumberField('RemainingCapReqOpSegSetupDurn', WorkCenterCapDayOp, 'Edm.Decimal')

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: BigNumberField<WorkCenterCapDayOp> = new BigNumberField('RemainingCapReqOpSegTrdwnDurn', WorkCenterCapDayOp, 'Edm.Decimal')

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 WORK_CENTER

WORK_CENTER: StringField<WorkCenterCapDayOp> = new StringField('WorkCenter', WorkCenterCapDayOp, '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 WORK_CENTER_CATEGORY_CODE

WORK_CENTER_CATEGORY_CODE: StringField<WorkCenterCapDayOp> = new StringField('WorkCenterCategoryCode', WorkCenterCapDayOp, 'Edm.String')

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

Static WORK_CENTER_DESC

WORK_CENTER_DESC: StringField<WorkCenterCapDayOp> = new StringField('WorkCenterDesc', WorkCenterCapDayOp, 'Edm.String')

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

Static WORK_CENTER_INTERNAL_ID

WORK_CENTER_INTERNAL_ID: StringField<WorkCenterCapDayOp> = new StringField('WorkCenterInternalID', WorkCenterCapDayOp, 'Edm.String')

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

Static WORK_CENTER_RESPONSIBLE

WORK_CENTER_RESPONSIBLE: StringField<WorkCenterCapDayOp> = new StringField('WorkCenterResponsible', WorkCenterCapDayOp, 'Edm.String')

Static representation of the workCenterResponsible 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<WorkCenterCapDayOp> | BigNumberField<WorkCenterCapDayOp>> = [WorkCenterCapDayOp.PLANT,WorkCenterCapDayOp.MRP_CONTROLLER,WorkCenterCapDayOp.WORK_CENTER,WorkCenterCapDayOp.CAPACITY_INTERNAL_ID,WorkCenterCapDayOp.CAPACITY_REQUIREMENT,WorkCenterCapDayOp.MATERIAL,WorkCenterCapDayOp.ORDER_ID,WorkCenterCapDayOp.OPERATION,WorkCenterCapDayOp.WORK_CENTER_DESC,WorkCenterCapDayOp.WORK_CENTER_RESPONSIBLE,WorkCenterCapDayOp.WORK_CENTER_CATEGORY_CODE,WorkCenterCapDayOp.WORK_CENTER_INTERNAL_ID,WorkCenterCapDayOp.CAPACITY_REQUIREMENT_ORIGIN,WorkCenterCapDayOp.CAPACITY_REQUIREMENT_UNIT,WorkCenterCapDayOp.ORDER_TYPE,WorkCenterCapDayOp.ORDER_TYPE_NAME,WorkCenterCapDayOp.ORDER_PLANNED_TOTAL_QTY,WorkCenterCapDayOp.BASE_UNIT,WorkCenterCapDayOp.PRODUCTION_VERSION,WorkCenterCapDayOp.OPERATION_PLANNING_STATUS_TEXT,WorkCenterCapDayOp.OPERATION_PLANNING_STATUS_CODE,WorkCenterCapDayOp.OPERATION_LATEST_START_DATE,WorkCenterCapDayOp.OPERATION_LATEST_START_TIME,WorkCenterCapDayOp.OPERATION_LATEST_END_DATE,WorkCenterCapDayOp.OPERATION_LATEST_END_TIME,WorkCenterCapDayOp.ORDER_STATUS_TEXT,WorkCenterCapDayOp.ORDER_STATUS_CODE,WorkCenterCapDayOp.ORDER_FIRMING_STATUS_TEXT,WorkCenterCapDayOp.OP_LTST_SCHEDLD_PROCG_STRT_DTE,WorkCenterCapDayOp.OP_LTST_SCHEDLD_PROCG_STRT_TME,WorkCenterCapDayOp.OP_LTST_SCHEDLD_TRDWN_STRT_DTE,WorkCenterCapDayOp.OP_LTST_SCHEDLD_TRDWN_STRT_TME,WorkCenterCapDayOp.REMAINING_CAP_REQ_OP_SEG_SETUP_DURN,WorkCenterCapDayOp.REMAINING_CAP_REQ_OP_SEG_PROCG_DURN,WorkCenterCapDayOp.REMAINING_CAP_REQ_OP_SEG_TRDWN_DURN,WorkCenterCapDayOp.CAPACITY_REQUIREMENTS_ARE_DTMND,WorkCenterCapDayOp.ORDER_INTERNAL_ID]

All fields of the WorkCenterCapDayOp entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCapDayOp"

Technical entity name for WorkCenterCapDayOp.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCapDayOp>> = [WorkCenterCapDayOp.PLANT, WorkCenterCapDayOp.MRP_CONTROLLER, WorkCenterCapDayOp.WORK_CENTER, WorkCenterCapDayOp.CAPACITY_INTERNAL_ID, WorkCenterCapDayOp.CAPACITY_REQUIREMENT, WorkCenterCapDayOp.MATERIAL, WorkCenterCapDayOp.ORDER_ID, WorkCenterCapDayOp.OPERATION]

All key fields of the WorkCenterCapDayOp entity.

Static _keys

_keys: any = WorkCenterCapDayOp._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCapDayOp>

    A builder that constructs instances of entity type WorkCenterCapDayOp.

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>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the WorkCenterCapDayOp entity type.

    Returns WorkCenterCapDayOpRequestBuilder

    A WorkCenterCapDayOp request builder.