Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

GetPriceCalculationSheetOptions

Synopsis

struct GetPriceCalculationSheetOptions : CondGroupSelectionOptions {
    boolean sumUpComposite,
    boolean itemCondAmountPerUnit,
    boolean headerCondAmountPerUnit
}

See also: CondGroupSelectionOptions

sumUpComposite

If all selected items are part of one or more composite articles, all main and sub-article items of these composite articles are selected, all composite articles are considered equal1, and the unit of the sales unit size of the main article items is C62 (pieces), then a group calculation produced for all selected articles will report a quantity equal to the total of the quantities of all main article items and a sales unit size matching the sales unit size of the main article items.

Use of this option is more or less a precondition for use of options itemCondAmountPerUnit and headerCondAmountPerUnit.

The default value of this option is false.

itemCondAmountPerUnit

headerCondAmountPerUnit

The usual algorithm to combine item calculation conditions into group conditions is to sum up the item calculation condition values to get the group calculation condition value and display amount and quantity relation of the group calculation condition if and only if all combined item calculation conditions have the same value.

If one or both of these options are used, this algorithm is replaced for the corresponding condition type by another one that behaves as follows:

      • Calculation rule, amount and quantity relation are invalid if the group calculation does not have a finite non-zero quantity.

      • Otherwise, the amount is computed as the condition value divided by the quantity. If the amount is finite and not null then the calculation rule is set to Quantity, the amount to the properly rounded computed amount, and the quantity relation to the sales unit size of the group calculation. Otherwise invalid values are used.

Furthermore, if at least one of these options is true, all operations that work on calculations enforce the use of a group calculation, even if only a single (set-)article item is selected.

The default value of these options is false.

ExcludeInactiveItems and includeInactiveItems

Both options are mutually exclusive. The operation fails with a BasketServiceFault if both are set to true. Other than that the values are ignored if no group calculation sheet is returned.

If both options are unspecified, the default values of excludeInactiveItems and includeInactiveItems are true and false, respectively. Otherwise the default value of both options is false.

If excludeInactiveItems and includeInactiveItems are both false, group calculations ignore item calculations of inactive items (i.e. alternative positions) if and only if the group contains at least one active item.

If excludeInactiveItems is true, group calculations always ignore calculations of inactive items. This is the default behavior if neither option is specified, and results in more or less the traditional behavior. The only difference is that calculations of inactive items no longer affect the set of condition lines added to the group calculation, so the group calculation returned for a group consisting entirely of inactive items looks more or less the same as a group calculation returned for an empty group, an empty folder, or a document calculation returned for an empty document (it contains no condition lines except header conditions that are present in the document calculation).

If includeInactiveItems is true, group calculations do not ignore calculations of inactive items, i.e. group condition values are computed as the sum of item conditions values of both active and inactive items.

Footnotes

  1. same configuration and calculation of main articles and corresponding sub-articles, but not necessarily same structure of sub-articles ↩