Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_EntProjectElementJVA" 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
    • EntProjectElementJva

Implements

Index

Constructors

constructor

  • Returns EntProjectElementJva

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 controllingArea

controllingArea: string

Controlling Area. Maximum length: 4.

nullable

Optional jntIntrstBillgClass

jntIntrstBillgClass: string

JIB/JIBE Class. Maximum length: 3.

nullable

Optional jntIntrstBillgSubClass

jntIntrstBillgSubClass: string

JIB/JIBE Subclass A. Maximum length: 5.

nullable

Optional jntVntrProjectType

jntVntrProjectType: string

Joint Venture Object Type. Maximum length: 4.

nullable

Optional jointVenture

jointVenture: string

Joint venture. A joint venture in the SAP System is a summarization of cost objects whose costs are split up among partners. A joint venture is usually lead by an operating authority, who is responsible for the costs incurred. At the end of a period, all of the costs incurred are split up and allocated to the partners involved.Joint ventures are created to keep costs as low as possible for the operating authority and the partners. This is achieved by distributing the costs incurred to the participants of the joint venture.In the oil industry, new drill-holes are seldomly controlled by the oil companies alone. Instead, contracts are made with other companies. The contract regulates the costs incurred. This enables the risks involved with an unsuccessful drill-hole to be spread out over several companies.Of course, the anticipated profits (from a rich drill-hole) are also distributed to the partners involved. However, the distribution of the profits is not carried out by the SAP Joint Venture Accounting solution. Maximum length: 6.

nullable

Optional jointVentureCostRecoveryCode

jointVentureCostRecoveryCode: string

Recovery Indicator. In global companies that belong to joint ventures, incurred costs are usually shared among different recovery indicators which can then be dealt with in different ways using the periodic settlement program. You can define recovery indicators at three different levels:o Document typeYou can assign a recovery indicator to each document type for thecredit side and for the debit side. These recovery indicators areinternal recovery indicators and are defined in a separate systemtable.o Cost element (primary and secondary)o Cost objectWhen you make a posting in one of the feeder systems of the Joint Venture Accounting System, all three levels are evaluated in the sequence defined. The first recovery indicator found is transferred to the Joint Venture Accounting System.o Costs that are 100% allocableo Costs borne 100% by the operatoro Overheads applied by the operatoro Costs which exceed a contractually agreed price and cannot thereforebe allocatedo Costs already allocated. Maximum length: 2.

nullable

Optional jointVentureEquityType

jointVentureEquityType: string

Equity type. Maximum length: 3.

nullable

Optional profitCenter

profitCenter: string

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

nullable

projectElementUuid

projectElementUuid: string

Entity Guid.

Optional projectLastChangedDateTime

projectLastChangedDateTime: Moment

Date on which object was last changed.

nullable

Optional projectUuid

projectUuid: 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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsElementInternalId

wbsElementInternalId: string

WBS Element. Key that identifies a WBS element. Maximum length: 24.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CONTROLLING_AREA

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

JNT_INTRST_BILLG_CLASS: StringField<EntProjectElementJva> = new StringField('JntIntrstBillgClass', EntProjectElementJva, 'Edm.String')

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

Static JNT_INTRST_BILLG_SUB_CLASS

JNT_INTRST_BILLG_SUB_CLASS: StringField<EntProjectElementJva> = new StringField('JntIntrstBillgSubClass', EntProjectElementJva, 'Edm.String')

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

Static JNT_VNTR_PROJECT_TYPE

JNT_VNTR_PROJECT_TYPE: StringField<EntProjectElementJva> = new StringField('JntVntrProjectType', EntProjectElementJva, 'Edm.String')

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

Static JOINT_VENTURE

JOINT_VENTURE: StringField<EntProjectElementJva> = new StringField('JointVenture', EntProjectElementJva, 'Edm.String')

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

Static JOINT_VENTURE_COST_RECOVERY_CODE

JOINT_VENTURE_COST_RECOVERY_CODE: StringField<EntProjectElementJva> = new StringField('JointVentureCostRecoveryCode', EntProjectElementJva, 'Edm.String')

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

Static JOINT_VENTURE_EQUITY_TYPE

JOINT_VENTURE_EQUITY_TYPE: StringField<EntProjectElementJva> = new StringField('JointVentureEquityType', EntProjectElementJva, 'Edm.String')

Static representation of the jointVentureEquityType 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<EntProjectElementJva> = new StringField('ProfitCenter', EntProjectElementJva, '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_UUID

PROJECT_ELEMENT_UUID: StringField<EntProjectElementJva> = new StringField('ProjectElementUUID', EntProjectElementJva, '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<EntProjectElementJva> = new DateField('ProjectLastChangedDateTime', EntProjectElementJva, '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<EntProjectElementJva> = new StringField('ProjectUUID', EntProjectElementJva, '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 WBS_ELEMENT_INTERNAL_ID

WBS_ELEMENT_INTERNAL_ID: StringField<EntProjectElementJva> = new StringField('WBSElementInternalID', EntProjectElementJva, '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 _allFields

_allFields: Array<StringField<EntProjectElementJva> | DateField<EntProjectElementJva>> = [EntProjectElementJva.PROJECT_ELEMENT_UUID,EntProjectElementJva.WBS_ELEMENT_INTERNAL_ID,EntProjectElementJva.PROJECT_UUID,EntProjectElementJva.CONTROLLING_AREA,EntProjectElementJva.PROFIT_CENTER,EntProjectElementJva.JOINT_VENTURE,EntProjectElementJva.JOINT_VENTURE_COST_RECOVERY_CODE,EntProjectElementJva.JOINT_VENTURE_EQUITY_TYPE,EntProjectElementJva.JNT_VNTR_PROJECT_TYPE,EntProjectElementJva.JNT_INTRST_BILLG_CLASS,EntProjectElementJva.JNT_INTRST_BILLG_SUB_CLASS,EntProjectElementJva.PROJECT_LAST_CHANGED_DATE_TIME]

All fields of the EntProjectElementJva 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_EntProjectElementJVA"

Technical entity name for EntProjectElementJva.

Static _keyFields

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

All key fields of the EntProjectElementJva entity.

Static _keys

_keys: any = EntProjectElementJva._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_ENTERPRISE_PROJECT_SRV"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<EntProjectElementJva>

    A builder that constructs instances of entity type EntProjectElementJva.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the EntProjectElementJva entity type.

    Returns EntProjectElementJvaRequestBuilder

    A EntProjectElementJva request builder.