Component:

S_Get_Skeleton

part of C_WissDB_DL_API

Abstract:

This is the service to be used for reading the unit-oriented structure of objects existing in the B_WissDB_Database.

To explain this service we need some definitions:

§      In the node-oriented view an object is a record of type E_Process, E_Role, E_Aspect, or E_KnowledgeItem.

§      Every such object X has a locator (which is the value found in X.a_Loc).

§      In the unit-oriented view the object is the tree of all object that have a locator identical to or prefixed by the locator of X.

§      The unit-oriented structure of X (also called the skeleton of X ) is defined to be the set of all these locators presented in form of a lexicographically ordered sequence of strings.

§      A pseudo object is one of the following sets of objects in the sense above:

–      B_ALL_Knowledge 

–      B_ALL_Processes 

–      B_ALL_Roles

–      B_ALL_Aspects

–      B_ALL_KnowledgeItems [?]

–      B_ALL_Results

–      B_ALL_Practices [?]

§      The skeleton of a pseudo object is the union of the skeletons of all the objects contained in the pseudo object.

Parameters:

§      In: Locator

        Is to be the locator for an object X that is either a pseudo object, or an object that has in the B_WissDB_Database, an attribute X.a_Loc.

        The locator for a pseudo object is /NameOfPseudoObject (e.g. /E_Roles).

§      Out: Skeleton

        Is either NULL or a sequence of N strings, N a positive number.

§      Out: AppErrors

        In case of Skeleton = NULL, the AppErrors must not be empty. The Skeleton returned must be either complete or NULL.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

Retrieve the skeleton of the object or pseudo object identified by the given Locator value.

Because of:

C_WissDB_API needs a way to retrieve the unit-oriented structure of all the objects stored in the B_WissDB_Database.

At least for generating test cases it will be helpful to have a service that is able to show the complete skeleton of the knowledge base itself.