Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BusVolFldCombnTypeFldAssgmt" of service "API_CONDITION_CONTRACT_TYPE". This service is part of the following communication scenarios: Logistics - Condition Contract Integration (SAP_COM_0335). See https://api.sap.com/api/API_CONDITION_CONTRACT_TYPE for more information.

Hierarchy

  • Entity
    • BusVolFldCombnTypeFldAssgmt

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

busVolFieldCombnType

busVolFieldCombnType: string

Field Combination for the Business Volume Selection. Contains one or multiple fields that serve as selection criteria for the business volume data selection from the business volume table. Field combinations are grouped to a set of field combinations which you then assign to a condition contract type.For the settlement of a condition contract, you enter concrete values for the selection criteria according to field combinations on the Business Volume Selection Criteria tab page in the condition contract's header area.Different lines for a field combination that you have entered in the condition contract are considered with an OR logic in the selection condition for the business volume data selection (WHERE clause).When entering a new line with selection criteria, you also specify with the Status Including / Excluding indicator whether this field combination will be treated as Include or Exclude statement for the WHERE clause in business volume data selection.You have defined a field combination including the fields for a supplier (LIFNR) and a material (MATNR). If you use this field combination in a condition contract you can enter lines as followsLIFNR MATNRSUPPLIER_1 MATERIAL_ASUPPLIER_1 MATERIAL_BSUPPLIER_2 MATERIAL_ASUPPLIER_2 MATERIAL_B. Maximum length: 4.

busVolFldCombnExtFieldName

busVolFldCombnExtFieldName: string

External Fieldname (GFN). Maximum length: 30.

Optional busVolFldCombnFldInitIsAllwd

busVolFldCombnFldInitIsAllwd: undefined | false | true

Initial Values allowed. Initial values for the field in the field combination of the business volume base are allowed only if this flag is active.

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

Static ALL_FIELDS

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

All fields selector.

Static BUS_VOL_FIELD_COMBN_TYPE

BUS_VOL_FIELD_COMBN_TYPE: StringField<BusVolFldCombnTypeFldAssgmt> = new StringField('BusVolFieldCombnType', BusVolFldCombnTypeFldAssgmt, 'Edm.String')

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

Static BUS_VOL_FLD_COMBN_EXT_FIELD_NAME

BUS_VOL_FLD_COMBN_EXT_FIELD_NAME: StringField<BusVolFldCombnTypeFldAssgmt> = new StringField('BusVolFldCombnExtFieldName', BusVolFldCombnTypeFldAssgmt, 'Edm.String')

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

Static BUS_VOL_FLD_COMBN_FLD_INIT_IS_ALLWD

BUS_VOL_FLD_COMBN_FLD_INIT_IS_ALLWD: BooleanField<BusVolFldCombnTypeFldAssgmt> = new BooleanField('BusVolFldCombnFldInitIsAllwd', BusVolFldCombnTypeFldAssgmt, 'Edm.Boolean')

Static representation of the busVolFldCombnFldInitIsAllwd 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<BusVolFldCombnTypeFldAssgmt> | BooleanField<BusVolFldCombnTypeFldAssgmt>> = [BusVolFldCombnTypeFldAssgmt.BUS_VOL_FIELD_COMBN_TYPE,BusVolFldCombnTypeFldAssgmt.BUS_VOL_FLD_COMBN_EXT_FIELD_NAME,BusVolFldCombnTypeFldAssgmt.BUS_VOL_FLD_COMBN_FLD_INIT_IS_ALLWD]

All fields of the BusVolFldCombnTypeFldAssgmt entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BusVolFldCombnTypeFldAssgmt"

Technical entity name for BusVolFldCombnTypeFldAssgmt.

Static _keyFields

_keyFields: Array<Selectable<BusVolFldCombnTypeFldAssgmt>> = [BusVolFldCombnTypeFldAssgmt.BUS_VOL_FIELD_COMBN_TYPE, BusVolFldCombnTypeFldAssgmt.BUS_VOL_FLD_COMBN_EXT_FIELD_NAME]

All key fields of the BusVolFldCombnTypeFldAssgmt entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CONDITION_CONTRACT_TYPE"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BusVolFldCombnTypeFldAssgmt>

    A builder that constructs instances of entity type BusVolFldCombnTypeFldAssgmt.

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

    Returns BusVolFldCombnTypeFldAssgmtRequestBuilder

    A BusVolFldCombnTypeFldAssgmt request builder.