Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_WorkCenterCapacityShift" 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
    • WorkCenterCapacityShift

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 "*".

availableCapacityShift

availableCapacityShift: string

Available Capacity Shift. Maximum length: 1.

capacityActiveVersion

capacityActiveVersion: string

Capacity Active Version. Maximum length: 2.

Optional capacityBreakDuration

capacityBreakDuration: number

Capacity Break Duration.

nullable

capacityCategoryAllocation

capacityCategoryAllocation: string

Capacity allocation number. The number along with the capacity category which identifies the capacity in the work center. By using these capacity numbers, you can allocate several capacities with the same category to one work center. Maximum length: 4.

capacityInternalId

capacityInternalId: string

Capacity ID. Maximum length: 8.

Optional capacityNumberOfCapacities

capacityNumberOfCapacities: number

Capacity Number Of Capacities.

nullable

Optional capacityPlanUtilizationPercent

capacityPlanUtilizationPercent: string

Capacity Plan Utilization Percent. Maximum length: 3.

nullable

intervalEndDate

intervalEndDate: Moment

Interval End Date.

Optional intervalStartDate

intervalStartDate: Moment

Interval Start Date.

nullable

Optional plant

plant: string

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

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional shiftDefValidityEnd

shiftDefValidityEnd: Moment

Shift Def Validity End.

nullable

Optional shiftDefValidityStart

shiftDefValidityStart: Moment

Shift Def Validity Start.

nullable

Optional shiftEndTime

shiftEndTime: Time

Shift End Time.

nullable

Optional shiftName

shiftName: string

Shift Name. Maximum length: 4.

nullable

Optional shiftStartTime

shiftStartTime: Time

Shift Start Time.

nullable

Optional totOperatingDurationInHours

totOperatingDurationInHours: BigNumber

Decimal 17_3.

nullable

Optional totOperationDurationUnit

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

The ETag version identifier of the retrieved entity, returns undefined if not retrieved

weekDay

weekDay: string

Week Day. Maximum length: 1.

Optional workCenter

workCenter: string

Work Center. Maximum length: 8.

nullable

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.

workCenterTypeCode

workCenterTypeCode: string

Object types of the CIM resource. Internally used key which identifies the type of operating resource. For example, the following indicators represent: A - a work centerFH - a production resource/tool.The key is only used internally but it is displayed within matchcode selection on technical grounds. You do not have to make an entry. Maximum length: 2.

Static ALL_FIELDS

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

All fields selector.

Static AVAILABLE_CAPACITY_SHIFT

AVAILABLE_CAPACITY_SHIFT: StringField<WorkCenterCapacityShift> = new StringField('AvailableCapacityShift', WorkCenterCapacityShift, 'Edm.String')

Static representation of the availableCapacityShift 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<WorkCenterCapacityShift> = new StringField('CapacityActiveVersion', WorkCenterCapacityShift, '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_BREAK_DURATION

CAPACITY_BREAK_DURATION: NumberField<WorkCenterCapacityShift> = new NumberField('CapacityBreakDuration', WorkCenterCapacityShift, '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_ALLOCATION

CAPACITY_CATEGORY_ALLOCATION: StringField<WorkCenterCapacityShift> = new StringField('CapacityCategoryAllocation', WorkCenterCapacityShift, 'Edm.String')

Static representation of the capacityCategoryAllocation 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<WorkCenterCapacityShift> = new StringField('CapacityInternalID', WorkCenterCapacityShift, '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_NUMBER_OF_CAPACITIES

CAPACITY_NUMBER_OF_CAPACITIES: NumberField<WorkCenterCapacityShift> = new NumberField('CapacityNumberOfCapacities', WorkCenterCapacityShift, '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<WorkCenterCapacityShift> = new StringField('CapacityPlanUtilizationPercent', WorkCenterCapacityShift, '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<WorkCenterCapacityShift> = new DateField('IntervalEndDate', WorkCenterCapacityShift, '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<WorkCenterCapacityShift> = new DateField('IntervalStartDate', WorkCenterCapacityShift, '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 PLANT

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

SHIFT_DEF_VALIDITY_END: DateField<WorkCenterCapacityShift> = new DateField('ShiftDefValidityEnd', WorkCenterCapacityShift, 'Edm.DateTime')

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

Static SHIFT_DEF_VALIDITY_START

SHIFT_DEF_VALIDITY_START: DateField<WorkCenterCapacityShift> = new DateField('ShiftDefValidityStart', WorkCenterCapacityShift, 'Edm.DateTime')

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

Static SHIFT_END_TIME

SHIFT_END_TIME: TimeField<WorkCenterCapacityShift> = new TimeField('ShiftEndTime', WorkCenterCapacityShift, 'Edm.Time')

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

Static SHIFT_NAME

SHIFT_NAME: StringField<WorkCenterCapacityShift> = new StringField('ShiftName', WorkCenterCapacityShift, 'Edm.String')

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

Static SHIFT_START_TIME

SHIFT_START_TIME: TimeField<WorkCenterCapacityShift> = new TimeField('ShiftStartTime', WorkCenterCapacityShift, 'Edm.Time')

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

Static TOT_OPERATING_DURATION_IN_HOURS

TOT_OPERATING_DURATION_IN_HOURS: BigNumberField<WorkCenterCapacityShift> = new BigNumberField('TotOperatingDurationInHours', WorkCenterCapacityShift, 'Edm.Decimal')

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

Static TOT_OPERATION_DURATION_UNIT

TOT_OPERATION_DURATION_UNIT: StringField<WorkCenterCapacityShift> = new StringField('TotOperationDurationUnit', WorkCenterCapacityShift, 'Edm.String')

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

Static WEEK_DAY

WEEK_DAY: StringField<WorkCenterCapacityShift> = new StringField('WeekDay', WorkCenterCapacityShift, 'Edm.String')

Static representation of the weekDay 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<WorkCenterCapacityShift> = new StringField('WorkCenter', WorkCenterCapacityShift, '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_INTERNAL_ID

WORK_CENTER_INTERNAL_ID: StringField<WorkCenterCapacityShift> = new StringField('WorkCenterInternalID', WorkCenterCapacityShift, '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_TYPE_CODE

WORK_CENTER_TYPE_CODE: StringField<WorkCenterCapacityShift> = new StringField('WorkCenterTypeCode', WorkCenterCapacityShift, 'Edm.String')

Static representation of the workCenterTypeCode 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<WorkCenterCapacityShift> | DateField<WorkCenterCapacityShift> | TimeField<WorkCenterCapacityShift> | NumberField<WorkCenterCapacityShift> | BigNumberField<WorkCenterCapacityShift>> = [WorkCenterCapacityShift.WORK_CENTER_INTERNAL_ID,WorkCenterCapacityShift.WORK_CENTER_TYPE_CODE,WorkCenterCapacityShift.CAPACITY_CATEGORY_ALLOCATION,WorkCenterCapacityShift.CAPACITY_INTERNAL_ID,WorkCenterCapacityShift.CAPACITY_ACTIVE_VERSION,WorkCenterCapacityShift.INTERVAL_END_DATE,WorkCenterCapacityShift.WEEK_DAY,WorkCenterCapacityShift.AVAILABLE_CAPACITY_SHIFT,WorkCenterCapacityShift.WORK_CENTER,WorkCenterCapacityShift.PLANT,WorkCenterCapacityShift.INTERVAL_START_DATE,WorkCenterCapacityShift.SHIFT_NAME,WorkCenterCapacityShift.SHIFT_DEF_VALIDITY_START,WorkCenterCapacityShift.SHIFT_DEF_VALIDITY_END,WorkCenterCapacityShift.SHIFT_START_TIME,WorkCenterCapacityShift.SHIFT_END_TIME,WorkCenterCapacityShift.CAPACITY_BREAK_DURATION,WorkCenterCapacityShift.CAPACITY_PLAN_UTILIZATION_PERCENT,WorkCenterCapacityShift.CAPACITY_NUMBER_OF_CAPACITIES,WorkCenterCapacityShift.TOT_OPERATING_DURATION_IN_HOURS,WorkCenterCapacityShift.TOT_OPERATION_DURATION_UNIT]

All fields of the WorkCenterCapacityShift entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCapacityShift"

Technical entity name for WorkCenterCapacityShift.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCapacityShift>> = [WorkCenterCapacityShift.WORK_CENTER_INTERNAL_ID, WorkCenterCapacityShift.WORK_CENTER_TYPE_CODE, WorkCenterCapacityShift.CAPACITY_CATEGORY_ALLOCATION, WorkCenterCapacityShift.CAPACITY_INTERNAL_ID, WorkCenterCapacityShift.CAPACITY_ACTIVE_VERSION, WorkCenterCapacityShift.INTERVAL_END_DATE, WorkCenterCapacityShift.WEEK_DAY, WorkCenterCapacityShift.AVAILABLE_CAPACITY_SHIFT]

All key fields of the WorkCenterCapacityShift entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCapacityShift>

    A builder that constructs instances of entity type WorkCenterCapacityShift.

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

    Returns WorkCenterCapacityShiftRequestBuilder

    A WorkCenterCapacityShift request builder.