Component:

S_Save_Package

part of C_WissDB_API

Abstract:

This is the function allowing the user to store or update in WissDB a Practice Candidate (a B_Knowledge_Package not yet accepted as a result or practice instance worth to keep).

Parameters:

§      In: PackageRoot

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

§      In: Loc

        This is a Project Locator suggested by the user.

        The candidate’s A_Loc value is to become package/ Loc/ pack.jar (WissDB is to create this JAR archive).

§      In: Update

        This is a Boolean value. FALSE means: This is a new package that must not replace existing data.

§      In: Submitter

        This is either NULL or a string representing an e-Mail address.

§      Out: AppErrors

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

        Describe an AppError here if Submitter = NULL and Update = FALSE.

        Describe an AppError if the given PackageName does not have the form of a Project Locator.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

Has to:

Save the package, or the new version thereof, if and only if S_Check_Package says that it is well formed.

In case of Update = TRUE, saving the command may overwrite a previous version (if there is one).

Practice candidates stored but not yet accepted or rejected can be found via the service S_Search_for_Candidates.

Because of:

End users need a way to hand over practice candidates to the WissDB system.

A_KnowledgeAdministrator may want to edit a package one or more times before it can be merged into the B_Knowledge_Base.