Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implements

Index

Constructors

constructor

  • Returns WorkpackageSet

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: undefined | string

Changed By. Maximum length: 12.

nullable

Optional changedOn

changedOn: Moment

Draft Last Changed On.

nullable

planDataSet

planDataSet: PlanDataSet[]

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

Optional projectId

projectId: undefined | string

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

nullable

Optional projectName

projectName: undefined | string

Customer Project Name. Maximum length: 40.

nullable

quantity

quantity: string

Total Quantity. Total quantity per period. Maximum length: 15.

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

unitOfMeasure

unitOfMeasure: string

Unit of Measurement Text (Maximum 30 Characters). Name of unit of measurement. Maximum length: 30.

workItemSet

workItemSet: WorkItemSet[]

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

workPackageId

workPackageId: string

Plan Item. Maximum length: 50.

Optional workPackageName

workPackageName: undefined | string

Plan Item Description. Maximum length: 60.

nullable

workPackageType

workPackageType: string

Work Package Type. Indicates the type of service planned in a work package. You can use the following values to indicate the type of service planned in the work package:' ' - Time based servicesU - Unit based services. Maximum length: 1.

workPackageUnitText

workPackageUnitText: string

Resource Description. Maximum length: 40.

Optional wpEndDate

wpEndDate: Moment

End Date. Raw Text Provides the planning horizon. By default, the dates are taken from the assigned master project.

nullable

Optional wpStartDate

wpStartDate: Moment

Start Date. Raw Text Provides the planning horizon. By default, the dates are taken from the assigned master project.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CHANGED_BY

CHANGED_BY: StringField<WorkpackageSet> = new StringField('ChangedBy', WorkpackageSet, '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<WorkpackageSet> = new DateField('ChangedOn', WorkpackageSet, '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 PLAN_DATA_SET

PLAN_DATA_SET: Link<WorkpackageSet, PlanDataSet> = new Link('PlanDataSet', WorkpackageSet, PlanDataSet)

Static representation of the one-to-many navigation property planDataSet 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<WorkpackageSet> = new StringField('ProjectID', WorkpackageSet, '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<WorkpackageSet> = new StringField('ProjectName', WorkpackageSet, '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 QUANTITY

QUANTITY: StringField<WorkpackageSet> = new StringField('Quantity', WorkpackageSet, 'Edm.String')

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

Static UNIT_OF_MEASURE

UNIT_OF_MEASURE: StringField<WorkpackageSet> = new StringField('UnitOfMeasure', WorkpackageSet, 'Edm.String')

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

Static WORK_ITEM_SET

WORK_ITEM_SET: Link<WorkpackageSet, WorkItemSet> = new Link('WorkItemSet', WorkpackageSet, WorkItemSet)

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

Static WORK_PACKAGE_ID

WORK_PACKAGE_ID: StringField<WorkpackageSet> = new StringField('WorkPackageID', WorkpackageSet, 'Edm.String')

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

Static WORK_PACKAGE_NAME

WORK_PACKAGE_NAME: StringField<WorkpackageSet> = new StringField('WorkPackageName', WorkpackageSet, 'Edm.String')

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

Static WORK_PACKAGE_TYPE

WORK_PACKAGE_TYPE: StringField<WorkpackageSet> = new StringField('WorkPackageType', WorkpackageSet, 'Edm.String')

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

Static WORK_PACKAGE_UNIT_TEXT

WORK_PACKAGE_UNIT_TEXT: StringField<WorkpackageSet> = new StringField('WorkPackageUnitText', WorkpackageSet, 'Edm.String')

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

Static WP_END_DATE

WP_END_DATE: DateField<WorkpackageSet> = new DateField('WPEndDate', WorkpackageSet, 'Edm.DateTime')

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

Static WP_START_DATE

WP_START_DATE: DateField<WorkpackageSet> = new DateField('WPStartDate', WorkpackageSet, 'Edm.DateTime')

Static representation of the wpStartDate 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<WorkpackageSet> | DateField<WorkpackageSet> | Link<WorkpackageSet, WorkItemSet> | Link<WorkpackageSet, PlanDataSet>> = [WorkpackageSet.WORK_PACKAGE_UNIT_TEXT,WorkpackageSet.WORK_PACKAGE_TYPE,WorkpackageSet.UNIT_OF_MEASURE,WorkpackageSet.QUANTITY,WorkpackageSet.CHANGED_ON,WorkpackageSet.PROJECT_ID,WorkpackageSet.CHANGED_BY,WorkpackageSet.WORK_PACKAGE_ID,WorkpackageSet.WORK_PACKAGE_NAME,WorkpackageSet.WP_START_DATE,WorkpackageSet.WP_END_DATE,WorkpackageSet.PROJECT_NAME,WorkpackageSet.WORK_ITEM_SET,WorkpackageSet.PLAN_DATA_SET]

All fields of the WorkpackageSet entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "WorkpackageSet"

Technical entity name for WorkpackageSet.

Static _keyFields

_keyFields: Array<Selectable<WorkpackageSet>> = [WorkpackageSet.WORK_PACKAGE_ID]

All key fields of the WorkpackageSet entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "CPD_SC_EXTERNAL_SERVICES_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WorkpackageSet>

    A builder that constructs instances of entity type WorkpackageSet.

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

    Returns WorkpackageSetRequestBuilder

    A WorkpackageSet request builder.