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

UpdateBasketArticlesOptions

Synopsis

struct UpdateBasketArticleOptions : ItemSelectionOptions {
    boolean update;
    boolean migrate;
    boolean recalculate;
    date priceDate
}

See also: ItemSelectionOptions, date (unresolved source reference)

This type extends the type ItemSelectionOptions. Additional optional boolean attributes are update and migrate. These attributes can be used to control whether or not the operation should update and/or migrate articles, or just determine the update state.

If the attribute recalculate is set to true, the calculations of selected article items not updated or migrated are recalculated. The calculations of updated or migrated article items are always recalculated. Recalculation includes execution of access methods. Note that, actually, the updateBasketArticles (§updateBasketArticles) operation just invalidates the calculations. Recalculation happens on demand the next time affected calculation data is requested.)

Selection of article items for recalculation, updated or migrate works as followign: if one or more articles of a composite article have been selected, the behavior depends on whether or not the main article is among the selected articles, and (if not), whether or not the wholeComposite flag is set. In any case, either all articles of a composite article are recalculated, migrated or updated, or none.

The default value of update is true, whereas the default value of migrate and recalculate is false.

If migrate is true and a former OFML meta type is now a simple article without the CompositeArticle interface, migration can silently remove its existing basket sub-articles. See the article-type migration notes in updateBasketArticles.