Component:

S_Select_Results

part of C_WissDB_DL_API

Abstract:

Using this functions you can search the B_WissDB_Database for Result objects satisfying given search criteria.

Parameters:

§      In: SeeType

        Is to be a set of strings (as they are allowed to be checked in the Type section of a B_Query_Specification).

§      In: SeeScope

        Is to be a set of strings (as they are allowed to be checked in the Scope section of a B_Query_Specification).

§      In: SeeView

        Is to be a set of strings (as they are allowed to be checked in the View section of a B_Query_Specification).

§      In: SeeAbstraction

        Is to be a set of strings (as they are allowed to be checked in the Abstraction section of a B_Query_Specification).

§      In: SeeUsage

        Is to be a set of strings (as they are allowed to be checked in the Usage section of a B_Query_Specification)

§      In: SeeAspect

        Is either NULL or a set of strings representing Aspect Locators (even the locator Aspect/ itself is allowed).

        Note: If one of these locators is a preLocator of another one, this other one is redundant and will be ignored.

§      In: SeeRole

        Is either NULL or a not empty set of strings representing Role or Process Locators.

        Note: If one of these locators is a preLocator of another one, this other one is redundant and will be ignored.

§      Out: Skeleton

        Is either NULL or a not empty set of values of type D_Locator, in which case it is to satisfy the following condition:

        For each element X of B_WissDB_Database.E_Result, X.a_Loc is element of the Skeleton if and only if

–      X.a_Type is element of SeeType,

–      X.a_ViewType is element of SeeView,

–      X.a_AbstractionType is element of SeeAbstraction,

–      X.a_UsageType is element of SeeUsage,

–      X.a_PracticeType is element if SeePractice (if X is not a E_Practice, the value if this attribute is assumed to be Result),

–      R_Is_keyword_for says that X is associated with a keyword K such that at least one element of SeeAspect is a prefix of K, and

–      One of the process locators found in SeeRole is preLocator of X.a_of (so that the X represents a result of this process), or X.a_of is the locator of a E_Process P such that an element of SeeRole is preLocator of P.a_RoleLoc.

§      Out: AppErrors

        If SeeRole is containing locators currently not in use, or not being a Role Locator, an AppError is to explain this.

        If at least one of the locators found in SeeAspect is not an Aspect Locator currently in use, an AppError is to explain this.

        AppErrors is to contain warnings if at least one string found in SeeType, SeeScope, SeeView, SeeAbstraction, or SeeUsage is a value not allowed therein and therefore ignored.

§      Out: ReturnCode is one of the following values:

–      RC_ok

–      RC_syserror

–      RC_seeAppErrors

–      RC_seeWarnings

Has to:

Create the Skeleton specified above as a subset of D_Locator. Then, if this set is not empty, return RC_ok in ReturnCode and this set in Skeleton.

If the set is empty, return NULL in Skeleton and again RC_ok in ReturnCode.

Return NULL in Skeleton and RC_seeAppErrors AppErrors is explaining errors.

Because of:

C_WissDB_API needs a way to implement S_Search_for_Knowledge.