Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_LongestPathInBOM" of service "cds_api_buffersizing_srv". This service is part of the following communication scenarios: Buffer Sizing Integration (SAP_COM_0359). See https://api.sap.com/api/API_BUFFERSIZING_SRV for more information.

Hierarchy

  • Entity
    • LongestPathInBom

Implements

Index

Constructors

constructor

  • Returns LongestPathInBom

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 "*".

billOfMaterialComponent

billOfMaterialComponent: string

BOM component. Material number of the components that you enter, change or display as part of the BOM. A master record is usually maintained in the system for a component. Maximum length: 18.

billOfMaterialUuid

billOfMaterialUuid: string

Internal Key for BOMID.

Optional componentLeadTime

componentLeadTime: BigNumber

Individual Lead Time in Days.

nullable

Optional componentMrpArea

componentMrpArea: string

Component MRP Area. Maximum length: 10.

nullable

componentPlant

componentPlant: string

Component Plant. Maximum length: 4.

Optional componentSos

componentSos: string

Source of Supply. Maximum length: 20.

nullable

Optional componentSosType

componentSosType: string

Source Type. Maximum length: 5.

nullable

Optional leadTimeCalculationMethod

leadTimeCalculationMethod: string

Indicator to show method of Lead Time calculation. Maximum length: 8.

nullable

material

material: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 18.

mrpArea

mrpArea: string

MRP Area. Number of the MRP area for which material requirements planning should be carried out separately. Maximum length: 10.

parentComponent

parentComponent: string

Parent BOM Component. Maximum length: 18.

Optional parentMrpArea

parentMrpArea: string

Parent MRP Area. Maximum length: 10.

nullable

parentPlant

parentPlant: string

Parent Plant. Maximum length: 4.

plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

proposalStartDate

proposalStartDate: Moment

Proposal Validity From Date.

proposalVersion

proposalVersion: string

Proposal Version. Maximum length: 8.

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 sosTypeDescription

sosTypeDescription: string

Short Text for Fixed Values. This text appears when fixed values are displayed in the F4 help. It explains the possible input values. SeeTask-Oriented InstructionsReference Documentation for Semantic Properties of Domains. Maximum length: 60.

nullable

toProposalHdr

toProposalHdr: ProposalHeader

One-to-one navigation property to the ProposalHeader entity.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static BILL_OF_MATERIAL_COMPONENT

BILL_OF_MATERIAL_COMPONENT: StringField<LongestPathInBom> = new StringField('BillOfMaterialComponent', LongestPathInBom, 'Edm.String')

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

Static BILL_OF_MATERIAL_UUID

BILL_OF_MATERIAL_UUID: StringField<LongestPathInBom> = new StringField('BillOfMaterialUUID', LongestPathInBom, 'Edm.Guid')

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

Static COMPONENT_LEAD_TIME

COMPONENT_LEAD_TIME: BigNumberField<LongestPathInBom> = new BigNumberField('ComponentLeadTime', LongestPathInBom, 'Edm.Decimal')

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

Static COMPONENT_MRP_AREA

COMPONENT_MRP_AREA: StringField<LongestPathInBom> = new StringField('ComponentMRPArea', LongestPathInBom, 'Edm.String')

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

Static COMPONENT_PLANT

COMPONENT_PLANT: StringField<LongestPathInBom> = new StringField('ComponentPlant', LongestPathInBom, 'Edm.String')

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

Static COMPONENT_SOS

COMPONENT_SOS: StringField<LongestPathInBom> = new StringField('ComponentSOS', LongestPathInBom, 'Edm.String')

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

Static COMPONENT_SOS_TYPE

COMPONENT_SOS_TYPE: StringField<LongestPathInBom> = new StringField('ComponentSOSType', LongestPathInBom, 'Edm.String')

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

Static LEAD_TIME_CALCULATION_METHOD

LEAD_TIME_CALCULATION_METHOD: StringField<LongestPathInBom> = new StringField('LeadTimeCalculationMethod', LongestPathInBom, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<LongestPathInBom> = new StringField('Material', LongestPathInBom, 'Edm.String')

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

Static MRP_AREA

MRP_AREA: StringField<LongestPathInBom> = new StringField('MRPArea', LongestPathInBom, 'Edm.String')

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

Static PARENT_COMPONENT

PARENT_COMPONENT: StringField<LongestPathInBom> = new StringField('ParentComponent', LongestPathInBom, 'Edm.String')

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

Static PARENT_MRP_AREA

PARENT_MRP_AREA: StringField<LongestPathInBom> = new StringField('ParentMRPArea', LongestPathInBom, 'Edm.String')

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

Static PARENT_PLANT

PARENT_PLANT: StringField<LongestPathInBom> = new StringField('ParentPlant', LongestPathInBom, 'Edm.String')

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

Static PLANT

PLANT: StringField<LongestPathInBom> = new StringField('Plant', LongestPathInBom, 'Edm.String')

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

Static PROPOSAL_START_DATE

PROPOSAL_START_DATE: DateField<LongestPathInBom> = new DateField('ProposalStartDate', LongestPathInBom, 'Edm.DateTime')

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

Static PROPOSAL_VERSION

PROPOSAL_VERSION: StringField<LongestPathInBom> = new StringField('ProposalVersion', LongestPathInBom, 'Edm.String')

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

Static SOS_TYPE_DESCRIPTION

SOS_TYPE_DESCRIPTION: StringField<LongestPathInBom> = new StringField('SOSTypeDescription', LongestPathInBom, 'Edm.String')

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

Static TO_PROPOSAL_HDR

TO_PROPOSAL_HDR: OneToOneLink<LongestPathInBom, ProposalHeader> = new OneToOneLink('to_ProposalHdr', LongestPathInBom, ProposalHeader)

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

Static _allFields

_allFields: Array<StringField<LongestPathInBom> | DateField<LongestPathInBom> | BigNumberField<LongestPathInBom> | OneToOneLink<LongestPathInBom, ProposalHeader>> = [LongestPathInBom.MATERIAL,LongestPathInBom.PLANT,LongestPathInBom.MRP_AREA,LongestPathInBom.PROPOSAL_START_DATE,LongestPathInBom.PROPOSAL_VERSION,LongestPathInBom.BILL_OF_MATERIAL_UUID,LongestPathInBom.PARENT_COMPONENT,LongestPathInBom.PARENT_PLANT,LongestPathInBom.BILL_OF_MATERIAL_COMPONENT,LongestPathInBom.COMPONENT_PLANT,LongestPathInBom.PARENT_MRP_AREA,LongestPathInBom.COMPONENT_MRP_AREA,LongestPathInBom.COMPONENT_LEAD_TIME,LongestPathInBom.LEAD_TIME_CALCULATION_METHOD,LongestPathInBom.COMPONENT_SOS,LongestPathInBom.COMPONENT_SOS_TYPE,LongestPathInBom.SOS_TYPE_DESCRIPTION,LongestPathInBom.TO_PROPOSAL_HDR]

All fields of the LongestPathInBom entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_LongestPathInBOM"

Technical entity name for LongestPathInBom.

Static _keyFields

_keyFields: Array<Selectable<LongestPathInBom>> = [LongestPathInBom.MATERIAL, LongestPathInBom.PLANT, LongestPathInBom.MRP_AREA, LongestPathInBom.PROPOSAL_START_DATE, LongestPathInBom.PROPOSAL_VERSION, LongestPathInBom.BILL_OF_MATERIAL_UUID, LongestPathInBom.PARENT_COMPONENT, LongestPathInBom.PARENT_PLANT, LongestPathInBom.BILL_OF_MATERIAL_COMPONENT, LongestPathInBom.COMPONENT_PLANT]

All key fields of the LongestPathInBom entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_buffersizing_srv"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<LongestPathInBom>

    A builder that constructs instances of entity type LongestPathInBom.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns LongestPathInBomRequestBuilder

    A LongestPathInBom request builder.