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

CondGroupSelectionOptions

Synopsis

struct CondGroupSelectionOptions : ItemSelectionOptions {
    boolean? ExcludeInactiveItems;
    boolean? IncludeInactiveItems;
    boolean? GroupPseudoArticleParts;
    boolean? groupSubArticles;
}

Options excludeInactiveItems and includeInactiveItems are mutually exclusive. Operations fail with a BasketServiceFault if both are set to true. Other than that the values are ignored if the set of item IDs passed to the operation and the specified ItemSelectionOptions do not result in construction of a group calculation.

If both options are unspecified, the default values of excludeInactiveItems and includeInactiveItems are true and false, respectively. Otherwise, the default value of either option 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.

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.

The option groupPseudoArticleParts is used by all operations with a parameter of type CondGroupSelectionOptions or GetPriceCalculationSheetOptions to a) enforce the use of group calculations for all pseudo articles and b) add all sub-articles of pseudo-articles to group calculations referencing a pseudo article.

The default value of this option is false (traditional behavior).

If this option is true, the behavior of these operations is changed as follows:

  • If the operation operates on or returns a single calculation, and the effective set of selected items consists of a single pseudo article, the operation enforces the use of a group calculation instead of an item calculation.

  • Construction of group calculations referencing a pseudo article includes all (not just direct) sub-article items of the pseudo article item (applies to all pseudo articles, even those which are sub-articles themselves).

  • Operation getPriceCalculationSheets (§getPriceCalculationSheet) returns one calculation for each element of the effective set of selected items. Depending on the item type the behavior is as follows:

    • non-pseudo article: construction of an item calculation

    • pseudo article: construction of a group calculation referencing all sub-articles (independent of their position in the basket or view structure)

    • folder: construction of a group calculation referencing all article items that are descendants of the folder item in the basket or view structure

The option groupSubArticles behaves like option groupPseudoArticleParts, but applies to all basket articles instead of being limited to pseudo articles (regardless of whether the basket articles have sub-articles or not).

The default value of this option is false (traditional behavior).