Component:

S_Check_Package

part of C_WissDB_API

Abstract:

This is the function allowing the user to ask the system in what respect a given knowledge package is not yet well formed.

What it means for a package to be well formed is specified in section 2.2. of D_( WissDB/ Design/ Data Model ) und the conceptual point if view.

From a more formal point of view there is the additional condition that the content of the file PackageRoot/ Structure is to be text in B_Structure_Format such that all items and aspects named therein actually exist. Aspects are searched for first under the PackageRoot and then – if not found there – in the B_Knowledge_Base.

Parameters:

§      In: PackageRoot

        The B_Root of the knowledge packages the user wants the system to store.

§      Out: AppErrors

        If the package was not well formed, users should find a description here telling them how to make the package well formed.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

Check whether the given tree of files can be seen as a well formed knowledge package.

If it is not well formed, let AppErrors tell the user what they are to change in order to make the package well formed.

Because of:

End users need a way to check how far a package is already well formed.