AttachmentMode
Synopsis
enum AttachmentMode {
None,
Item,
Composite,
TryComposite
}
None
The newly inserted article is not attached to an existing composite article, i.e. it is inserted as a stand-alone article. This is the traditional and default behavior.
Composite
Insert the new OFML article into a composite article. The fatherId passed to the insertOFMLArticle operation must identify a basket article item (i.e. an item with item type Article, Aggregate or PartialPlanning). The insert procedure determines a list of basket article items to consider as parents (in the composite article hierarchy) for the new article item, consisting of all items from the specified basket article item up to the root of the composite article hierarchy, both inclusive, in that order. It creates the new article as a sub-article of the first article item from the list whose item type is either Aggregate or PartialPlanning, and that accepts the new article as its sub-article (i.e. checkAdd() of the corresponding OFML article returned an insert position). The operation fails if no suitable parent article has been found.
Item
Like Composite, but only try the first element of the list of possible parents (if the item type of the first element, i.e. the item specified by fatherId, is Article, the insert operation will always fail).
TryComposite
Like Composite, but (try to) insert the new article as a stand-alone article if it can not be inserted as part of the composite article.