Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implements

Index

Constructors

constructor

  • Returns ZoneAdjustments

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 bufPrpslZoneAdjmtFctrEndDate

bufPrpslZoneAdjmtFctrEndDate: Moment

Proposal Zones Valid To.

nullable

bufPrpslZoneAdjmtFctrStartDate

bufPrpslZoneAdjmtFctrStartDate: Moment

Proposal Zones Valid From.

Optional greenZoneAdjustmentFactor

greenZoneAdjustmentFactor: BigNumber

Adjustment Factor for Green Zone.

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.

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.

Optional redZoneAdjustmentFactor

redZoneAdjustmentFactor: BigNumber

Adjustment Factor for Red Zone.

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

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

Optional yellowZoneAdjustmentFactor

yellowZoneAdjustmentFactor: BigNumber

Adjustment Factor for Yellow Zone.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BUF_PRPSL_ZONE_ADJMT_FCTR_END_DATE

BUF_PRPSL_ZONE_ADJMT_FCTR_END_DATE: DateField<ZoneAdjustments> = new DateField('BufPrpslZoneAdjmtFctrEndDate', ZoneAdjustments, 'Edm.DateTime')

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

Static BUF_PRPSL_ZONE_ADJMT_FCTR_START_DATE

BUF_PRPSL_ZONE_ADJMT_FCTR_START_DATE: DateField<ZoneAdjustments> = new DateField('BufPrpslZoneAdjmtFctrStartDate', ZoneAdjustments, 'Edm.DateTime')

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

Static GREEN_ZONE_ADJUSTMENT_FACTOR

GREEN_ZONE_ADJUSTMENT_FACTOR: BigNumberField<ZoneAdjustments> = new BigNumberField('GreenZoneAdjustmentFactor', ZoneAdjustments, 'Edm.Decimal')

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

Static MATERIAL

MATERIAL: StringField<ZoneAdjustments> = new StringField('Material', ZoneAdjustments, '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<ZoneAdjustments> = new StringField('MRPArea', ZoneAdjustments, '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 PLANT

PLANT: StringField<ZoneAdjustments> = new StringField('Plant', ZoneAdjustments, '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<ZoneAdjustments> = new DateField('ProposalStartDate', ZoneAdjustments, '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<ZoneAdjustments> = new StringField('ProposalVersion', ZoneAdjustments, '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 RED_ZONE_ADJUSTMENT_FACTOR

RED_ZONE_ADJUSTMENT_FACTOR: BigNumberField<ZoneAdjustments> = new BigNumberField('RedZoneAdjustmentFactor', ZoneAdjustments, 'Edm.Decimal')

Static representation of the redZoneAdjustmentFactor 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<ZoneAdjustments, ProposalHeader> = new OneToOneLink('to_ProposalHdr', ZoneAdjustments, 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 YELLOW_ZONE_ADJUSTMENT_FACTOR

YELLOW_ZONE_ADJUSTMENT_FACTOR: BigNumberField<ZoneAdjustments> = new BigNumberField('YellowZoneAdjustmentFactor', ZoneAdjustments, 'Edm.Decimal')

Static representation of the yellowZoneAdjustmentFactor 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<ZoneAdjustments> | DateField<ZoneAdjustments> | BigNumberField<ZoneAdjustments> | OneToOneLink<ZoneAdjustments, ProposalHeader>> = [ZoneAdjustments.MATERIAL,ZoneAdjustments.PLANT,ZoneAdjustments.MRP_AREA,ZoneAdjustments.PROPOSAL_START_DATE,ZoneAdjustments.PROPOSAL_VERSION,ZoneAdjustments.BUF_PRPSL_ZONE_ADJMT_FCTR_START_DATE,ZoneAdjustments.BUF_PRPSL_ZONE_ADJMT_FCTR_END_DATE,ZoneAdjustments.RED_ZONE_ADJUSTMENT_FACTOR,ZoneAdjustments.YELLOW_ZONE_ADJUSTMENT_FACTOR,ZoneAdjustments.GREEN_ZONE_ADJUSTMENT_FACTOR,ZoneAdjustments.TO_PROPOSAL_HDR]

All fields of the ZoneAdjustments entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ZoneAdjustments"

Technical entity name for ZoneAdjustments.

Static _keyFields

_keyFields: Array<Selectable<ZoneAdjustments>> = [ZoneAdjustments.MATERIAL, ZoneAdjustments.PLANT, ZoneAdjustments.MRP_AREA, ZoneAdjustments.PROPOSAL_START_DATE, ZoneAdjustments.PROPOSAL_VERSION, ZoneAdjustments.BUF_PRPSL_ZONE_ADJMT_FCTR_START_DATE]

All key fields of the ZoneAdjustments entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_buffersizing_srv"
deprecated

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

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

    Returns EntityBuilderType<ZoneAdjustments, ZoneAdjustmentsType>

    A builder that constructs instances of entity type ZoneAdjustments.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ZoneAdjustments.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ZoneAdjustments>

    A builder that constructs instances of entity type ZoneAdjustments.

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

    Returns ZoneAdjustmentsRequestBuilder

    A ZoneAdjustments request builder.