Component:

S_Search_for_Knowledge

part of C_WissDB_API

Abstract:

This is the service supporting knowledge retrieval.

Parameters:

§      In: PackageRoot

        The absolute path to the place where users want to have a package represent­ing the knowledge to be retrieved.

§      In: QuerySpec

        A value of type B_Query_Specification existing at PackageRoot/ Selector in form of an ASCII text file.

§      Out: PackageStructure

        The search result, if seen as a knowledge package, has structure. This structure shall be delivered as the new content of the file PackageRoot/ SearchResult.

§      Out: AppErrors

        Is to describe one or more AppErrors if

–      the PackageRoot folder does not exist,

–      the query specification, if missing, could not be created, or

–      the query specification, if found, was not well formed.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

Search the B_Knowledge_Base using the B_Query_Specification

§      either found as a file PackageRoot/ Selector

§      or created there as a copy of the B_Default_Selector (if at least the folder PackageRoot exists).

Because of:

WissDB users need a service to search for – and to retrieve – practice knowledge.

Users not knowing how to create a B_Query_Specification should be shown a well explained example (start with the B_Default_Selector to create such an example).