Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_WorkCenterCostCenter" 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
    • WorkCenterCostCenter

Implements

Index

Constructors

constructor

  • Returns WorkCenterCostCenter

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 activityDescOriginType

activityDescOriginType: undefined | string

Activity Description Origin Type. Maximum length: 1.

nullable

Optional businessProcess

businessProcess: undefined | string

Business Process. Key uniquely identifying a business process. Maximum length: 12.

nullable

Optional controllingArea

controllingArea: undefined | string

Controlling Area. Maximum length: 4.

nullable

Optional costCenter

costCenter: undefined | string

Cost Center. A key that uniquely identifies a cost center. Maximum length: 10.

nullable

Optional costCenterActivityAltvDescId

costCenterActivityAltvDescId: undefined | string

ID for Alternative Activity Description. Maximum length: 4.

nullable

Optional costCenterActivityTypeFormula

costCenterActivityTypeFormula: undefined | string

Formula key for costing. Key which refers to the formula used to determine costs per activity type. Maximum length: 6.

nullable

costCenterAllocation

costCenterAllocation: string

Cost Center Allocation. Maximum length: 4.

Optional costCtrActivityType

costCtrActivityType: undefined | string

Activity Type. Key uniquely identifying . Activity types describe the activity produced by a cost center and are measured in units of time or quantity.In activity type planning, control data determines whether the activity price for evaluation of the activity type is manually set or is derived iteratively through activity price calculation. Maximum length: 6.

nullable

Optional costCtrActivityTypeQtyUnit

costCtrActivityTypeQtyUnit: undefined | string

Activity Unit. The activity unit is either the time or quantity unit used to post the consumed activity quantities. The database records the activity type using the unit stored in the activity type master data.You cannot change the unit in the master data if dependent data exists.Subsequent plan or actual postings can use different units provided they are defined as convertible to the unit defined in the master data. Maximum length: 3.

nullable

Optional costCtrActyTypeIncntvWageCode

costCtrActyTypeIncntvWageCode: undefined | string

Transfer activity types to incentive wages. Represents the six activity types for the values used in incentive wages. If the Incentive Wage and Logistics modules are integrated, activity data and confirmation values are transferred to the time tickets in incentive wages.The activity types in Logistics must be assigned to the Incentive Wage fieldslabor timesetup timemachine time andvariable activity typeteardown time.This indicator controls which incentive wage value represents which type of activity. This assignment is valid for the activity default values and actual values of the confirmation.Each indicator may be used only once per default value key; otherwise the assignment is not unique. Maximum length: 1.

nullable

Optional costCtrActyTypeIsReferenced

costCtrActyTypeIsReferenced: undefined | false | true

Field is referenced. Indicator specifying that you cannot change the value in a task list. Note that when you remove the reference indicator for a work center used in a routing, the default values from the work center are not copied to the routing.You must use the mass replacement function or replace these values manually in the routing.

nullable

Optional costCtrActyTypeRecdTypeGrpCode

costCtrActyTypeRecdTypeGrpCode: undefined | string

Record type group. Specifies how and when the actual value is confirmed for a parameter using plant data collection. For example, you may specify that the actual value is transferred once setup is completed. Maximum length: 1.

nullable

Optional plant

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

validityEndDate

validityEndDate: Moment

End Date. Contains a date that identifies the end of the validity period. A validity period identifies the lifespan assigned to an object or an infotype record, or the period of time that these items "exist". Validity periods consist of a start date and end date.

Optional validityStartDate

validityStartDate: Moment

Start Date. Contains a date that identifies the start of a validity period. A validity period identifies the lifespan assigned to an object or an infotype record, or the period of time that these items "exist". Validity periods consist of a start date and end date.

nullable

Optional workCenter

workCenter: undefined | string

Work Center. Maximum length: 8.

nullable

Optional workCenterCategoryCode

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

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.

Optional workCenterLastChangeDateTime

workCenterLastChangeDateTime: Moment

Date and Time of Last Change.

nullable

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 ACTIVITY_DESC_ORIGIN_TYPE

ACTIVITY_DESC_ORIGIN_TYPE: StringField<WorkCenterCostCenter> = new StringField('ActivityDescOriginType', WorkCenterCostCenter, 'Edm.String')

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

Static ALL_FIELDS

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

All fields selector.

Static BUSINESS_PROCESS

BUSINESS_PROCESS: StringField<WorkCenterCostCenter> = new StringField('BusinessProcess', WorkCenterCostCenter, 'Edm.String')

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

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<WorkCenterCostCenter> = new StringField('ControllingArea', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CENTER

COST_CENTER: StringField<WorkCenterCostCenter> = new StringField('CostCenter', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CENTER_ACTIVITY_ALTV_DESC_ID

COST_CENTER_ACTIVITY_ALTV_DESC_ID: StringField<WorkCenterCostCenter> = new StringField('CostCenterActivityAltvDescID', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CENTER_ACTIVITY_TYPE_FORMULA

COST_CENTER_ACTIVITY_TYPE_FORMULA: StringField<WorkCenterCostCenter> = new StringField('CostCenterActivityTypeFormula', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CENTER_ALLOCATION

COST_CENTER_ALLOCATION: StringField<WorkCenterCostCenter> = new StringField('CostCenterAllocation', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CTR_ACTIVITY_TYPE

COST_CTR_ACTIVITY_TYPE: StringField<WorkCenterCostCenter> = new StringField('CostCtrActivityType', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CTR_ACTIVITY_TYPE_QTY_UNIT

COST_CTR_ACTIVITY_TYPE_QTY_UNIT: StringField<WorkCenterCostCenter> = new StringField('CostCtrActivityTypeQtyUnit', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CTR_ACTY_TYPE_INCNTV_WAGE_CODE

COST_CTR_ACTY_TYPE_INCNTV_WAGE_CODE: StringField<WorkCenterCostCenter> = new StringField('CostCtrActyTypeIncntvWageCode', WorkCenterCostCenter, 'Edm.String')

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

Static COST_CTR_ACTY_TYPE_IS_REFERENCED

COST_CTR_ACTY_TYPE_IS_REFERENCED: BooleanField<WorkCenterCostCenter> = new BooleanField('CostCtrActyTypeIsReferenced', WorkCenterCostCenter, 'Edm.Boolean')

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

Static COST_CTR_ACTY_TYPE_RECD_TYPE_GRP_CODE

COST_CTR_ACTY_TYPE_RECD_TYPE_GRP_CODE: StringField<WorkCenterCostCenter> = new StringField('CostCtrActyTypeRecdTypeGrpCode', WorkCenterCostCenter, 'Edm.String')

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

Static PLANT

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

VALIDITY_END_DATE: DateField<WorkCenterCostCenter> = new DateField('ValidityEndDate', WorkCenterCostCenter, 'Edm.DateTime')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<WorkCenterCostCenter> = new DateField('ValidityStartDate', WorkCenterCostCenter, 'Edm.DateTime')

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

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

WORK_CENTER_LAST_CHANGE_DATE_TIME: DateField<WorkCenterCostCenter> = new DateField('WorkCenterLastChangeDateTime', WorkCenterCostCenter, 'Edm.DateTimeOffset')

Static representation of the workCenterLastChangeDateTime 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<WorkCenterCostCenter> = new StringField('WorkCenterTypeCode', WorkCenterCostCenter, '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<WorkCenterCostCenter> | DateField<WorkCenterCostCenter> | BooleanField<WorkCenterCostCenter>> = [WorkCenterCostCenter.WORK_CENTER_INTERNAL_ID,WorkCenterCostCenter.WORK_CENTER_TYPE_CODE,WorkCenterCostCenter.COST_CENTER_ALLOCATION,WorkCenterCostCenter.VALIDITY_END_DATE,WorkCenterCostCenter.VALIDITY_START_DATE,WorkCenterCostCenter.WORK_CENTER,WorkCenterCostCenter.PLANT,WorkCenterCostCenter.WORK_CENTER_CATEGORY_CODE,WorkCenterCostCenter.CONTROLLING_AREA,WorkCenterCostCenter.COST_CENTER,WorkCenterCostCenter.COST_CTR_ACTIVITY_TYPE,WorkCenterCostCenter.COST_CTR_ACTIVITY_TYPE_QTY_UNIT,WorkCenterCostCenter.BUSINESS_PROCESS,WorkCenterCostCenter.ACTIVITY_DESC_ORIGIN_TYPE,WorkCenterCostCenter.COST_CENTER_ACTIVITY_ALTV_DESC_ID,WorkCenterCostCenter.COST_CENTER_ACTIVITY_TYPE_FORMULA,WorkCenterCostCenter.COST_CTR_ACTY_TYPE_IS_REFERENCED,WorkCenterCostCenter.COST_CTR_ACTY_TYPE_INCNTV_WAGE_CODE,WorkCenterCostCenter.COST_CTR_ACTY_TYPE_RECD_TYPE_GRP_CODE,WorkCenterCostCenter.WORK_CENTER_LAST_CHANGE_DATE_TIME]

All fields of the WorkCenterCostCenter entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_WorkCenterCostCenter"

Technical entity name for WorkCenterCostCenter.

Static _keyFields

_keyFields: Array<Selectable<WorkCenterCostCenter>> = [WorkCenterCostCenter.WORK_CENTER_INTERNAL_ID, WorkCenterCostCenter.WORK_CENTER_TYPE_CODE, WorkCenterCostCenter.COST_CENTER_ALLOCATION, WorkCenterCostCenter.VALIDITY_END_DATE]

All key fields of the WorkCenterCostCenter entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_WORK_CENTERS"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkCenterCostCenter>

    A builder that constructs instances of entity type WorkCenterCostCenter.

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

    Returns WorkCenterCostCenterRequestBuilder

    A WorkCenterCostCenter request builder.