Component:

S_Export_Descriptions

part of C_WissDB_API

Abstract:

Using this service the user can ask WissDB to export the Description items of the knowledge found via S_Search_for_Knowledge.

Parameters:

§      In: PackageRoot

        A B_Root X such that the file X/ Selector exists and contains a not empty last section Included and Excluded Items.

§      Out: Exports

        Is a lexicographically sorted sequence of strings representing the locators for the descriptions found and exported.

§      Out: Structure

        Is an updated version of a last section “Package Structure” added by WissDB in the X/ Selector. This section is to describe in B_Structure_Format all the structure of the knowledge items listed as Included in X/ Selector (attributes a_x in the sense of the Entity Relationship Diagram found in the section 2 of D_( WissDB/ Design/ Data Model ) .

§      Out: AppErrors

        Is do describe an AppError if the PackageRoot could not be found or if at least one description file could not be created (or updated) in this tree.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

For each locator L checked in the section Included and Excluded Items of X/ Selector and ending with /Description, create – if content is found in this node – the file R/L/Description.ext, where R is the PackageRoot and ext is the file’s type.

Because of:

WissDB users need a service to export knowledge items found via one or more calls of S_Search_for_Knowledge.