Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_EnterpriseProject" of service "API_ENTERPRISE_PROJECT_SRV". This service is part of the following communication scenarios: Enterprise Project - Create, Read, Update, Delete Integration (SAP_COM_0308). See https://api.sap.com/api/API_ENTERPRISE_PROJECT_SRV for more information.

Hierarchy

  • Entity
    • EnterpriseProject

Implements

Index

Constructors

constructor

  • Returns EnterpriseProject

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 enterpriseProjectType

enterpriseProjectType: undefined | string

Project type. Key identifying a project type. You can define the criteria for a project type. 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 lastChangeDateTime

lastChangeDateTime: Moment

Date on which object was last changed.

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 plant

plant: undefined | string

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

nullable

Optional priorityCode

priorityCode: undefined | string

Priority. Maximum length: 3.

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 project

project: undefined | string

Identification of Entities. Maximum length: 24.

nullable

Optional projectDescription

projectDescription: undefined | string

Language-Dependent Description. Maximum length: 40.

nullable

Optional projectEndDate

projectEndDate: Moment

Project End Date.

nullable

Optional projectInternalId

projectInternalId: undefined | string

Project (internal). Maximum length: 24.

nullable

Optional projectManagerUuid

projectManagerUuid: undefined | string

Project Manager Uuid.

nullable

Optional projectProfileCode

projectProfileCode: undefined | string

Project Profile. Key identifying a project profile. Maximum length: 7.

nullable

Optional projectStartDate

projectStartDate: Moment

Project Start Date.

nullable

projectUuid

projectUuid: string

Entity Guid.

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

toEnterpriseProjectElement

toEnterpriseProjectElement: EnterpriseProjectElement[]

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

toEnterpriseProjectJva

toEnterpriseProjectJva: EnterpriseProjectJva

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static COMPANY_CODE

COMPANY_CODE: StringField<EnterpriseProject> = new StringField('CompanyCode', EnterpriseProject, '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<EnterpriseProject> = new StringField('ControllingArea', EnterpriseProject, '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 ENTERPRISE_PROJECT_TYPE

ENTERPRISE_PROJECT_TYPE: StringField<EnterpriseProject> = new StringField('EnterpriseProjectType', EnterpriseProject, 'Edm.String')

Static representation of the enterpriseProjectType 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<EnterpriseProject> = new StringField('FunctionalArea', EnterpriseProject, '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 LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<EnterpriseProject> = new DateField('LastChangeDateTime', EnterpriseProject, '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<EnterpriseProject> = new StringField('Location', EnterpriseProject, '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 PLANT

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

PRIORITY_CODE: StringField<EnterpriseProject> = new StringField('PriorityCode', EnterpriseProject, 'Edm.String')

Static representation of the priorityCode 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<EnterpriseProject> = new StringField('ProcessingStatus', EnterpriseProject, '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<EnterpriseProject> = new StringField('ProfitCenter', EnterpriseProject, '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

PROJECT: StringField<EnterpriseProject> = new StringField('Project', EnterpriseProject, 'Edm.String')

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

Static PROJECT_DESCRIPTION

PROJECT_DESCRIPTION: StringField<EnterpriseProject> = new StringField('ProjectDescription', EnterpriseProject, 'Edm.String')

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

Static PROJECT_END_DATE

PROJECT_END_DATE: DateField<EnterpriseProject> = new DateField('ProjectEndDate', EnterpriseProject, 'Edm.DateTime')

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

Static PROJECT_INTERNAL_ID

PROJECT_INTERNAL_ID: StringField<EnterpriseProject> = new StringField('ProjectInternalID', EnterpriseProject, 'Edm.String')

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

Static PROJECT_MANAGER_UUID

PROJECT_MANAGER_UUID: StringField<EnterpriseProject> = new StringField('ProjectManagerUUID', EnterpriseProject, 'Edm.Guid')

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

Static PROJECT_PROFILE_CODE

PROJECT_PROFILE_CODE: StringField<EnterpriseProject> = new StringField('ProjectProfileCode', EnterpriseProject, 'Edm.String')

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

Static PROJECT_START_DATE

PROJECT_START_DATE: DateField<EnterpriseProject> = new DateField('ProjectStartDate', EnterpriseProject, 'Edm.DateTime')

Static representation of the projectStartDate 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<EnterpriseProject> = new StringField('ProjectUUID', EnterpriseProject, '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<EnterpriseProject> = new StringField('ResponsibleCostCenter', EnterpriseProject, '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 TO_ENTERPRISE_PROJECT_ELEMENT

TO_ENTERPRISE_PROJECT_ELEMENT: Link<EnterpriseProject, EnterpriseProjectElement> = new Link('to_EnterpriseProjectElement', EnterpriseProject, EnterpriseProjectElement)

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

Static TO_ENTERPRISE_PROJECT_JVA

TO_ENTERPRISE_PROJECT_JVA: OneToOneLink<EnterpriseProject, EnterpriseProjectJva> = new OneToOneLink('to_EnterpriseProjectJVA', EnterpriseProject, EnterpriseProjectJva)

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

Static _allFields

_allFields: Array<StringField<EnterpriseProject> | DateField<EnterpriseProject> | Link<EnterpriseProject, EnterpriseProjectElement> | OneToOneLink<EnterpriseProject, EnterpriseProjectJva>> = [EnterpriseProject.PROJECT_UUID,EnterpriseProject.PROJECT_INTERNAL_ID,EnterpriseProject.PROJECT,EnterpriseProject.PROJECT_DESCRIPTION,EnterpriseProject.ENTERPRISE_PROJECT_TYPE,EnterpriseProject.PRIORITY_CODE,EnterpriseProject.PROJECT_START_DATE,EnterpriseProject.PROJECT_END_DATE,EnterpriseProject.PROCESSING_STATUS,EnterpriseProject.RESPONSIBLE_COST_CENTER,EnterpriseProject.PROFIT_CENTER,EnterpriseProject.PROJECT_MANAGER_UUID,EnterpriseProject.PROJECT_PROFILE_CODE,EnterpriseProject.FUNCTIONAL_AREA,EnterpriseProject.COMPANY_CODE,EnterpriseProject.CONTROLLING_AREA,EnterpriseProject.PLANT,EnterpriseProject.LOCATION,EnterpriseProject.LAST_CHANGE_DATE_TIME,EnterpriseProject.TO_ENTERPRISE_PROJECT_ELEMENT,EnterpriseProject.TO_ENTERPRISE_PROJECT_JVA]

All fields of the EnterpriseProject 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_EnterpriseProject"

Technical entity name for EnterpriseProject.

Static _keyFields

_keyFields: Array<Selectable<EnterpriseProject>> = [EnterpriseProject.PROJECT_UUID]

All key fields of the EnterpriseProject entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_ENTERPRISE_PROJECT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<EnterpriseProject>

    A builder that constructs instances of entity type EnterpriseProject.

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

    Returns EnterpriseProjectRequestBuilder

    A EnterpriseProject request builder.