Component:

C_WissDB_API

part of C_WissDB [?]

API –  the system’s Application API – is an abstract specification of the set of services available to WissDB applications and, via C_WissDB_GUI [?] , also to human users who want to use it interactively.

C_WissDB_CLI [?] is a command line interface equivalent to C_WissDB_API.

Abstract:

This component offers services to capture, classify, correlate and communicate practice instances and sample results in the context of processes for requirements engineering, software development, software support and software maintenance.

WissDB can be used to manage reusable software components as well as much more abstract reusable project results.

Has to:

Interprete or create objects of type:

§      B_Knowledge_Package

§      B_Query_Specification

Implement, for the user, the following services:

§      S_Check_Package

§      S_Save_Package

§      S_Open_Practice_Candidate

§      S_Reject_Candidate

§      S_Accept_Candidate

§      S_Search_for_Candidates

§      S_Search_for_Knowledge

§      S_Export_Descriptions

§      S_Export_Knowledge

§      S_Describe_Knowledge_DomainValues

§      S_Replace_or_create_Knowledge_DomainValues

§      S_Rename_Project

§      S_Testsupport_New_Knowledge_Base

Make all these functions available at least via

§      the command line interface C_WissDB_CLI [?] , and 

§      a REST conform web-based user interface C_WissDB_via_HTTP [?] .

Each of these functions must be protectable via C_Access_Control [?] as a separate resource (so that, depending on their role, users or applications might be restricted to use only some of these functions).

User Roles to be supported by C_WissDB_API are

§      A_Knowledge_Provider

§      A_Knowledge_User

§      A_Knowledge_Administrator

§      A_Knowledge_Schema_Administrator

§      A_Tester

All the services (= functions) named above have to be available, to the end-user, via a graphical, web-based user interface, i.e. via a web browser such as MS Internet Explorer.

They also have to be available via a suitable Java or C++ API.

A command line interface (CLI) must allow the user to invoke each service S_ also from the NT command window or out of a batch file.

The implementation of all these interfaces has to comply with the rules specified in C_WissDB_API, C_WissDB_CLI [?] , and C_WissDB_GUI [?] .

Because of:

Requirements detailed in D_( WissDB / Purpose and Requirements ) .