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

OFMLUpdateState

Synopsis

enum OFMLUpdateState {
    Unknown,
    UpToDate,
    Updatable,
    Migratable,
    Invalid,
    NoCatalog,
    MultipleCatalogs
}

The update state determined by EAIWS for a composite article item depends on the configuration of the article item, the set of registered OFML catalogs and the product data referenced by these catalogs, and a possibly specified subset of OFML catalogs.

The following update states are defined:

Unknown

The update state has not been determined yet. See operation getItemProperties (§getItemProperties) for more information.

UpToDate

The data of the basket article item has been copied by this session from an OFML article item. Thus it is known that the current configuration of the basket article item is supported by at least one of the registered OFML catalogs, and that EAIWS should always be able to re-instantiate an OFML article with exactly the same configuration.

Updatable

Catalog selection resulted in exactly one OFML catalog, and it has been determined that the product data referenced by this catalog allows the re-instantiation of an OFML article such that the configuration of the OFML article is exactly the same as the configuration of the basket article item.

Migratable

Like Updatable, except that the variant code of the OFML article item may differ from the original variant code stored at the basket article item.

Invalid

Catalog selection resulted in exactly one OFML catalog, and it has been determined that the product data referenced by this catalog does not contain the required OFML article (there is no OFML article with the same base article number).

NoCatalog

Catalog selection did not find a matching OFML catalog.

MultipleCatalogs

Catalog selection found multiple matching OFML catalogs.

The process of ‘catalog selection’, as used above in the description of individual update states, determines zero or more OFML catalogs that contain the same OFML package as specified by the program ID stored for the basket article item (i.e. a package with the same OFML manufacturer and program IDs).

The ‘updateBasketArticles’ operation described below allows the specification of a set of catalog IDs. If this set is not empty, it is used to further restrict the set of catalogs determined above (catalogs whose catalog ID is not contained in the set of specified catalog IDs are removed).

If, at this point, the set of catalogs contains more than one catalog, a catalog profile ID is stored at the article, and the catalog profile ID is equal to the catalog ID of one of the catalogs selected so far, all catalogs other than the catalog identified by this catalog ID are moved from the set of selected catalogs.

The remaining set of catalogs is the result of catalog selection as used in update state descriptions.

(The process of catalog selection is still subject of consideration and may be modified in future versions of EAIWS.)