Ifd:addDefinitionsToConcept

From dev.ifd-library.org

API version 2

public IfdDescription[] addDefinitionsToConcept (
                                        String concept_guid,
                                        IfdDescription [] definitions,
                                        String session_id )
                   throws IfdServerException

Function to add one or more definitions to a concept. The function takes an array of IfdDescription as input in addition to the global unique identifier for the concept itself and the session_id.

Input:

String concept_guid - The global unique identifier for the concept to which we want to add names (names may not exist in the library)
IfdDescription definitions[] - The definitions of the concept.
string session_id - The session id for the active user.

Returns:

IfdDescription - An array of definitions.

API version 3

public IfdDescription[] addDefinitionsToConcept (
                                        String session_id,
                                        String concept_guid,
                                        IfdDescription [] definitions)
                   throws IfdServerException

EXPRESS heading

QUERY_FUNCTION addDefinitionsToConcept(
                      concept_guid : STRING;
                      definitions : LIST OF IfdDescription) : LIST OF IfdDescription;

Function to add one or more definitions to a concept. The function takes an array of IfdDescription as input in addition to the global unique identifier for the concept itself and the session_id.

Input:

string session_id - The session id for the active user.
String concept_guid - global unique id of the target concept;

IfdDescription definitions[] -list of fully specified descriptions to be added to the concept, with the following attributes for every element:

guid – (optional) global unique id of the existing in database description. If the item defined yet in target population the attribute shall be set (as well as other attributes) and existing description will be assigned to the concept;
language – (optional) language of the description (shall be defined yet in target population), by default it is dedicated language with code equal to internal constant DEFAULT_LANGUAGE_CODE (‘en’ in current version);
description – text of the description;
description_type – (optional) type of the description, shall be one of the following: 'COMMENT' or 'DEFINITION' (default); so it is possible to add either comments or definitions to the concept within the same function;
preferred_by – (optional) aggregate of organizations which will prefer the description, by default set with home organization of the logged user

Returns: IfdDescription - List of fully specified definitions (comments) of the specified concept added with the function. Every element of the aggregate will have the following attributes:

guid - global unique id of the description (comment or definition);
language - language of the description;
description - text of the description;
description_type - type of the description, one of the following: 'COMMENT' or 'DEFINITION';
preferred_by - aggregate of organizations which prefer the description

Difference against v.2.00

(32) Depending of input parameters and target population structure and volume it responds 2-4 times quicker then in v.2.00;
(33) The function can accept language specification by default in contrast to v.2.00;
(34) The function identifies existing description by whole set of provided attributes. In v.2.00 the function identified description only by guid, in spite of specified text, language and type. So the function was able to assign description (definition or comment) that was different by value from specified;
(35) The function can add definitions (by default) as well as comment (if this specified by description_type). In v.2.00 the function creates only definitions in spite of value description_type but can add existing comments (found by guid);
(36) The function returns actual attributes of added descriptions. In v.2.00 the function returned the same structures as in input with only modified guids. So taking into account (34) and (35) the output could be different from actual;
(37) The function keeps the last date/time of concept change and cares about constraint xtdRoot. has_preferred_representations (mandatory SET[1:?]) specified by ISO12006-3. In v.2.00 the function did not care about the both;
(38) The function checks type of the concept and allows adding description to the context only to its owners. In v.2.00 the function did not check the case

Back to the API

Comments: Talk:Ifd:addDefinitionsToConcept