Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_WorkCenterCapacityInterval_2" 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
    • WorkCenterCapacityInterval_2

Implements

Index

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional availableCapacityIntervalDurn

availableCapacityIntervalDurn: undefined | string

Duration of an Available Capacity Interval. Maximum length: 2.

nullable

capacityActiveVersion

capacityActiveVersion: string

Available capacity version. The number which identifies the version of available capacity: with which you are workingto which you are referring.Can be used to maintain several versions of available capacity at the same time. Maximum length: 2.

capacityInternalId

capacityInternalId: string

Capacity ID. Maximum length: 8.

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 capacityNumberOfShifts

capacityNumberOfShifts: undefined | string

Number of Shifts in a Day. Maximum number of shifts per day within the interval. Maximum length: 1.

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

intervalEndDate

intervalEndDate: Moment

Valid-to date. End of validity period of an object (such as material, BOM, or routing) in the SAP System.

Optional intervalStartDate

intervalStartDate: Moment

Valid-From Date. Specifies the start date for the validity period of an object (such as material, BOM, or routing).

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 shiftSequence

shiftSequence: undefined | string

Key for the Shift Sequence. You can set the shift sequence for one or more days with this key. The system automatically generates the length of the cycle and the number of shifts using the shift schedule. Maximum length: 4.

nullable

Optional stdAvailableCapacityIsValid

stdAvailableCapacityIsValid: undefined | false | true

Ind.: Standard Available Capacity is Valid for this Interval. Indicator which shows that the available capacity in this interval corresponds to the standard available capacity.

nullable

toCapacityShift

toCapacityShift: WorkCenterCapacityShift_2[]

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

Optional workDayRule

workDayRule: undefined | string

Workday Rule Code. Maximum length: 1.

nullable

Static ALL_FIELDS

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

All fields selector.

Static AVAILABLE_CAPACITY_INTERVAL_DURN

AVAILABLE_CAPACITY_INTERVAL_DURN: StringField<WorkCenterCapacityInterval_2> = new StringField('AvailableCapacityIntervalDurn', WorkCenterCapacityInterval_2, 'Edm.String')

Static representation of the availableCapacityIntervalDurn 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<WorkCenterCapacityInterval_2> = new StringField('CapacityActiveVersion', WorkCenterCapacityInterval_2, '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_INTERNAL_ID

CAPACITY_INTERNAL_ID: StringField<WorkCenterCapacityInterval_2> = new StringField('CapacityInternalID', WorkCenterCapacityInterval_2, '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_LAST_CHANGE_DATE_TIME

CAPACITY_LAST_CHANGE_DATE_TIME: DateField<WorkCenterCapacityInterval_2> = new DateField('CapacityLastChangeDateTime', WorkCenterCapacityInterval_2, '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<WorkCenterCapacityInterval_2> = new NumberField('CapacityNumberOfCapacities', WorkCenterCapacityInterval_2, '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_NUMBER_OF_SHIFTS

CAPACITY_NUMBER_OF_SHIFTS: StringField<WorkCenterCapacityInterval_2> = new StringField('CapacityNumberOfShifts', WorkCenterCapacityInterval_2, 'Edm.String')

Static representation of the capacityNumberOfShifts 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<WorkCenterCapacityInterval_2> = new StringField('CapacityPlanUtilizationPercent', WorkCenterCapacityInterval_2, '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 INTERVAL_END_DATE

INTERVAL_END_DATE: DateField<WorkCenterCapacityInterval_2> = new DateField('IntervalEndDate', WorkCenterCapacityInterval_2, 'Edm.DateTime')

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

Static INTERVAL_START_DATE

INTERVAL_START_DATE: DateField<WorkCenterCapacityInterval_2> = new DateField('IntervalStartDate', WorkCenterCapacityInterval_2, 'Edm.DateTime')

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

Static SHIFT_SEQUENCE

SHIFT_SEQUENCE: StringField<WorkCenterCapacityInterval_2> = new StringField('ShiftSequence', WorkCenterCapacityInterval_2, 'Edm.String')

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

Static STD_AVAILABLE_CAPACITY_IS_VALID

STD_AVAILABLE_CAPACITY_IS_VALID: BooleanField<WorkCenterCapacityInterval_2> = new BooleanField('StdAvailableCapacityIsValid', WorkCenterCapacityInterval_2, 'Edm.Boolean')

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

Static TO_CAPACITY_SHIFT

TO_CAPACITY_SHIFT: Link<WorkCenterCapacityInterval_2, WorkCenterCapacityShift_2> = new Link('to_CapacityShift', WorkCenterCapacityInterval_2, WorkCenterCapacityShift_2)

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

Static WORK_DAY_RULE

WORK_DAY_RULE: StringField<WorkCenterCapacityInterval_2> = new StringField('WorkDayRule', WorkCenterCapacityInterval_2, 'Edm.String')

Static representation of the workDayRule 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<WorkCenterCapacityInterval_2> | DateField<WorkCenterCapacityInterval_2> | BooleanField<WorkCenterCapacityInterval_2> | NumberField<WorkCenterCapacityInterval_2> | Link<WorkCenterCapacityInterval_2, WorkCenterCapacityShift_2>> = [WorkCenterCapacityInterval_2.CAPACITY_INTERNAL_ID,WorkCenterCapacityInterval_2.CAPACITY_ACTIVE_VERSION,WorkCenterCapacityInterval_2.INTERVAL_END_DATE,WorkCenterCapacityInterval_2.INTERVAL_START_DATE,WorkCenterCapacityInterval_2.STD_AVAILABLE_CAPACITY_IS_VALID,WorkCenterCapacityInterval_2.AVAILABLE_CAPACITY_INTERVAL_DURN,WorkCenterCapacityInterval_2.SHIFT_SEQUENCE,WorkCenterCapacityInterval_2.WORK_DAY_RULE,WorkCenterCapacityInterval_2.CAPACITY_NUMBER_OF_SHIFTS,WorkCenterCapacityInterval_2.CAPACITY_NUMBER_OF_CAPACITIES,WorkCenterCapacityInterval_2.CAPACITY_PLAN_UTILIZATION_PERCENT,WorkCenterCapacityInterval_2.CAPACITY_LAST_CHANGE_DATE_TIME,WorkCenterCapacityInterval_2.TO_CAPACITY_SHIFT]

All fields of the WorkCenterCapacityInterval_2 entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCapacityInterval_2"

Technical entity name for WorkCenterCapacityInterval_2.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCapacityInterval_2>> = [WorkCenterCapacityInterval_2.CAPACITY_INTERNAL_ID, WorkCenterCapacityInterval_2.CAPACITY_ACTIVE_VERSION, WorkCenterCapacityInterval_2.INTERVAL_END_DATE]

All key fields of the WorkCenterCapacityInterval_2 entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCapacityInterval_2>

    A builder that constructs instances of entity type WorkCenterCapacityInterval_2.

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

    Returns WorkCenterCapacityInterval_2RequestBuilder

    A WorkCenterCapacityInterval_2 request builder.