Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implements

Index

Constructors

constructor

  • Returns BusVolFldCombnSetTypeAssgmt

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.

Optional busVolFldCombnAllwdSign

busVolFldCombnAllwdSign: string

Including / Excluding Control for BV Selection Criteria. With the parameter you can restrict the business volume base entries for the field combination in the contract to "only including" or "only excluding". Maximum length: 1.

nullable

Optional busVolFldCombnGroup

busVolFldCombnGroup: string

Field Combination Group for Business Volume Selection. A field combination group within a set of field combinations effects that the business volumes for the field combinations included in the group are summarized. Accordingly, field combinations within a field combination group are connected with an OR logic instead of AND logic in the WHERE clause of the select statement for the business volume determination. You use field combination groups to facilitate the entry of business volume selection criteria in the condition contract.The set of field combinations you use for a condition contract contains three field combinations: S001 with a field for suppliers, M001 with a field for materials, and M002 with a field for material groups. You have specified a field combination group FCG1 for field combinations M001 and M002.In the condition contract, you specify one supplier SUPP1 for field combination S001, one material MAT001 for field combination M001, and one material group MG10 for field combination M002. Accordingly, the business volume is determined for supplier SUPP1 and material MAT001 and for supplier SUPP1 and material group MG10 and both business volume values are added.The WHERE clause for this configuration can be sketched as follows: … WHERE ( supplier equals SUPP1 ) and ( material equals MAT001 OR material group equals MG10 ).Without using a field combination group, you would have to list all relevant materials of material group MG10 for field combination M001. Maximum length: 2.

nullable

Optional busVolFldCombnMaxNrOfEntries

busVolFldCombnMaxNrOfEntries: BigNumber

Maximum Number of Entries for Field Combination. With this parameter you can specify a maximum number of entries for a field combination in a contract. If the parameter is maintained for a field combination that has a field combination group assigned, the check is done on field combination group level. This means that the maximum number of entries for all field combinations of the group is added up and checked against the total of business volume base lines for the field combinations of the group.Field Combination FC_1 has Group A and Maximum 5Field Combination FC_2 has Group A and no Maximum.This means that you can maintain no more than 5 entries in total for FC_1 and FC_2..

nullable

Optional busVolFldCombnMinNrOfEntries

busVolFldCombnMinNrOfEntries: BigNumber

Minimum Number of Entries for Field Combination. With this parameter you can specify a minimum number of entries for a field combination in a contract. Maintaining this parameter makes the field combination mandatory in the contract. If the parameter is maintained for a field combination that has a field combination group assigned, the check is done on field combination group level. This means that the minimum number of entries for all field combinations of the group is added up and checked against the total of business volume base lines for the field combinations of the group.Field Combination FC_1 has Group A and Minimum 1Field Combination FC_2 has Group A and no Minimum.This means that at least one entry for FC_1 or FC_2 has to be maintained.

nullable

busVolFldCombnSet

busVolFldCombnSet: string

Set of Field Combinations. The set of field combinations groups single field combinations to allow a flexible configuration of selection criteria for the business volume selection in the condition contract settlement process. You assign the set of field combinations to a condition contract type in order to specify which selection criteria you can use for the settlement of a certain condition contract. You enter values for the selection criteria on the Business Volume Selection Criteria tab page in the condition contract's header area.In the business volume selection, the selection criteria of different field combinations within a set of field combinations are connected with an AND logic.When you create a condition contract for a supplier rebate scenario and you want to select business volume data for one supplier but different materials you can define a set of field combinations with a field combination containing just field LIFNR for the supplier and a second field combination with just field MATNR for the material. In the condition contract header you just specify the supplier for the first field combination and all the relevant materials for the second field combination.In contrast, when you use a field combination with fields LIFNR and MATNR, you can specify combinations of different suppliers and materials in the condition contract header. Maximum length: 4.

Optional busVolFldCombnValdtyIsAllwd

busVolFldCombnValdtyIsAllwd: boolean

Business Volume Base with Validity. With the parameter you can activate the entry of a valid from and valid to date in the business volume base for the field combination.

nullable

cndnContrType

cndnContrType: string

Condition Contract Type. Classification used to differentiate between different types of condition contracts. The condition contract type selected determines the behavior and layout of a condition contract.In a list category condition contract you cannot enter any conditions. Maximum length: 4.

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

toBusVolFldCombnTypeFldAssgmt

toBusVolFldCombnTypeFldAssgmt: BusVolFldCombnTypeFldAssgmt[]

One-to-many navigation property to the BusVolFldCombnTypeFldAssgmt 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<BusVolFldCombnSetTypeAssgmt> = new AllFields('*', BusVolFldCombnSetTypeAssgmt)

All fields selector.

Static BUS_VOL_FIELD_COMBN_TYPE

BUS_VOL_FIELD_COMBN_TYPE: StringField<BusVolFldCombnSetTypeAssgmt> = new StringField('BusVolFieldCombnType', BusVolFldCombnSetTypeAssgmt, '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_ALLWD_SIGN

BUS_VOL_FLD_COMBN_ALLWD_SIGN: StringField<BusVolFldCombnSetTypeAssgmt> = new StringField('BusVolFldCombnAllwdSign', BusVolFldCombnSetTypeAssgmt, 'Edm.String')

Static representation of the busVolFldCombnAllwdSign 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_GROUP

BUS_VOL_FLD_COMBN_GROUP: StringField<BusVolFldCombnSetTypeAssgmt> = new StringField('BusVolFldCombnGroup', BusVolFldCombnSetTypeAssgmt, 'Edm.String')

Static representation of the busVolFldCombnGroup 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_MAX_NR_OF_ENTRIES

BUS_VOL_FLD_COMBN_MAX_NR_OF_ENTRIES: BigNumberField<BusVolFldCombnSetTypeAssgmt> = new BigNumberField('BusVolFldCombnMaxNrOfEntries', BusVolFldCombnSetTypeAssgmt, 'Edm.Decimal')

Static representation of the busVolFldCombnMaxNrOfEntries 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_MIN_NR_OF_ENTRIES

BUS_VOL_FLD_COMBN_MIN_NR_OF_ENTRIES: BigNumberField<BusVolFldCombnSetTypeAssgmt> = new BigNumberField('BusVolFldCombnMinNrOfEntries', BusVolFldCombnSetTypeAssgmt, 'Edm.Decimal')

Static representation of the busVolFldCombnMinNrOfEntries 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_SET

BUS_VOL_FLD_COMBN_SET: StringField<BusVolFldCombnSetTypeAssgmt> = new StringField('BusVolFldCombnSet', BusVolFldCombnSetTypeAssgmt, 'Edm.String')

Static representation of the busVolFldCombnSet 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_VALDTY_IS_ALLWD

BUS_VOL_FLD_COMBN_VALDTY_IS_ALLWD: BooleanField<BusVolFldCombnSetTypeAssgmt> = new BooleanField('BusVolFldCombnValdtyIsAllwd', BusVolFldCombnSetTypeAssgmt, 'Edm.Boolean')

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

Static CNDN_CONTR_TYPE

CNDN_CONTR_TYPE: StringField<BusVolFldCombnSetTypeAssgmt> = new StringField('CndnContrType', BusVolFldCombnSetTypeAssgmt, 'Edm.String')

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

Static TO_BUS_VOL_FLD_COMBN_TYPE_FLD_ASSGMT

TO_BUS_VOL_FLD_COMBN_TYPE_FLD_ASSGMT: Link<BusVolFldCombnSetTypeAssgmt, BusVolFldCombnTypeFldAssgmt> = new Link('to_BusVolFldCombnTypeFldAssgmt', BusVolFldCombnSetTypeAssgmt, BusVolFldCombnTypeFldAssgmt)

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

Static _allFields

_allFields: Array<StringField<BusVolFldCombnSetTypeAssgmt> | BigNumberField<BusVolFldCombnSetTypeAssgmt> | BooleanField<BusVolFldCombnSetTypeAssgmt> | Link<BusVolFldCombnSetTypeAssgmt, BusVolFldCombnTypeFldAssgmt>> = [BusVolFldCombnSetTypeAssgmt.CNDN_CONTR_TYPE,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_SET,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FIELD_COMBN_TYPE,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_MIN_NR_OF_ENTRIES,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_MAX_NR_OF_ENTRIES,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_GROUP,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_ALLWD_SIGN,BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_VALDTY_IS_ALLWD,BusVolFldCombnSetTypeAssgmt.TO_BUS_VOL_FLD_COMBN_TYPE_FLD_ASSGMT]

All fields of the BusVolFldCombnSetTypeAssgmt 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_BusVolFldCombnSetTypeAssgmt"

Technical entity name for BusVolFldCombnSetTypeAssgmt.

Static _keyFields

_keyFields: Array<Selectable<BusVolFldCombnSetTypeAssgmt>> = [BusVolFldCombnSetTypeAssgmt.CNDN_CONTR_TYPE, BusVolFldCombnSetTypeAssgmt.BUS_VOL_FLD_COMBN_SET, BusVolFldCombnSetTypeAssgmt.BUS_VOL_FIELD_COMBN_TYPE]

All key fields of the BusVolFldCombnSetTypeAssgmt entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_CONDITION_CONTRACT_TYPE"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BusVolFldCombnSetTypeAssgmt>

    A builder that constructs instances of entity type BusVolFldCombnSetTypeAssgmt.

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

    Returns BusVolFldCombnSetTypeAssgmtRequestBuilder

    A BusVolFldCombnSetTypeAssgmt request builder.