Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_CostCenterActivityType" of service "API_COSTCENTERACTIVITYTYPE_SRV". This service is part of the following communication scenarios: SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_COSTCENTERACTIVITYTYPE_SRV for more information.

Hierarchy

  • Entity
    • CostCenterActivityType

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 activityTypeIsBlocked

activityTypeIsBlocked: undefined | string

Lock Indicator. Indicator determining whether an activity type is locked for activity input planning. If the indicator is active, the affected activity type cannot be included.NotesIf planning is reconciled, meaning plan activity = scheduled activity, the indicator should be activated so that the plan quantity remains unchanged.If the indicator is inactive, the activity type can be drawn upon for activity input planning and indirect activity allocation in plan.If active, the lock indicator has no effect onactual postingsplanning, other than activity input planning and indirect activity allocation in planactivity price changes. Maximum length: 1.

nullable

Optional actlPostgCostCenterActyTypeCat

actlPostgCostCenterActyTypeCat: undefined | string

Variant Activity Type Category for Actual Postings. Indicator determining the method of actual activity allocation. Activity type category 1 (Manual entry, manual allocation)Actual activity quantities in internal activity allocation are entered based on transaction.Activity type category 2 (Indirect calculation, indirect allocation)Activity quantities produced by activity types cannot be calculated or only with great effort. The plan and actual activity quantities are determined in indirect activity allocation using defined sender/receiver relationships and receiver tracing factors or fixed quantities (defined in the segments)Allocating the activities also takes place automatically through indirect activity allocation as described above.The actual and plan activity quantities result from the sum of the activity inputs calculated from the tracing factors on the individual receivers.Plan and scheduled activity quantities are therefore automatically reconciled.Activity type category 3 (Manual entry, indirect allocation)Activity quantities are planned manually. Entering the actual activity quantity takes place on a transaction-related basis using a special function (Non-allocatable activities) for which no receiver objects can be given.The plan and actual activity quantities are allocated indirectly using defined sender/receiver relationships. The R/3 System calculates the activity quantity to be allocated for each receiver based on the ratios of tracing factors for all receivers. The manually planned or posted activity is thereby completely allocated to the receivers.This always ensures that the plan activities are fully reconciled after carrying out indirect activity allocation.Activity type category 4 (Manual entry, no allocation)Activity types of this category use actual activity quantities entered on a transaction-related basis using a special function (Non-allocatable activities) where no receiver objects can be entered.Activity type category 5 (Calculation and allocation via target=actual activity allocation)Used in target=actual activity allocation.Because the allocation is used only for actual values, activities used in target=actual activity allocation must be given separate activity type categories for plan and actual. Planning can use categories 1, 2, or 3, where 1 is used as a rule.You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time. Maximum length: 1.

nullable

Optional actualPriceAllocationMethod

actualPriceAllocationMethod: undefined | string

Indicator: Actual Allocation Price. Indicator showing how the R/3 System calculates the actual price of an activity type for a cost center. For actual allocation you can specify an indicator that varies from the plan, "005" and "006".The actual price indicator can also have the value "008". This occurs when you select the "Purely iterative price" indicator in the version maintenance of Customizing.The following values are possible:005 (actual price)When you execute actual price calculation, the R/3 System determines the actual price based on the actual activity.006 (actual price)The variable portion of the price is determined through the actual activity. To determine the fixed portion, however, the system uses the actual capacity. This is relevant for cost centers that must always provide the maximum activity quantity, for example, the provision of energy on an energy cost center. The overall costs for this cost center are fixed.NoteIf you have set the values "005" and "006", the system calculates new prices when you execute actual price calculation. Revaluation of actual activity at actual prices occurs only if you have selected Revaluation in version maintenance.008 (Selecting version maintenance):The actual price of the activity type is caluclated purely iteratively. If you activate the indicator Purely iterative price in the version, the R/3 System calculates an iterative price along with the price resulting from planning.You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time. Maximum length: 3.

nullable

Optional actualQuantityIsSetManually

actualQuantityIsSetManually: undefined | false | true

Indicator: Confirm quantity manually in actual. If this indicator is set, you must post a manual quantity, in addition to the quantity with which the object is credited. This makes sense especially when the quantity leading to the credit of the object is to be determined indirectly, but the actual quantity from the sender view is already known. You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time.

nullable

Optional allocationCostElement

allocationCostElement: undefined | string

Allocation Cost Element. The allocation cost element is a secondary cost element, under which the activity type or business process is allocated. The allocation cost element is the central characteristic used in all CO postings. It is therefore also an important criterion for reporting - for example, many reports are structured according to the posted cost elements.You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time.The allocation cost element must have been created in the cost element master data as a secondary cost element of category 43 "Allocate activities/processes".Field changesYou can change this field for each fiscal year. For example, you can change the field content for a new fiscal year.Time dependencyThe data in this field is always time-based. Maximum length: 10.

nullable

controllingArea

controllingArea: string

Controlling Area. Maximum length: 4.

costCtrActivityType

costCtrActivityType: 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.

Optional costCtrActivityTypeCategory

costCtrActivityTypeCategory: undefined | string

Activity Type Category. Indicator determining the method of activity quantity planning and activity allocation. Activity type category 1 (Manual entry, manual allocation)Activity types of this category use plan activity quantities. The plan activity is allocated to the different receiver objects using activity input planning. It may be necessary to reconcile the activity quantities and the plan scheduled activity.Actual activity quantities are entered for each business transaction using internal activity allocation.Activity type category 2 (Indirect calculation, indirect allocation)The quantities produced by the activity types in this category cannot be calculated or only with great effort. The plan and actual activity quantities are determined in indirect activity allocation using one of the following:The defined sender/receiver relationshpsThe receiver tracing factorsFixed quantities (defined in the segments)Allocating the activities also takes place automatically through indirect activity allocation as described above.The actual and planned activity quantities result from the sum of the activity inputs calculated from the tracing factors on the individual receivers.Plan and scheduled activity quantities are therefore automatically reconciled.Activity type category 3 (Manual entry, indirect allocation)Activity types of this category use activity quantities entered manually. Entering the actual activity quantity takes place on an activity-related basis using a special function (Non-allocatable activities) for which no receiver objects can be given.The plan and actual activity quantities are allocated indirectly using defined sender/receiver relationships. The R/3 System calculates the activity quantity to be allocated for each receiver based on the ratios of tracing factors for all receivers. The manually planned or posted activity is thereby completely allocated to the receivers.This ensures that plan activities are fully reconciled after carrying out indirect activity allocation.Activity type category 4 (Manual entry, no allocation)Activity types of this category use activity quantities entered manually. Allocations to other objects are not possible.The actual activity quantity is entered for each transaction using a special function (Non-allocatable activities). No receiver objects can be entered.You can save a default value in the master data for an activity type or a business process for allocatable activity type categories or allocation categories (category 1, 2 or 3). You can change the default value within planning to a different allocatable activity type category or allocation category if you are planning for the first time.You can only change non-allocatable activity type categories or allocation categories (category 4) to an allocatable activity type category or allocation category (or vice versa) if activity-dependent data exists. Maximum length: 1.

nullable

Optional costCtrActivityTypeOutpQtyUnit

costCtrActivityTypeOutpQtyUnit: undefined | string

Output Unit. The output unit is the unit of measure in which the activity produced is posted. The unit of measure with which the output is recorded in databases is defined in the activity type master and cannot be changed.You can make subsequent plan and actual postings in an output unit different to the one recorded in the database, provided it can be converted to the unit of measure defined in the activity type master. Maximum length: 3.

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 costOriginGroup

costOriginGroup: undefined | string

Origin Group as Subdivision of Cost Element. Used for subdividing material and overhead costs. When material costs are calculated, each material is given a general ledger account and thus is assigned to a primary cost element. If you enter an origin group for the material, the combination of source group and cost element is updated to the CO component. This means that you canDefine calculation bases for determination of overhead rates for particular material groups.Define cost components in product costing for particular material groups.Create rules for activating work in process for each material group.When overhead is calculated, an object is debited with overhead costs and another object (usually a cost center) is credited. For more information on the origin of overhead rates in the credit record, specify an origin group in the credit key. The system then displays the origin group in Cost Center Accounting, as well as the overhead cost element. Maximum length: 4.

nullable

Optional creationDate

creationDate: Moment

Entered On. Date on which the cost estimate was created.

nullable

Optional enteredByUser

enteredByUser: undefined | string

Entered By. User ID of the person who created the cost estimate. Maximum length: 12.

nullable

Optional fixedCostIsPredistributed

fixedCostIsPredistributed: undefined | false | true

Predistribution of fixed costs for acty type/bus. process. Indicator for allowing the activity type or business process to be used in fixed cost predistribution. You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time.

nullable

Optional outputQuantityFactor

outputQuantityFactor: BigNumber

Output factor. Factor describing the relationship between activity quantity and output quantity, expressed by the formula: Output quantity = Activity quantity * Output factorIn planning you can calculate the output quantity from the activityquantity and output factor. In the planning transaction, choose "Edit -> Activity -> Output".

nullable

Optional periodPriceIsAverage

periodPriceIsAverage: undefined | false | true

Price Calculation with Period-Based Average Prices. Indicator determining that activity prices for cost centers/activity types remain constant for the entire fiscal year. You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time.This takes place either on the version level or per cost center/activity type in planning.VersionActivity prices for cost centers/activity types remain constant for the entire fiscal year in the version. The total plan costs and activity are taken into account when activity prices are calculated. Monthly fluctuations are ignored. Activate the "Average activity price" indicator from the fiscal-year dependent version parameters in the version as a planning method.Cost center/activity typeIf you have not defined an average activity price for your version, you can define a constant activity price for the fiscal year for individual cost centers/activity types. Activity price calculation smoothes out fluctuations in the cost center/activity type activity price. Activate the appropriate indicator in activity type planning.A default value for planning can be saved in the activity type master record. This value can be overwritten during planning.

nullable

Optional planQuantityIsSetManually

planQuantityIsSetManually: undefined | false | true

Indicator: Plan quantity manually set. If you set this indicator, the planned activity quantity is not changed by plan reconciliation, even if planning is not to be reconciled for the object. You can store a default value in the master data of an activity type or a business process.You can overwrite the default value within planning if you are planning for the first time.

nullable

Optional priceAllocationMethod

priceAllocationMethod: undefined | string

Price Indicator: Calculate Allocation Price. Indicator showing how the R/3 System calculates the price of a business process or activity type for a cost center. To do this there are two fields: The "Price indicator" field controls plan price calculation. For actual allocations you can set an indicator in the "Actual price indicator" field that differs from the plan indicator.You can enter "001", "002" or "003" in the "Price indicator" field or "005" or "006" in the "Actual price indicator" field.The plan price indicator can have the value "004", the actual price indicator "008". This occurs if you have selected "Purely iterative Prices" in version maintenance within Customizing.NoteIf you do not set a price indicator, the system uses the plan price.The meaning of the possible entries is as follows:001:The price of the activity type is determined automatically based on the planned activity and the planned costs required for this plan activity quantity.Fixed price: Fixed planned costs/plan activity quantityVariable price: Variable planned costs/plan activity quantityTotal price: Fixed price + variable price002:The variable portion of the price is calculated based on the plan activity quantity. To determine the fixed portion, the system uses the capacity and not the plan activity quantity.This procedure usually leads to an underabsorption of the cost center or business process from the perspective of quantities.Fixed price: Fixed planned costs/capacityVariable price: Variable planned costs/planned activityTotal price: Fixed price + variable priceNoteIf you have entered the values "001" or "002", the system calculates new prices when determining the plan prices.003:The price of the activity type or business process is set manually.004 (activation of version maintenance):The plan price of the activity type or business process is determined iteratively only.If you activate the indicator purely iterative price in the version, the R/3 System calculates an iterative price along with the price resulting from planning.005: (actual price)The R/3 System determines the price of the activity type using the actual activity of the cost center.006: (actual price)The variable portion of the price is calculated based on the actual activity.NoteIf you have set the values "005" and "006", the system calculates new prices when you execute actual price calculation. Revaluation of actual activity at actual prices occurs only if you have selected Revaluation in version maintenance.007 (manual actual price)The actual price of the activity price or business process is set manually. Using this price indicator, you can set an independent (manual) price that differs from the plan.008: (actual price, selection using version maintenance)Purely iterative actual priceIf you activate the indicator Purely iterative price in the version, the R/3 System calculates an iterative price along with the price resulting from planning.In the master data of the activity type or business process, you can define a default value.When planning for the first time, this default value can be overwritten. Maximum length: 3.

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

toText

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

validityEndDate

validityEndDate: Moment

Valid To Date. Date indicating up to when an entry is valid.

Optional validityStartDate

validityStartDate: Moment

Valid-From Date. Date indicating as of when an entry is valid.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ACTIVITY_TYPE_IS_BLOCKED

ACTIVITY_TYPE_IS_BLOCKED: StringField<CostCenterActivityType> = new StringField('ActivityTypeIsBlocked', CostCenterActivityType, 'Edm.String')

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

Static ACTL_POSTG_COST_CENTER_ACTY_TYPE_CAT

ACTL_POSTG_COST_CENTER_ACTY_TYPE_CAT: StringField<CostCenterActivityType> = new StringField('ActlPostgCostCenterActyTypeCat', CostCenterActivityType, 'Edm.String')

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

Static ACTUAL_PRICE_ALLOCATION_METHOD

ACTUAL_PRICE_ALLOCATION_METHOD: StringField<CostCenterActivityType> = new StringField('ActualPriceAllocationMethod', CostCenterActivityType, 'Edm.String')

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

Static ACTUAL_QUANTITY_IS_SET_MANUALLY

ACTUAL_QUANTITY_IS_SET_MANUALLY: BooleanField<CostCenterActivityType> = new BooleanField('ActualQuantityIsSetManually', CostCenterActivityType, 'Edm.Boolean')

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

Static ALLOCATION_COST_ELEMENT

ALLOCATION_COST_ELEMENT: StringField<CostCenterActivityType> = new StringField('AllocationCostElement', CostCenterActivityType, 'Edm.String')

Static representation of the allocationCostElement 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<CostCenterActivityType> = new AllFields('*', CostCenterActivityType)

All fields selector.

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<CostCenterActivityType> = new StringField('ControllingArea', CostCenterActivityType, '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_CTR_ACTIVITY_TYPE

COST_CTR_ACTIVITY_TYPE: StringField<CostCenterActivityType> = new StringField('CostCtrActivityType', CostCenterActivityType, '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_CATEGORY

COST_CTR_ACTIVITY_TYPE_CATEGORY: StringField<CostCenterActivityType> = new StringField('CostCtrActivityTypeCategory', CostCenterActivityType, 'Edm.String')

Static representation of the costCtrActivityTypeCategory 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_OUTP_QTY_UNIT

COST_CTR_ACTIVITY_TYPE_OUTP_QTY_UNIT: StringField<CostCenterActivityType> = new StringField('CostCtrActivityTypeOutpQtyUnit', CostCenterActivityType, 'Edm.String')

Static representation of the costCtrActivityTypeOutpQtyUnit 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<CostCenterActivityType> = new StringField('CostCtrActivityTypeQtyUnit', CostCenterActivityType, '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_ORIGIN_GROUP

COST_ORIGIN_GROUP: StringField<CostCenterActivityType> = new StringField('CostOriginGroup', CostCenterActivityType, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<CostCenterActivityType> = new DateField('CreationDate', CostCenterActivityType, 'Edm.DateTime')

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

Static ENTERED_BY_USER

ENTERED_BY_USER: StringField<CostCenterActivityType> = new StringField('EnteredByUser', CostCenterActivityType, 'Edm.String')

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

Static FIXED_COST_IS_PREDISTRIBUTED

FIXED_COST_IS_PREDISTRIBUTED: BooleanField<CostCenterActivityType> = new BooleanField('FixedCostIsPredistributed', CostCenterActivityType, 'Edm.Boolean')

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

Static OUTPUT_QUANTITY_FACTOR

OUTPUT_QUANTITY_FACTOR: BigNumberField<CostCenterActivityType> = new BigNumberField('OutputQuantityFactor', CostCenterActivityType, 'Edm.Decimal')

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

Static PERIOD_PRICE_IS_AVERAGE

PERIOD_PRICE_IS_AVERAGE: BooleanField<CostCenterActivityType> = new BooleanField('PeriodPriceIsAverage', CostCenterActivityType, 'Edm.Boolean')

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

Static PLAN_QUANTITY_IS_SET_MANUALLY

PLAN_QUANTITY_IS_SET_MANUALLY: BooleanField<CostCenterActivityType> = new BooleanField('PlanQuantityIsSetManually', CostCenterActivityType, 'Edm.Boolean')

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

Static PRICE_ALLOCATION_METHOD

PRICE_ALLOCATION_METHOD: StringField<CostCenterActivityType> = new StringField('PriceAllocationMethod', CostCenterActivityType, 'Edm.String')

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

Static TO_TEXT

TO_TEXT: Link<CostCenterActivityType, CostCenterActivityTypeText> = new Link('to_Text', CostCenterActivityType, CostCenterActivityTypeText)

Static representation of the one-to-many navigation property toText 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<CostCenterActivityType> = new DateField('ValidityEndDate', CostCenterActivityType, '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<CostCenterActivityType> = new DateField('ValidityStartDate', CostCenterActivityType, '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 _allFields

_allFields: Array<StringField<CostCenterActivityType> | DateField<CostCenterActivityType> | BigNumberField<CostCenterActivityType> | BooleanField<CostCenterActivityType> | Link<CostCenterActivityType, CostCenterActivityTypeText>> = [CostCenterActivityType.CONTROLLING_AREA,CostCenterActivityType.COST_CTR_ACTIVITY_TYPE,CostCenterActivityType.VALIDITY_END_DATE,CostCenterActivityType.VALIDITY_START_DATE,CostCenterActivityType.COST_CTR_ACTIVITY_TYPE_QTY_UNIT,CostCenterActivityType.COST_CTR_ACTIVITY_TYPE_CATEGORY,CostCenterActivityType.ALLOCATION_COST_ELEMENT,CostCenterActivityType.COST_CTR_ACTIVITY_TYPE_OUTP_QTY_UNIT,CostCenterActivityType.CREATION_DATE,CostCenterActivityType.ENTERED_BY_USER,CostCenterActivityType.COST_ORIGIN_GROUP,CostCenterActivityType.ACTL_POSTG_COST_CENTER_ACTY_TYPE_CAT,CostCenterActivityType.OUTPUT_QUANTITY_FACTOR,CostCenterActivityType.ACTIVITY_TYPE_IS_BLOCKED,CostCenterActivityType.FIXED_COST_IS_PREDISTRIBUTED,CostCenterActivityType.PRICE_ALLOCATION_METHOD,CostCenterActivityType.PERIOD_PRICE_IS_AVERAGE,CostCenterActivityType.ACTUAL_PRICE_ALLOCATION_METHOD,CostCenterActivityType.ACTUAL_QUANTITY_IS_SET_MANUALLY,CostCenterActivityType.PLAN_QUANTITY_IS_SET_MANUALLY,CostCenterActivityType.TO_TEXT]

All fields of the CostCenterActivityType entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_CostCenterActivityType"

Technical entity name for CostCenterActivityType.

Static _keyFields

_keyFields: Array<Selectable<CostCenterActivityType>> = [CostCenterActivityType.CONTROLLING_AREA, CostCenterActivityType.COST_CTR_ACTIVITY_TYPE, CostCenterActivityType.VALIDITY_END_DATE]

All key fields of the CostCenterActivityType entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_COSTCENTERACTIVITYTYPE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<CostCenterActivityType>

    A builder that constructs instances of entity type CostCenterActivityType.

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

    Returns CostCenterActivityTypeRequestBuilder

    A CostCenterActivityType request builder.