Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_WorkCenterCapacity" 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
    • WorkCenterCapacity

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns WorkCenterCapacity

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 authorizationGroup

authorizationGroup: undefined | string

Authorization Group. The authorization group allows extended authorization protection for particular objects. The authorization groups are freely definable. The authorization groups usually occur in authorization objects together with an activity. Maximum length: 4.

nullable

Optional capIsUsedInMultiOperations

capIsUsedInMultiOperations: undefined | false | true

Indicator: Several Operations Can Use Capacity.

nullable

Optional capOverloadThresholdInPercent

capOverloadThresholdInPercent: undefined | string

Overload. Entry you use to control the percentage by which the load may exceed available capacity. Overload is used in finite scheduling. You can use it to specify, for example, that work continues during a break if capacity requirements are not covered by the available capacity.If you have entered a percentage for the overload, it is also taken into account in the availability check for capacity. For example, if there is an overload of 10%, work centers with a capacity load of more than 110% are overloaded. Maximum length: 3.

nullable

Optional capacity

capacity: undefined | string

Capacity name. Description by which the capacity (for example, a machine capacity, a labor capacity or a move capacity) is to be created in the system (when creating the capacity) oris known in the system (when changing, displaying or using the capacity). Maximum length: 8.

nullable

Optional capacityActiveVersion

capacityActiveVersion: undefined | string

Active Version of Available Capacity. With this number you can identify the active version of available capacity. The active version is always the capacity in the screen with header dataThe different versions allow you to maintain several available capacities at the same time. The active version of available capacity is used as a basis for scheduling. Maximum length: 2.

nullable

Optional capacityBaseQtyUnit

capacityBaseQtyUnit: undefined | string

Capacity Base Unit of Measure. Unit in which available capacity is maintained. A typical unit is "hours". Maximum length: 3.

nullable

Optional capacityBreakDuration

capacityBreakDuration: undefined | number

Cumulative Break Duration in Seconds (internal).

nullable

Optional capacityCategoryCode

capacityCategoryCode: undefined | string

Capacity Category. Maximum length: 3.

nullable

Optional capacityEndTime

capacityEndTime: undefined | number

End Time in Seconds (internal).

nullable

Optional capacityHasIndivCapacities

capacityHasIndivCapacities: undefined | false | true

Has Individual Capacities.

nullable

capacityInternalId

capacityInternalId: string

Capacity ID. Maximum length: 8.

Optional capacityIsExcldFrmLongTermPlng

capacityIsExcldFrmLongTermPlng: undefined | false | true

Indicator: Capacity Excluded From Long-Term Planning. Indicator used to specify that this capacity is not taken into account in long term planning. The aim of long term planning is to determine the requirements and available capacity for the assemblies and raw materials on the basis of a planned demand program.

nullable

Optional capacityIsFinite

capacityIsFinite: undefined | false | true

Indicator: Capacity Relevant to Finite Scheduling. You use this indicator to specify that the system should take the available capacity and the load of this capacity into account during finite scheduling. Only those capacities for which the indicator finite scheduling is set are taken into account in the capacity availability check.

nullable

Optional capacityIsPooled

capacityIsPooled: undefined | false | true

Pooled Capacity Indicator. Allows capacity to be allocated to several work centers. For example, move capacity (for moving parts and materials) could be called upon by several work centers.

nullable

Optional capacityLastChangeDateTime

capacityLastChangeDateTime: Moment

Capacity Last Change Date Time.

nullable

Optional capacityNumberOfCapacities

capacityNumberOfCapacities: undefined | number

Number of Individual Capacities. Number of elements which make up a capacity group. For example, a group made up of 5 machines has 5 elements.

nullable

Optional capacityPlanUtilizationPercent

capacityPlanUtilizationPercent: undefined | string

Capacity Utilization Ratio in Percent. The relationship (expressed in percent) between a machine´s actual capacity and it´s theoretical capacity. Enter the average capacity utilization rate of all machines providing that capacity during the shift.The capacity utilization rate, the number of individual capacities and the operating time per shift make up the total capacity for the shift generated by the system. Maximum length: 3.

nullable

Optional capacityQuantityUnit

capacityQuantityUnit: undefined | string

Capacity Unit of Measure. Unit of measure in which available capacity is to be displayed. The unit of measure may have a different dimension than the base unit of measure. In this case, you must maintain the conversion for the unit of measure to the base unit of measure by selecting the menu options "Extras -> Units of measure" on the header data screen. Maximum length: 3.

nullable

Optional capacityResponsiblePlanner

capacityResponsiblePlanner: undefined | string

Capacity Responsible Planner Group. Key referring to the capacity planner group, which is responsible for planning this capacity. Maximum length: 3.

nullable

Optional capacityStartTime

capacityStartTime: undefined | number

Start time in seconds (internal).

nullable

Optional factoryCalendar

factoryCalendar: undefined | string

Factory Calendar ID. Two-place ID to identify the factory calendar. If you have not entered your own calendar, then the system uses the factory calendar for the plant. Maximum length: 2.

nullable

Optional plant

plant: undefined | string

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

nullable

Optional referencedCapacityInternalId

referencedCapacityInternalId: undefined | string

Referenced Capacity ID. Maximum length: 8.

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 shiftGroup

shiftGroup: undefined | string

Grouping for Shift Definitions and Shift Sequences. Number identifying a grouping. You can choose a number between 01 and 99. You can use a grouping to create shift sequences and shift definitions for special areas (for example, different plants or different areas of a plant) and select them when maintaining the available capacities of work centers.If you have entered a grouping, the system offers you only the shift sequences and shift definitions that you have created in Customizing for this grouping for you to maintain the available capacity.If you have not entered a grouping, the system offers the shift sequences and shift definitions maintained for grouping "0". Maximum length: 2.

nullable

toCapacityInterval

toCapacityInterval: WorkCenterCapacityInterval_2[]

One-to-many navigation property to the WorkCenterCapacityInterval_2 entity.

toCapacityText

toCapacityText: WorkCenterCapacityText[]

One-to-many navigation property to the WorkCenterCapacityText entity.

Static ALL_FIELDS

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

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<WorkCenterCapacity> = new StringField('AuthorizationGroup', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY

CAPACITY: StringField<WorkCenterCapacity> = new StringField('Capacity', WorkCenterCapacity, '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_ACTIVE_VERSION

CAPACITY_ACTIVE_VERSION: StringField<WorkCenterCapacity> = new StringField('CapacityActiveVersion', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY_BASE_QTY_UNIT

CAPACITY_BASE_QTY_UNIT: StringField<WorkCenterCapacity> = new StringField('CapacityBaseQtyUnit', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY_BREAK_DURATION

CAPACITY_BREAK_DURATION: NumberField<WorkCenterCapacity> = new NumberField('CapacityBreakDuration', WorkCenterCapacity, 'Edm.Int32')

Static representation of the capacityBreakDuration 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<WorkCenterCapacity> = new StringField('CapacityCategoryCode', WorkCenterCapacity, '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_END_TIME

CAPACITY_END_TIME: NumberField<WorkCenterCapacity> = new NumberField('CapacityEndTime', WorkCenterCapacity, 'Edm.Int32')

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

Static CAPACITY_HAS_INDIV_CAPACITIES

CAPACITY_HAS_INDIV_CAPACITIES: BooleanField<WorkCenterCapacity> = new BooleanField('CapacityHasIndivCapacities', WorkCenterCapacity, 'Edm.Boolean')

Static representation of the capacityHasIndivCapacities 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<WorkCenterCapacity> = new StringField('CapacityInternalID', WorkCenterCapacity, '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_IS_EXCLD_FRM_LONG_TERM_PLNG

CAPACITY_IS_EXCLD_FRM_LONG_TERM_PLNG: BooleanField<WorkCenterCapacity> = new BooleanField('CapacityIsExcldFrmLongTermPlng', WorkCenterCapacity, 'Edm.Boolean')

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

Static CAPACITY_IS_FINITE

CAPACITY_IS_FINITE: BooleanField<WorkCenterCapacity> = new BooleanField('CapacityIsFinite', WorkCenterCapacity, 'Edm.Boolean')

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

Static CAPACITY_IS_POOLED

CAPACITY_IS_POOLED: BooleanField<WorkCenterCapacity> = new BooleanField('CapacityIsPooled', WorkCenterCapacity, 'Edm.Boolean')

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

Static CAPACITY_LAST_CHANGE_DATE_TIME

CAPACITY_LAST_CHANGE_DATE_TIME: DateField<WorkCenterCapacity> = new DateField('CapacityLastChangeDateTime', WorkCenterCapacity, 'Edm.DateTimeOffset')

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

Static CAPACITY_NUMBER_OF_CAPACITIES

CAPACITY_NUMBER_OF_CAPACITIES: NumberField<WorkCenterCapacity> = new NumberField('CapacityNumberOfCapacities', WorkCenterCapacity, 'Edm.Int16')

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

Static CAPACITY_PLAN_UTILIZATION_PERCENT

CAPACITY_PLAN_UTILIZATION_PERCENT: StringField<WorkCenterCapacity> = new StringField('CapacityPlanUtilizationPercent', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY_QUANTITY_UNIT

CAPACITY_QUANTITY_UNIT: StringField<WorkCenterCapacity> = new StringField('CapacityQuantityUnit', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY_RESPONSIBLE_PLANNER

CAPACITY_RESPONSIBLE_PLANNER: StringField<WorkCenterCapacity> = new StringField('CapacityResponsiblePlanner', WorkCenterCapacity, 'Edm.String')

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

Static CAPACITY_START_TIME

CAPACITY_START_TIME: NumberField<WorkCenterCapacity> = new NumberField('CapacityStartTime', WorkCenterCapacity, 'Edm.Int32')

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

Static CAP_IS_USED_IN_MULTI_OPERATIONS

CAP_IS_USED_IN_MULTI_OPERATIONS: BooleanField<WorkCenterCapacity> = new BooleanField('CapIsUsedInMultiOperations', WorkCenterCapacity, 'Edm.Boolean')

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

Static CAP_OVERLOAD_THRESHOLD_IN_PERCENT

CAP_OVERLOAD_THRESHOLD_IN_PERCENT: StringField<WorkCenterCapacity> = new StringField('CapOverloadThresholdInPercent', WorkCenterCapacity, 'Edm.String')

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

Static FACTORY_CALENDAR

FACTORY_CALENDAR: StringField<WorkCenterCapacity> = new StringField('FactoryCalendar', WorkCenterCapacity, 'Edm.String')

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

Static PLANT

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

REFERENCED_CAPACITY_INTERNAL_ID: StringField<WorkCenterCapacity> = new StringField('ReferencedCapacityInternalID', WorkCenterCapacity, 'Edm.String')

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

Static SHIFT_GROUP

SHIFT_GROUP: StringField<WorkCenterCapacity> = new StringField('ShiftGroup', WorkCenterCapacity, 'Edm.String')

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

Static TO_CAPACITY_INTERVAL

TO_CAPACITY_INTERVAL: Link<WorkCenterCapacity, WorkCenterCapacityInterval_2> = new Link('to_CapacityInterval', WorkCenterCapacity, WorkCenterCapacityInterval_2)

Static representation of the one-to-many navigation property toCapacityInterval for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_CAPACITY_TEXT

TO_CAPACITY_TEXT: Link<WorkCenterCapacity, WorkCenterCapacityText> = new Link('to_CapacityText', WorkCenterCapacity, WorkCenterCapacityText)

Static representation of the one-to-many navigation property toCapacityText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<WorkCenterCapacity> | BooleanField<WorkCenterCapacity> | NumberField<WorkCenterCapacity> | DateField<WorkCenterCapacity> | Link<WorkCenterCapacity, WorkCenterCapacityInterval_2> | Link<WorkCenterCapacity, WorkCenterCapacityText>> = [WorkCenterCapacity.CAPACITY_INTERNAL_ID,WorkCenterCapacity.CAPACITY,WorkCenterCapacity.CAPACITY_CATEGORY_CODE,WorkCenterCapacity.CAPACITY_ACTIVE_VERSION,WorkCenterCapacity.CAPACITY_IS_FINITE,WorkCenterCapacity.CAPACITY_IS_POOLED,WorkCenterCapacity.CAPACITY_HAS_INDIV_CAPACITIES,WorkCenterCapacity.CAPACITY_IS_EXCLD_FRM_LONG_TERM_PLNG,WorkCenterCapacity.CAPACITY_NUMBER_OF_CAPACITIES,WorkCenterCapacity.CAPACITY_RESPONSIBLE_PLANNER,WorkCenterCapacity.CAPACITY_PLAN_UTILIZATION_PERCENT,WorkCenterCapacity.CAPACITY_BREAK_DURATION,WorkCenterCapacity.PLANT,WorkCenterCapacity.FACTORY_CALENDAR,WorkCenterCapacity.AUTHORIZATION_GROUP,WorkCenterCapacity.SHIFT_GROUP,WorkCenterCapacity.CAPACITY_START_TIME,WorkCenterCapacity.CAPACITY_END_TIME,WorkCenterCapacity.CAP_IS_USED_IN_MULTI_OPERATIONS,WorkCenterCapacity.REFERENCED_CAPACITY_INTERNAL_ID,WorkCenterCapacity.CAP_OVERLOAD_THRESHOLD_IN_PERCENT,WorkCenterCapacity.CAPACITY_QUANTITY_UNIT,WorkCenterCapacity.CAPACITY_BASE_QTY_UNIT,WorkCenterCapacity.CAPACITY_LAST_CHANGE_DATE_TIME,WorkCenterCapacity.TO_CAPACITY_INTERVAL,WorkCenterCapacity.TO_CAPACITY_TEXT]

All fields of the WorkCenterCapacity entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCapacity"

Technical entity name for WorkCenterCapacity.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCapacity>> = [WorkCenterCapacity.CAPACITY_INTERNAL_ID]

All key fields of the WorkCenterCapacity entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCapacity>

    A builder that constructs instances of entity type WorkCenterCapacity.

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

    Returns WorkCenterCapacityRequestBuilder

    A WorkCenterCapacity request builder.