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

getCatalogItem

Synopsis

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

See also: CatalogItem, SessionId, LookupOptions, CatalogServiceFault

The getCatalogItem operation returns information about 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 desired catalog item. 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.

The path may reference a catalog item of any type.

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

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 path parameter is empty.

  • The first element of the 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. ↩