Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "ProjectSet" of service "/CPD/SC_EXTERNAL_SERVICES_SRV". This service is part of the following communication scenarios: Commercial Project Integration (SAP_COM_0054). See https://api.sap.com/api/SC_EXTERNAL_SERVICES_SRV for more information.

Hierarchy

  • Entity
    • ProjectSet

Implements

Index

Constructors

constructor

  • Returns ProjectSet

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 changedBy

changedBy: string

Changed By. Maximum length: 12.

nullable

Optional changedOn

changedOn: Moment

Draft Last Changed On.

nullable

Optional confidential

confidential: string

Confidential Indicator for Commercial Project. Select the checkbox to indicate that the details are confidential and can be viewed only by an authorized user. Maximum length: 1.

nullable

Optional costCenter

costCenter: string

Organization Unit Key. Maximum length: 10.

nullable

Optional costCenterName

costCenterName: string

General Name. General description of the object. Maximum length: 20.

nullable

Optional currency

currency: string

Currency. Maximum length: 5.

nullable

Optional currencyname

currencyname: string

Long Text. A text that describes the object to which it refers in greater detail. Maximum length: 40.

nullable

Optional customer

customer: string

Customer Number. Gives an alphanumeric key, which clearly identifies the customer or vendor in the SAP system. Maximum length: 10.

nullable

Optional customerName

customerName: string

Customer Name. Maximum length: 166.

nullable

Optional endDate

endDate: Moment

Commercial Project: End Date.

nullable

Optional orgDesc

orgDesc: string

Description of Organization Unit ID. The high-level organization that is responsible for a master project. Organizations are linked to organizational units in ERP through Customizing, under SAP Commercial Project Management > Master Data > Master Project > Make Settings for Organization. The currency of the default organization is used for financial planning of costs and revenues in Project Cost and Revenue Planning (CA-CPD-FP). Maximum length: 40.

nullable

Optional orgId

orgId: string

Service Organization. This field links master project data with the company code and plant. This field links master project data with the company code and plant. Maximum length: 5.

nullable

profitCenter

profitCenter: string

Profit Center. Maximum length: 10.

profitCenterName

profitCenterName: string

General Name. General description of the object. Maximum length: 20.

Optional projAccountantId

projAccountantId: string

Member ID. Maximum length: 8.

nullable

Optional projAccountantName

projAccountantName: string

Full Name. States the complete name of a person. The complete name is generally generated and saved by the Business Address Services (BAS) according to country-specific rules from the individual name components (without the form of address).If, during the formatting of an address, you want to use an alternative name, you can manually format the alternative name here. Maximum length: 80.

nullable

Optional projControllerId

projControllerId: string

Member ID. Maximum length: 8.

nullable

Optional projControllerName

projControllerName: string

Full Name. States the complete name of a person. The complete name is generally generated and saved by the Business Address Services (BAS) according to country-specific rules from the individual name components (without the form of address).If, during the formatting of an address, you want to use an alternative name, you can manually format the alternative name here. Maximum length: 80.

nullable

Optional projManagerId

projManagerId: string

Data Element For Personal Number. Maximum length: 8.

nullable

Optional projManagerName

projManagerName: string

Full Name. States the complete name of a person. The complete name is generally generated and saved by the Business Address Services (BAS) according to country-specific rules from the individual name components (without the form of address).If, during the formatting of an address, you want to use an alternative name, you can manually format the alternative name here. Maximum length: 80.

nullable

Optional projPartnerId

projPartnerId: string

Member ID. Maximum length: 8.

nullable

Optional projPartnerName

projPartnerName: string

Full Name. States the complete name of a person. The complete name is generally generated and saved by the Business Address Services (BAS) according to country-specific rules from the individual name components (without the form of address).If, during the formatting of an address, you want to use an alternative name, you can manually format the alternative name here. Maximum length: 80.

nullable

Optional projectCategory

projectCategory: string

Project Type. Maximum length: 1.

nullable

projectId

projectId: string

Commercial Project ID. Identifies a master project. Maximum length: 40.

Optional projectName

projectName: string

Customer Project Name. Maximum length: 40.

nullable

Optional projectStage

projectStage: string

Commercial Project: Stage. User-defined key for indicating stages in master projects. Maximum length: 4.

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 stageDesc

stageDesc: string

Master Project: Stage Description. Maximum length: 40.

nullable

Optional startDate

startDate: Moment

Commercial Project: Start Date.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

workpackageSet

workpackageSet: WorkpackageSet[]

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

Static ALL_FIELDS

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

All fields selector.

Static CHANGED_BY

CHANGED_BY: StringField<ProjectSet> = new StringField('ChangedBy', ProjectSet, 'Edm.String')

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

Static CHANGED_ON

CHANGED_ON: DateField<ProjectSet> = new DateField('ChangedOn', ProjectSet, 'Edm.DateTimeOffset')

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

Static CONFIDENTIAL

CONFIDENTIAL: StringField<ProjectSet> = new StringField('Confidential', ProjectSet, 'Edm.String')

Static representation of the confidential 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<ProjectSet> = new StringField('CostCenter', ProjectSet, '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 COST_CENTER_NAME

COST_CENTER_NAME: StringField<ProjectSet> = new StringField('CostCenterName', ProjectSet, 'Edm.String')

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

Static CURRENCY

CURRENCY: StringField<ProjectSet> = new StringField('Currency', ProjectSet, 'Edm.String')

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

Static CURRENCYNAME

CURRENCYNAME: StringField<ProjectSet> = new StringField('Currencyname', ProjectSet, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<ProjectSet> = new StringField('Customer', ProjectSet, 'Edm.String')

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

Static CUSTOMER_NAME

CUSTOMER_NAME: StringField<ProjectSet> = new StringField('CustomerName', ProjectSet, 'Edm.String')

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

Static END_DATE

END_DATE: DateField<ProjectSet> = new DateField('EndDate', ProjectSet, 'Edm.DateTime')

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

Static ORG_DESC

ORG_DESC: StringField<ProjectSet> = new StringField('OrgDesc', ProjectSet, 'Edm.String')

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

Static ORG_ID

ORG_ID: StringField<ProjectSet> = new StringField('OrgID', ProjectSet, 'Edm.String')

Static representation of the orgId 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<ProjectSet> = new StringField('ProfitCenter', ProjectSet, '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 PROFIT_CENTER_NAME

PROFIT_CENTER_NAME: StringField<ProjectSet> = new StringField('ProfitCenterName', ProjectSet, 'Edm.String')

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

Static PROJECT_CATEGORY

PROJECT_CATEGORY: StringField<ProjectSet> = new StringField('ProjectCategory', ProjectSet, 'Edm.String')

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

Static PROJECT_ID

PROJECT_ID: StringField<ProjectSet> = new StringField('ProjectID', ProjectSet, 'Edm.String')

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

Static PROJECT_NAME

PROJECT_NAME: StringField<ProjectSet> = new StringField('ProjectName', ProjectSet, 'Edm.String')

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

Static PROJECT_STAGE

PROJECT_STAGE: StringField<ProjectSet> = new StringField('ProjectStage', ProjectSet, 'Edm.String')

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

Static PROJ_ACCOUNTANT_ID

PROJ_ACCOUNTANT_ID: StringField<ProjectSet> = new StringField('ProjAccountantId', ProjectSet, 'Edm.String')

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

Static PROJ_ACCOUNTANT_NAME

PROJ_ACCOUNTANT_NAME: StringField<ProjectSet> = new StringField('ProjAccountantName', ProjectSet, 'Edm.String')

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

Static PROJ_CONTROLLER_ID

PROJ_CONTROLLER_ID: StringField<ProjectSet> = new StringField('ProjControllerId', ProjectSet, 'Edm.String')

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

Static PROJ_CONTROLLER_NAME

PROJ_CONTROLLER_NAME: StringField<ProjectSet> = new StringField('ProjControllerName', ProjectSet, 'Edm.String')

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

Static PROJ_MANAGER_ID

PROJ_MANAGER_ID: StringField<ProjectSet> = new StringField('ProjManagerId', ProjectSet, 'Edm.String')

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

Static PROJ_MANAGER_NAME

PROJ_MANAGER_NAME: StringField<ProjectSet> = new StringField('ProjManagerName', ProjectSet, 'Edm.String')

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

Static PROJ_PARTNER_ID

PROJ_PARTNER_ID: StringField<ProjectSet> = new StringField('ProjPartnerId', ProjectSet, 'Edm.String')

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

Static PROJ_PARTNER_NAME

PROJ_PARTNER_NAME: StringField<ProjectSet> = new StringField('ProjPartnerName', ProjectSet, 'Edm.String')

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

Static STAGE_DESC

STAGE_DESC: StringField<ProjectSet> = new StringField('StageDesc', ProjectSet, 'Edm.String')

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

Static START_DATE

START_DATE: DateField<ProjectSet> = new DateField('StartDate', ProjectSet, 'Edm.DateTime')

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

Static WORKPACKAGE_SET

WORKPACKAGE_SET: Link<ProjectSet, WorkpackageSet> = new Link('WorkpackageSet', ProjectSet, WorkpackageSet)

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

Static _allFields

_allFields: Array<StringField<ProjectSet> | DateField<ProjectSet> | Link<ProjectSet, WorkpackageSet>> = [ProjectSet.CHANGED_BY,ProjectSet.PROFIT_CENTER,ProjectSet.CHANGED_ON,ProjectSet.PROFIT_CENTER_NAME,ProjectSet.PROJECT_ID,ProjectSet.PROJECT_NAME,ProjectSet.PROJECT_STAGE,ProjectSet.STAGE_DESC,ProjectSet.START_DATE,ProjectSet.END_DATE,ProjectSet.CUSTOMER,ProjectSet.CUSTOMER_NAME,ProjectSet.PROJ_MANAGER_ID,ProjectSet.PROJ_MANAGER_NAME,ProjectSet.PROJ_ACCOUNTANT_ID,ProjectSet.PROJ_ACCOUNTANT_NAME,ProjectSet.PROJ_CONTROLLER_ID,ProjectSet.PROJ_CONTROLLER_NAME,ProjectSet.PROJ_PARTNER_ID,ProjectSet.PROJ_PARTNER_NAME,ProjectSet.COST_CENTER,ProjectSet.COST_CENTER_NAME,ProjectSet.PROJECT_CATEGORY,ProjectSet.CURRENCY,ProjectSet.CURRENCYNAME,ProjectSet.ORG_ID,ProjectSet.ORG_DESC,ProjectSet.CONFIDENTIAL,ProjectSet.WORKPACKAGE_SET]

All fields of the ProjectSet entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/cpd/SC_EXTERNAL_SERVICES_SRV"

Default url path for the according service.

Static _entityName

_entityName: string = "ProjectSet"

Technical entity name for ProjectSet.

Static _keyFields

_keyFields: Array<Selectable<ProjectSet>> = [ProjectSet.PROJECT_ID]

All key fields of the ProjectSet entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "/CPD/SC_EXTERNAL_SERVICES_SRV"
deprecated

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

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

  • Returns an entity builder to construct instances ProjectSet.

    Returns EntityBuilderType<ProjectSet, ProjectSetType>

    A builder that constructs instances of entity type ProjectSet.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProjectSet>

    A builder that constructs instances of entity type ProjectSet.

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

    Returns ProjectSetRequestBuilder

    A ProjectSet request builder.