Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_EnterpriseProjectElement" of service "API_ENTERPRISE_PROJECT_SRV". This service is part of the following communication scenarios: Enterprise Project Integration (SAP_COM_0308). See https://api.sap.com/api/API_ENTERPRISE_PROJECT_SRV for more information.

Hierarchy

  • Entity
    • EnterpriseProjectElement

Implements

Index

Constructors

Properties

Accessors

Methods

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 companyCode

companyCode: undefined | string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

nullable

Optional controllingArea

controllingArea: undefined | string

Controlling Area. Maximum length: 4.

nullable

Optional costCenter

costCenter: undefined | string

Cost center to which costs are actually posted. When statistical postings are made to a WBS element, actual postings are also made to the cost center you have entered. This field is only used for statistical WBS elements. Maximum length: 10.

nullable

Optional costingSheet

costingSheet: undefined | string

Costing Sheet. Controls the calculation of overhead. You must store one costing sheet for each object for which the R/3 System is to determine overhead costs.For orders, you enter the costing sheet in the order master record.For overhead cost orders the costing sheet can be defaulted through a model order.For CO production orders without quantity structure the costing sheet can be defaulted through a planning profile.For production orders, process orders, produc cost collectors, maintenance orders, regular maintenance orders and service orders the costing sheet is defaulted through a valuation variant.The valuation variant is stored in the costing variant. You can store the costing variant as default value per order type and plant.For cost centers you enter the costing sheet in the master data.For buiness processes you enter the costing sheet in the master data.For projects you enter the costing sheet in the project profile.For materials the R/3 System selects the costing sheet through the valuation variant.For base object plannings, enter the costing sheet in the master data of the costing sheet.For cost object IDs the costing sheet is defaulted through the cost object profile.For cost and revenue carrying sales document items the costing sheet is defaulted through the requirements class. Maximum length: 6.

nullable

Optional createdByUser

createdByUser: undefined | string

Created By. Maximum length: 12.

nullable

Optional creationDateTime

creationDateTime: Moment

Timestamp of created object.

nullable

Optional factoryCalendar

factoryCalendar: undefined | string

Calendar. Maximum length: 2.

nullable

Optional functionalArea

functionalArea: undefined | string

Functional Area. Structure criterion for an enterprise or government based on functional aspects. Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements. Maximum length: 16.

nullable

Optional functionalLocation

functionalLocation: undefined | string

Functional Location. Label that uniquely identifies a functional location. If alternative labels exist for a functional location, you can define in your user profile which label should be displayed in this field. Maximum length: 40.

nullable

Optional investmentProfile

investmentProfile: undefined | string

Investment Measure Profile. Investment profile Important control functions of the investment profile:Automatic creation of an asset under construction when you create an internal order or a work breakdown structure (WBS) elementAsset class for the creation of the asset under constructionAsset class for depreciation simulation. Maximum length: 6.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Timestamp on which object was last changed.

nullable

Optional lastChangedByUser

lastChangedByUser: undefined | string

Last Changed By. Maximum length: 12.

nullable

Optional location

location: undefined | string

Location. Key that identifies the location. The location is subordinate entity in a plant. Maximum length: 10.

nullable

Optional parentObjectUuid

parentObjectUuid: undefined | string

Entity Guid.

nullable

Optional plannedEndDate

plannedEndDate: Moment

Latest Finish.

nullable

Optional plannedStartDate

plannedStartDate: Moment

Latest Start.

nullable

Optional plant

plant: undefined | string

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

nullable

Optional processingStatus

processingStatus: undefined | string

Object Processing Status. Maximum length: 2.

nullable

Optional profitCenter

profitCenter: undefined | string

Profit Center. Key which together with the controlling area uniquely identifies a profit center. Maximum length: 10.

nullable

Optional projectElement

projectElement: undefined | string

Identification of Entities. Maximum length: 24.

nullable

Optional projectElementDescription

projectElementDescription: undefined | string

Project Name. Maximum length: 40.

nullable

projectElementUuid

projectElementUuid: string

Entity Guid.

Optional projectLastChangedDateTime

projectLastChangedDateTime: Moment

Timestamp on which object was last changed.

nullable

Optional projectUuid

projectUuid: undefined | string

Entity Guid.

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 responsibleCostCenter

responsibleCostCenter: undefined | string

Responsible Cost Center. Maximum length: 10.

nullable

Optional sortingNumber

sortingNumber: undefined | string

Sort Number. Maximum length: 5.

nullable

Optional taxJurisdiction

taxJurisdiction: undefined | string

Tax Jurisdiction. The tax jurisdiction is used for determining the tax rates in the USA. It defines to which tax authorities you must pay your taxes. It is always the city to which the goods are supplied. Maximum length: 15.

nullable

toEntProjectElmntPublicSector

toEntProjectElmntPublicSector: EntProjectElmntPublicSector

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

toEnterpriseProject

toEnterpriseProject: EnterpriseProject

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

toParentProjElement

toParentProjElement: EnterpriseProjectElement

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

toSubProjElement

toSubProjElement: EnterpriseProjectElement[]

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

Optional wbsElementInternalId

wbsElementInternalId: undefined | string

WBS Element. Key identifying a WBS element. Maximum length: 8.

nullable

Optional wbsIsStatisticalWbsElement

wbsIsStatisticalWbsElement: undefined | false | true

Statistical WBS element. Use this indicator to specify whether a WBS element is only for statistical purposes or whether it may carry actual costs. Costs and if required revenues are carried on such a WBS element for statistical purposes. This means that:For business transactions that lead to actual costs/revenues another object is required to carry the actual costs.A statistical WBS element cannot be settled.Additional Restriction:You cannot settle overheads on statistical WBS elements.

nullable

Static ALL_FIELDS

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

All fields selector.

Static COMPANY_CODE

COMPANY_CODE: StringField<EnterpriseProjectElement> = new StringField('CompanyCode', EnterpriseProjectElement, 'Edm.String')

Static representation of the companyCode 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<EnterpriseProjectElement> = new StringField('ControllingArea', EnterpriseProjectElement, '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 COSTING_SHEET

COSTING_SHEET: StringField<EnterpriseProjectElement> = new StringField('CostingSheet', EnterpriseProjectElement, 'Edm.String')

Static representation of the costingSheet 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<EnterpriseProjectElement> = new StringField('CostCenter', EnterpriseProjectElement, '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 CREATED_BY_USER

CREATED_BY_USER: StringField<EnterpriseProjectElement> = new StringField('CreatedByUser', EnterpriseProjectElement, 'Edm.String')

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

Static CREATION_DATE_TIME

CREATION_DATE_TIME: DateField<EnterpriseProjectElement> = new DateField('CreationDateTime', EnterpriseProjectElement, 'Edm.DateTimeOffset')

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

Static FACTORY_CALENDAR

FACTORY_CALENDAR: StringField<EnterpriseProjectElement> = new StringField('FactoryCalendar', EnterpriseProjectElement, 'Edm.String')

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

Static FUNCTIONAL_AREA

FUNCTIONAL_AREA: StringField<EnterpriseProjectElement> = new StringField('FunctionalArea', EnterpriseProjectElement, 'Edm.String')

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

Static FUNCTIONAL_LOCATION

FUNCTIONAL_LOCATION: StringField<EnterpriseProjectElement> = new StringField('FunctionalLocation', EnterpriseProjectElement, 'Edm.String')

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

Static INVESTMENT_PROFILE

INVESTMENT_PROFILE: StringField<EnterpriseProjectElement> = new StringField('InvestmentProfile', EnterpriseProjectElement, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<EnterpriseProjectElement> = new StringField('LastChangedByUser', EnterpriseProjectElement, 'Edm.String')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<EnterpriseProjectElement> = new DateField('LastChangeDateTime', EnterpriseProjectElement, 'Edm.DateTimeOffset')

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

Static LOCATION

LOCATION: StringField<EnterpriseProjectElement> = new StringField('Location', EnterpriseProjectElement, 'Edm.String')

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

Static PARENT_OBJECT_UUID

PARENT_OBJECT_UUID: StringField<EnterpriseProjectElement> = new StringField('ParentObjectUUID', EnterpriseProjectElement, 'Edm.Guid')

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

Static PLANNED_END_DATE

PLANNED_END_DATE: DateField<EnterpriseProjectElement> = new DateField('PlannedEndDate', EnterpriseProjectElement, 'Edm.DateTime')

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

Static PLANNED_START_DATE

PLANNED_START_DATE: DateField<EnterpriseProjectElement> = new DateField('PlannedStartDate', EnterpriseProjectElement, 'Edm.DateTime')

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

Static PLANT

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

PROCESSING_STATUS: StringField<EnterpriseProjectElement> = new StringField('ProcessingStatus', EnterpriseProjectElement, 'Edm.String')

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

Static PROFIT_CENTER

PROFIT_CENTER: StringField<EnterpriseProjectElement> = new StringField('ProfitCenter', EnterpriseProjectElement, 'Edm.String')

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

Static PROJECT_ELEMENT

PROJECT_ELEMENT: StringField<EnterpriseProjectElement> = new StringField('ProjectElement', EnterpriseProjectElement, 'Edm.String')

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

Static PROJECT_ELEMENT_DESCRIPTION

PROJECT_ELEMENT_DESCRIPTION: StringField<EnterpriseProjectElement> = new StringField('ProjectElementDescription', EnterpriseProjectElement, 'Edm.String')

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

Static PROJECT_ELEMENT_UUID

PROJECT_ELEMENT_UUID: StringField<EnterpriseProjectElement> = new StringField('ProjectElementUUID', EnterpriseProjectElement, 'Edm.Guid')

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

Static PROJECT_LAST_CHANGED_DATE_TIME

PROJECT_LAST_CHANGED_DATE_TIME: DateField<EnterpriseProjectElement> = new DateField('ProjectLastChangedDateTime', EnterpriseProjectElement, 'Edm.DateTimeOffset')

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

Static PROJECT_UUID

PROJECT_UUID: StringField<EnterpriseProjectElement> = new StringField('ProjectUUID', EnterpriseProjectElement, 'Edm.Guid')

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

Static RESPONSIBLE_COST_CENTER

RESPONSIBLE_COST_CENTER: StringField<EnterpriseProjectElement> = new StringField('ResponsibleCostCenter', EnterpriseProjectElement, 'Edm.String')

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

Static SORTING_NUMBER

SORTING_NUMBER: StringField<EnterpriseProjectElement> = new StringField('SortingNumber', EnterpriseProjectElement, 'Edm.String')

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

Static TAX_JURISDICTION

TAX_JURISDICTION: StringField<EnterpriseProjectElement> = new StringField('TaxJurisdiction', EnterpriseProjectElement, 'Edm.String')

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

Static TO_ENTERPRISE_PROJECT

TO_ENTERPRISE_PROJECT: OneToOneLink<EnterpriseProjectElement, EnterpriseProject> = new OneToOneLink('to_EnterpriseProject', EnterpriseProjectElement, EnterpriseProject)

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

Static TO_ENT_PROJECT_ELMNT_PUBLIC_SECTOR

TO_ENT_PROJECT_ELMNT_PUBLIC_SECTOR: OneToOneLink<EnterpriseProjectElement, EntProjectElmntPublicSector> = new OneToOneLink('to_EntProjectElmntPublicSector', EnterpriseProjectElement, EntProjectElmntPublicSector)

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

Static TO_PARENT_PROJ_ELEMENT

TO_PARENT_PROJ_ELEMENT: OneToOneLink<EnterpriseProjectElement, EnterpriseProjectElement> = new OneToOneLink('to_ParentProjElement', EnterpriseProjectElement, EnterpriseProjectElement)

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

Static TO_SUB_PROJ_ELEMENT

TO_SUB_PROJ_ELEMENT: Link<EnterpriseProjectElement, EnterpriseProjectElement> = new Link('to_SubProjElement', EnterpriseProjectElement, EnterpriseProjectElement)

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

Static WBS_ELEMENT_INTERNAL_ID

WBS_ELEMENT_INTERNAL_ID: StringField<EnterpriseProjectElement> = new StringField('WBSElementInternalID', EnterpriseProjectElement, 'Edm.String')

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

Static WBS_IS_STATISTICAL_WBS_ELEMENT

WBS_IS_STATISTICAL_WBS_ELEMENT: BooleanField<EnterpriseProjectElement> = new BooleanField('WBSIsStatisticalWBSElement', EnterpriseProjectElement, 'Edm.Boolean')

Static representation of the wbsIsStatisticalWbsElement 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<EnterpriseProjectElement> | DateField<EnterpriseProjectElement> | BooleanField<EnterpriseProjectElement> | OneToOneLink<EnterpriseProjectElement, EnterpriseProject> | OneToOneLink<EnterpriseProjectElement, EntProjectElmntPublicSector> | OneToOneLink<EnterpriseProjectElement, EnterpriseProjectElement> | Link<EnterpriseProjectElement, EnterpriseProjectElement>> = [EnterpriseProjectElement.PROJECT_ELEMENT_UUID,EnterpriseProjectElement.PROJECT_ELEMENT,EnterpriseProjectElement.WBS_ELEMENT_INTERNAL_ID,EnterpriseProjectElement.PROJECT_UUID,EnterpriseProjectElement.PROJECT_ELEMENT_DESCRIPTION,EnterpriseProjectElement.PARENT_OBJECT_UUID,EnterpriseProjectElement.PROCESSING_STATUS,EnterpriseProjectElement.SORTING_NUMBER,EnterpriseProjectElement.PLANNED_START_DATE,EnterpriseProjectElement.PLANNED_END_DATE,EnterpriseProjectElement.RESPONSIBLE_COST_CENTER,EnterpriseProjectElement.COMPANY_CODE,EnterpriseProjectElement.PROFIT_CENTER,EnterpriseProjectElement.FUNCTIONAL_AREA,EnterpriseProjectElement.CONTROLLING_AREA,EnterpriseProjectElement.PLANT,EnterpriseProjectElement.LOCATION,EnterpriseProjectElement.TAX_JURISDICTION,EnterpriseProjectElement.FUNCTIONAL_LOCATION,EnterpriseProjectElement.FACTORY_CALENDAR,EnterpriseProjectElement.COSTING_SHEET,EnterpriseProjectElement.INVESTMENT_PROFILE,EnterpriseProjectElement.WBS_IS_STATISTICAL_WBS_ELEMENT,EnterpriseProjectElement.COST_CENTER,EnterpriseProjectElement.CREATED_BY_USER,EnterpriseProjectElement.CREATION_DATE_TIME,EnterpriseProjectElement.LAST_CHANGE_DATE_TIME,EnterpriseProjectElement.LAST_CHANGED_BY_USER,EnterpriseProjectElement.PROJECT_LAST_CHANGED_DATE_TIME,EnterpriseProjectElement.TO_ENTERPRISE_PROJECT,EnterpriseProjectElement.TO_ENT_PROJECT_ELMNT_PUBLIC_SECTOR,EnterpriseProjectElement.TO_PARENT_PROJ_ELEMENT,EnterpriseProjectElement.TO_SUB_PROJ_ELEMENT]

All fields of the EnterpriseProjectElement entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_EnterpriseProjectElement"

Technical entity name for EnterpriseProjectElement.

Static _keyFields

_keyFields: Array<Selectable<EnterpriseProjectElement>> = [EnterpriseProjectElement.PROJECT_ELEMENT_UUID]

All key fields of the EnterpriseProjectElement entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_ENTERPRISE_PROJECT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<EnterpriseProjectElement>

    A builder that constructs instances of entity type EnterpriseProjectElement.

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

    Returns EnterpriseProjectElementRequestBuilder

    A EnterpriseProjectElement request builder.