Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "Project" of service "API_GRMASTERDATA_SRV". This service is part of the following communication scenarios: Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241), Finance - Group Reporting Planning Integration (SAP_COM_0370). See https://api.sap.com/api/API_GRMASTERDATA_SRV for more information.

Hierarchy

  • Entity
    • Project

Implements

Index

Constructors

constructor

  • Returns Project

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 additionalMasterDataSource

additionalMasterDataSource: undefined | string

Master Data Source. Maximum length: 10.

nullable

project

project: string

Project Definition. Key identifying a project definition. Maximum length: 24.

Optional projectText

projectText: undefined | string

Project Definition Description. Maximum length: 40.

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

toCnsldtnProjectHier

toCnsldtnProjectHier: ProjectHier[]

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

toCnsldtnProjectT

toCnsldtnProjectT: ProjectText[]

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

Static ADDITIONAL_MASTER_DATA_SOURCE

ADDITIONAL_MASTER_DATA_SOURCE: StringField<Project> = new StringField('AdditionalMasterDataSource', Project, 'Edm.String')

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

All fields selector.

Static PROJECT

PROJECT: StringField<Project> = new StringField('Project', Project, '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_TEXT

PROJECT_TEXT: StringField<Project> = new StringField('Project_Text', Project, 'Edm.String')

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

Static TO_CNSLDTN_PROJECT_HIER

TO_CNSLDTN_PROJECT_HIER: Link<Project, ProjectHier> = new Link('to_CnsldtnProjectHier', Project, ProjectHier)

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

Static TO_CNSLDTN_PROJECT_T

TO_CNSLDTN_PROJECT_T: Link<Project, ProjectText> = new Link('to_CnsldtnProjectT', Project, ProjectText)

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

Static _allFields

_allFields: Array<StringField<Project> | Link<Project, ProjectHier> | Link<Project, ProjectText>> = [Project.PROJECT,Project.PROJECT_TEXT,Project.ADDITIONAL_MASTER_DATA_SOURCE,Project.TO_CNSLDTN_PROJECT_HIER,Project.TO_CNSLDTN_PROJECT_T]

All fields of the Project entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "Project"

Technical entity name for Project.

Static _keyFields

_keyFields: Array<Selectable<Project>> = [Project.PROJECT]

All key fields of the Project entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_GRMASTERDATA_SRV"
deprecated

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

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

  • Returns an entity builder to construct instances Project.

    Returns EntityBuilderType<Project, ProjectTypeForceMandatory>

    A builder that constructs instances of entity type Project.

Static customField

  • customField(fieldName: string): CustomField<Project>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity Project.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Project>

    A builder that constructs instances of entity type Project.

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

    Returns ProjectRequestBuilder

    A Project request builder.