BasketItemType
Synopsis
enum BasketItemType {
Undefined,
Folder,
Article,
Aggregate,
PartialPlanning,
UserArticle,
SetArticle,
OCDArticle,
Text
}
The BasketItemType enumeration is used to identify the type of each basket item. Each basket item has one and only one type. The following enumeration values are defined:
Undefined
This value is reserved for occasions where the item type is unknown or undefined. An basket item should never have this type.
Folder
A basket item of type Folder can be used to group other items (the children).
Article
A basket item of type Article represents an ordinary OFML article that cannot have sub-articles, but can itself be a sub-article of an aggregate or partial planning.
Aggregate
A basket item of type Aggregate represents an OFML composite article that can have sub-articles and can itself be a sub-article of another aggregate or partial planning. An aggregate usually starts out as a single article without sub-articles, but allows sub-articles to be added though modification of the aggregate’s properties.
PartialPlanning
Technically, a basket item of type PartialPlanning represents an OFML composite article similar to an aggregate. However, a partial planning usually does not have an article number or a price and therefore should be treated by the application more like a folder than an article. A partial planning usually starts out with a single sub-article and allows the addition of further sub-articles through modification of the partial planning’s properties.
UserArticle
An user article is the most primitive kind of article position. It cannot have sub-articles, nor can it be a sub-article of an aggregate or partial planning. It is not backed by any kind of product data. Instead, all properties of an user article (manufacturer and series IDs, article numbers, article texts, price, …) must be set by the user (or another external agent) through the setItemProperties (§setItemProperties) operation.
SetArticle
A set article is a virtual article which encapsulates a set of real articles. Depending on the view, the articles contained within a set article may be hidden. Regarding its properties, a set article behaves more or less like an user article, except that the the default values of some properties (in particular the price) depend on the articles contained within the set article.
OCDArticle
A basket item of type OCDArticle represents an article that only requires the OCD engine instead of the full OFML runtime environment. An OCD article cannot have sub-articles, nor can it be the sub-article of some form of composite article.
Text
A basket item of type Text can hold text information.