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

insertFolder

Synopsis

BItemId insertFolder(SessionId sessionId,
    BItemId fatherId,
    BItemId beforeId,
    DisplayText name)
throws BasketServiceFault;

See also: BItemId, SessionId, DisplayText, BasketServiceFault

The insertFolder operation inserts a new folder item into the basket item tree maintained by the basket service for the session identified by the sessionId parameter. It returns the item ID of the inserted folder.

The fatherId parameter, if not the null-UUID, must identify the basket item that will become the parent of the new OFML article item. If fatherId is the null-UUID (§UUID), the root item of the basket item tree will be used as the parent item.

The beforeId parameter, if not the null-UUID, must identify an existing basket item. If this item is a descendant of the basket item that has been selected as the parent of the newly inserted item, then the new item will be inserted in front of the parent’s child which is either equal to the item identified by beforeId, or an ancestor of this item. Otherwise (if beforeId is a null-UUID, or if the basket item identified by beforeId is not a descendant of the parent item) the new item will be inserted as the last child of the parent item.

The parameter name should contain the name of the folder.

The inserted basket item is of type Folder (§BasketItemType). Additional properties of the newly inserted folder item may be set using the setItemProperties operation (§setItemProperties).

A BasketServiceFault is returned if any of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID or does not represent an open session.

  • Either the fatherId or beforeId parameter does not represent an UUID.

  • Either the fatherId or beforeId parameter does not identify a basket item and is not the null-UUID.

  • The basket item identified by the fatherId parameter does not permit child items of type Folder.

  • There was some error during the actual process of inserting the folder item.