Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_WorkCenterCapPerBucketSet" 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
    • WorkCenterCapPerBucketSet

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

capEvalBucketType

capEvalBucketType: string

Cap Eval Bucket Type. Maximum length: 1.

Optional capacityEndTime

capacityEndTime: undefined | number

Capacity End Time.

nullable

Optional capacityEvaluationTimePerdText

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

capacityEvaluationTimePeriod

capacityEvaluationTimePeriod: string

Capacity Evaluation Time Period. Maximum length: 10.

capacityInternalId

capacityInternalId: string

Capacity Internal Id. Maximum length: 8.

Optional capacityStartTime

capacityStartTime: undefined | number

Capacity Start Time.

nullable

pCapEvalBucketType

pCapEvalBucketType: string

Single-Character Flag. Maximum length: 1.

pCapEvalEndDate

pCapEvalEndDate: Moment

Date. Date (YYYYMMDD) Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301.

pCapEvalStartDate

pCapEvalStartDate: Moment

Date. Date (YYYYMMDD) Date in the form YYYYMMDD (where Y = year, M = month, D = day)19920301.

parameters

One-to-one navigation property to the WorkCenterCapPerBucket entity.

plant

plant: string

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

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

shiftName

shiftName: string

Shift Name. Maximum length: 4.

workCenter

workCenter: string

Work Center. Key identifying the work center. Maximum length: 8.

Optional workCenterAvailableCapacity

workCenterAvailableCapacity: BigNumber

Work Center Available Capacity.

nullable

Optional workCenterCapRqmtInCapUnit

workCenterCapRqmtInCapUnit: BigNumber

Work Center Cap Rqmt In Cap Unit.

nullable

Optional workCenterCapUnitText

workCenterCapUnitText: undefined | string

Unit of Measurement Text (Maximum 10 Characters). Unit of measure name. Maximum length: 10.

nullable

Optional workCenterCapacityUnit

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

Optional workCenterInternalId

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

Optional workCenterTotUtilznInTmePerd

workCenterTotUtilznInTmePerd: undefined | number

Work Center Tot Utilzn In Tme Perd.

nullable

Optional wrkCtrRmngCapInCapUnit

wrkCtrRmngCapInCapUnit: BigNumber

Wrk Ctr Rmng Cap In Cap Unit.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CAPACITY_END_TIME

CAPACITY_END_TIME: NumberField<WorkCenterCapPerBucketSet> = new NumberField('CapacityEndTime', WorkCenterCapPerBucketSet, '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_EVALUATION_TIME_PERD_TEXT

CAPACITY_EVALUATION_TIME_PERD_TEXT: StringField<WorkCenterCapPerBucketSet> = new StringField('CapacityEvaluationTimePerdText', WorkCenterCapPerBucketSet, 'Edm.String')

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

Static CAPACITY_EVALUATION_TIME_PERIOD

CAPACITY_EVALUATION_TIME_PERIOD: StringField<WorkCenterCapPerBucketSet> = new StringField('CapacityEvaluationTimePeriod', WorkCenterCapPerBucketSet, 'Edm.String')

Static representation of the capacityEvaluationTimePeriod 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<WorkCenterCapPerBucketSet> = new StringField('CapacityInternalID', WorkCenterCapPerBucketSet, '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_START_TIME

CAPACITY_START_TIME: NumberField<WorkCenterCapPerBucketSet> = new NumberField('CapacityStartTime', WorkCenterCapPerBucketSet, '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_EVAL_BUCKET_TYPE

CAP_EVAL_BUCKET_TYPE: StringField<WorkCenterCapPerBucketSet> = new StringField('CapEvalBucketType', WorkCenterCapPerBucketSet, 'Edm.String')

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

Static PARAMETERS

PARAMETERS: OneToOneLink<WorkCenterCapPerBucketSet, WorkCenterCapPerBucket> = new OneToOneLink('Parameters', WorkCenterCapPerBucketSet, WorkCenterCapPerBucket)

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

Static PLANT

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

P_CAP_EVAL_BUCKET_TYPE: StringField<WorkCenterCapPerBucketSet> = new StringField('P_CapEvalBucketType', WorkCenterCapPerBucketSet, 'Edm.String')

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

Static P_CAP_EVAL_END_DATE

P_CAP_EVAL_END_DATE: DateField<WorkCenterCapPerBucketSet> = new DateField('P_CapEvalEndDate', WorkCenterCapPerBucketSet, 'Edm.DateTime')

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

Static P_CAP_EVAL_START_DATE

P_CAP_EVAL_START_DATE: DateField<WorkCenterCapPerBucketSet> = new DateField('P_CapEvalStartDate', WorkCenterCapPerBucketSet, 'Edm.DateTime')

Static representation of the pCapEvalStartDate 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<WorkCenterCapPerBucketSet> = new StringField('ShiftName', WorkCenterCapPerBucketSet, '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 WORK_CENTER

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

WORK_CENTER_AVAILABLE_CAPACITY: BigNumberField<WorkCenterCapPerBucketSet> = new BigNumberField('WorkCenterAvailableCapacity', WorkCenterCapPerBucketSet, 'Edm.Decimal')

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

Static WORK_CENTER_CAPACITY_UNIT

WORK_CENTER_CAPACITY_UNIT: StringField<WorkCenterCapPerBucketSet> = new StringField('WorkCenterCapacityUnit', WorkCenterCapPerBucketSet, 'Edm.String')

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

Static WORK_CENTER_CAP_RQMT_IN_CAP_UNIT

WORK_CENTER_CAP_RQMT_IN_CAP_UNIT: BigNumberField<WorkCenterCapPerBucketSet> = new BigNumberField('WorkCenterCapRqmtInCapUnit', WorkCenterCapPerBucketSet, 'Edm.Decimal')

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

Static WORK_CENTER_CAP_UNIT_TEXT

WORK_CENTER_CAP_UNIT_TEXT: StringField<WorkCenterCapPerBucketSet> = new StringField('WorkCenterCapUnitText', WorkCenterCapPerBucketSet, 'Edm.String')

Static representation of the workCenterCapUnitText 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<WorkCenterCapPerBucketSet> = new StringField('WorkCenterInternalID', WorkCenterCapPerBucketSet, '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<WorkCenterCapPerBucketSet> = new StringField('WorkCenterResponsible', WorkCenterCapPerBucketSet, '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 WORK_CENTER_TOT_UTILZN_IN_TME_PERD

WORK_CENTER_TOT_UTILZN_IN_TME_PERD: NumberField<WorkCenterCapPerBucketSet> = new NumberField('WorkCenterTotUtilznInTmePerd', WorkCenterCapPerBucketSet, 'Edm.Double')

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

Static WRK_CTR_RMNG_CAP_IN_CAP_UNIT

WRK_CTR_RMNG_CAP_IN_CAP_UNIT: BigNumberField<WorkCenterCapPerBucketSet> = new BigNumberField('WrkCtrRmngCapInCapUnit', WorkCenterCapPerBucketSet, 'Edm.Decimal')

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

Static _allFields

_allFields: Array<DateField<WorkCenterCapPerBucketSet> | StringField<WorkCenterCapPerBucketSet> | NumberField<WorkCenterCapPerBucketSet> | BigNumberField<WorkCenterCapPerBucketSet> | OneToOneLink<WorkCenterCapPerBucketSet, WorkCenterCapPerBucket>> = [WorkCenterCapPerBucketSet.P_CAP_EVAL_START_DATE,WorkCenterCapPerBucketSet.P_CAP_EVAL_END_DATE,WorkCenterCapPerBucketSet.P_CAP_EVAL_BUCKET_TYPE,WorkCenterCapPerBucketSet.PLANT,WorkCenterCapPerBucketSet.WORK_CENTER,WorkCenterCapPerBucketSet.CAPACITY_INTERNAL_ID,WorkCenterCapPerBucketSet.SHIFT_NAME,WorkCenterCapPerBucketSet.CAPACITY_EVALUATION_TIME_PERIOD,WorkCenterCapPerBucketSet.CAP_EVAL_BUCKET_TYPE,WorkCenterCapPerBucketSet.CAPACITY_EVALUATION_TIME_PERD_TEXT,WorkCenterCapPerBucketSet.WORK_CENTER_INTERNAL_ID,WorkCenterCapPerBucketSet.WORK_CENTER_RESPONSIBLE,WorkCenterCapPerBucketSet.CAPACITY_START_TIME,WorkCenterCapPerBucketSet.CAPACITY_END_TIME,WorkCenterCapPerBucketSet.WORK_CENTER_AVAILABLE_CAPACITY,WorkCenterCapPerBucketSet.WORK_CENTER_CAP_RQMT_IN_CAP_UNIT,WorkCenterCapPerBucketSet.WRK_CTR_RMNG_CAP_IN_CAP_UNIT,WorkCenterCapPerBucketSet.WORK_CENTER_TOT_UTILZN_IN_TME_PERD,WorkCenterCapPerBucketSet.WORK_CENTER_CAPACITY_UNIT,WorkCenterCapPerBucketSet.WORK_CENTER_CAP_UNIT_TEXT,WorkCenterCapPerBucketSet.PARAMETERS]

All fields of the WorkCenterCapPerBucketSet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCapPerBucketSet"

Technical entity name for WorkCenterCapPerBucketSet.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCapPerBucketSet>> = [WorkCenterCapPerBucketSet.P_CAP_EVAL_START_DATE, WorkCenterCapPerBucketSet.P_CAP_EVAL_END_DATE, WorkCenterCapPerBucketSet.P_CAP_EVAL_BUCKET_TYPE, WorkCenterCapPerBucketSet.PLANT, WorkCenterCapPerBucketSet.WORK_CENTER, WorkCenterCapPerBucketSet.CAPACITY_INTERNAL_ID, WorkCenterCapPerBucketSet.SHIFT_NAME, WorkCenterCapPerBucketSet.CAPACITY_EVALUATION_TIME_PERIOD, WorkCenterCapPerBucketSet.CAP_EVAL_BUCKET_TYPE]

All key fields of the WorkCenterCapPerBucketSet entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCapPerBucketSet>

    A builder that constructs instances of entity type WorkCenterCapPerBucketSet.

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

    Returns WorkCenterCapPerBucketSetRequestBuilder

    A WorkCenterCapPerBucketSet request builder.