Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_EntProjectPublicSector" 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
    • EntProjectPublicSector

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 functionalAreaIsFixAssigned

functionalAreaIsFixAssigned: undefined | false | true

Indicator for Functional Area with Fixed Assignment.

nullable

Optional fund

fund: undefined | string

Fund. Key which uniquely identifies the fund. If you assign the budget to a fund, you can obtain a detailed list of origin for the amounts involved. Maximum length: 10.

nullable

Optional fundIsFixAssigned

fundIsFixAssigned: undefined | false | true

Indicator for Fund with Fixed Assignment.

nullable

Optional grantId

grantId: undefined | string

Grant. Legal instrument used to establish a funding relationship between a sponsor (grantor) and grantee, in order to carry out a public purpose of support or stimulation in which the sponsor does not expect to be substantially involved. A grant may be for any purpose and cover all or only part of the costs of the project in question. You must enter a grant type for each grant you create in Grants Management (GM).The grant as an object has a finite lifecycle, divided into stages. Each stage is represented in the GM solution by a system status. The following are the stages of a grant's lifecycle:Initial DraftThis is the first stage of a grant. It is a working copy that can be modified as many times as needed.ProposalWhen the initial draft becomes a formal and complete document, it becomes a proposal.ApplicationWhen a proposal is routed to the sponsor for approval, it becomes an application. This application might contain changes in the budget or other adjustments.AwardIf the sponsor approves an application, an award is created. This is the real operative stage of a grant. The creation and consumption of the grant's budget occurs at this stage. This stage also represents the binding contract between the sponsor and the grantee.ClosingWhen an award is expiring, a phase of closing is established. Only restricted operations can be performed in this stage.ClosedThis stage defines an expired and closed grant. No further operations are allowed except archiving. Maximum length: 20.

nullable

Optional grantIsFixAssigned

grantIsFixAssigned: undefined | false | true

Indicator for Grant with Fixed Assignment.

nullable

Optional projectLastChangedDateTime

projectLastChangedDateTime: Moment

Timestamp on which object was last changed.

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

Static ALL_FIELDS

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

All fields selector.

Static FUNCTIONAL_AREA_IS_FIX_ASSIGNED

FUNCTIONAL_AREA_IS_FIX_ASSIGNED: BooleanField<EntProjectPublicSector> = new BooleanField('FunctionalAreaIsFixAssigned', EntProjectPublicSector, 'Edm.Boolean')

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

Static FUND

FUND: StringField<EntProjectPublicSector> = new StringField('Fund', EntProjectPublicSector, 'Edm.String')

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

Static FUND_IS_FIX_ASSIGNED

FUND_IS_FIX_ASSIGNED: BooleanField<EntProjectPublicSector> = new BooleanField('FundIsFixAssigned', EntProjectPublicSector, 'Edm.Boolean')

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

Static GRANT_ID

GRANT_ID: StringField<EntProjectPublicSector> = new StringField('GrantID', EntProjectPublicSector, 'Edm.String')

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

Static GRANT_IS_FIX_ASSIGNED

GRANT_IS_FIX_ASSIGNED: BooleanField<EntProjectPublicSector> = new BooleanField('GrantIsFixAssigned', EntProjectPublicSector, 'Edm.Boolean')

Static representation of the grantIsFixAssigned 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<EntProjectPublicSector> = new DateField('ProjectLastChangedDateTime', EntProjectPublicSector, '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<EntProjectPublicSector> = new StringField('ProjectUUID', EntProjectPublicSector, '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 _allFields

_allFields: Array<StringField<EntProjectPublicSector> | BooleanField<EntProjectPublicSector> | DateField<EntProjectPublicSector>> = [EntProjectPublicSector.PROJECT_UUID,EntProjectPublicSector.FUND,EntProjectPublicSector.FUND_IS_FIX_ASSIGNED,EntProjectPublicSector.FUNCTIONAL_AREA_IS_FIX_ASSIGNED,EntProjectPublicSector.GRANT_ID,EntProjectPublicSector.GRANT_IS_FIX_ASSIGNED,EntProjectPublicSector.PROJECT_LAST_CHANGED_DATE_TIME]

All fields of the EntProjectPublicSector 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_EntProjectPublicSector"

Technical entity name for EntProjectPublicSector.

Static _keyFields

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

All key fields of the EntProjectPublicSector entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_ENTERPRISE_PROJECT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<EntProjectPublicSector>

    A builder that constructs instances of entity type EntProjectPublicSector.

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

    Returns EntProjectPublicSectorRequestBuilder

    A EntProjectPublicSector request builder.