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

listCatalogItems

Synopsis

CatalogItem[] listCatalogItems(SessionId sessionId,
    string[]             path,
    LookupOptions[]      options)
throws CatalogServiceFault;

See also: CatalogItem, SessionId, LookupOptions, CatalogServiceFault

The listCatalogItems operation returns information about all child items of the catalog item represented by the path parameter. The path must be built from catalog node names, which are returned by catalog service operations as the value of the name field of the CatalogItem structure.

The sessionId parameter must identify an open session. It is used to reference a session configuration which determines the set of available manufacturer catalogs and the language used for human readable texts returned by operations of the catalog service.

The path references the catalog item whose child items will be returned. If a path consists of n catalog item names cin**1 to cin**n, then the path references the catalog item with name cin**n that is a child item of the item referenced by the path consisting of the catalog item names cin**1 to cin**n-1. A path consisting of a single catalog item name references the root item1 of a manufacturer catalog. An empty path does not actually reference a catalog item, but can be used to list all the catalog items representing manufacturer catalogs.

The path may reference a catalog item of any type.

The LookupOptions argument is used to select the resources to be returned in the resources field of returned instances of CatalogItem (§CatalogItem). See §LookupOptions for more information.

The operation returns a sequence of catalog items, where each catalog item represents a visible child of the catalog item referenced by the path. If the referenced catalog item has no child items, then the sequence of returned catalog items is empty. This may be the case if

  • the path references an empty folder,

  • the path references a non-empty folder with no visible catalog items (all child items are hidden due to the displMode and insModes parameters),

  • the path references an article or information item, which by definition does not have child items.

A CatalogServiceFault 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.

  • The first element of a non-empty path parameter does not identify a manufacturer catalog registered for the session identified by the sessionId parameter.

  • The path does not reference a catalog node.

  • At least one node traversed by the path, or the final node referenced by the path, not visible according to the displMode and insModes parameters.

  • There was an error accessing the catalog database.

Footnotes

  1. With the current implementation, one manufacturer catalog consists of one or more XCF catalogs. The root item of the manufacturer catalog is the parent of the root items of the XCF catalogs combined by this manufacturer catalog. ↩