Ifd:addNamesToContext

From dev.ifd-library.org

API version 2

Function public IfdName [] addNamesToContext (
                                                   String context_guid,
                                                   IfdName [] names,
                                                   String session_id) throws IfdServerException

Function to add one or more names a context.

Input:

String context_guid The global unique identifier of the context that the names should be added to.
IfdName [] names An array containing names to be added to the context.

Return: An updated list of IfdName in the context.

API version 3

Function public IfdName [] addNamesToContext (
                                                   String session_id,
                                                   String context_guid,
                                                   IfdName [] names) throws IfdServerException

Express heading

QUERY_FUNCTION addNamesToContext(
                      concept_guid : STRING;
                      names : LIST OF IfdName): LIST OF IfdName;

The function adds more names the specified context.

Input:

sessionId session_id -
String context_guid - unique id of the target concept;

IfdName [] names - list of fully specified names to be added to the concept, with the following parameters:

guid – (optional) global unique id of the name existing in database. If the item defined yet in target population the attribute shall be set (as well as other attributes) and existing name will be assigned to the concept;
language – (optional) language of the name (shall be defined yet in target population and specified by guid or language_code), by default it is dedicated language with code equal to internal constant DEFAULT_LANGUAGE_CODE (‘en’ in current version);
name – text of the name;
name_type – (optional) type of the name, shall be one of the following: 'FULLNAME' (default), 'SHORTNAME' or ‘LEXEME’;
preferred_by – (optional) aggregate of organizations which will prefer the name, by default set with home organization of the logged user;
descr_type type of the descriptions to use by default: 'COMMENT' or 'DEFINITION'

Return:

List of IfdName - List of fully specified names of the specified concept added with the function. Every element of the aggregate will have the following attributes:

guid - global unique id of the name;
language - language of the name;
name - text of the name;
name_type - type of the name, one of the following: 'FULLNAME', 'SHORTNAME' or ‘LEXEME’;
preferred_by - aggregate of organizations which prefer the name

Difference against v.2.00

(40) Depending of input parameters and target population structure and volume it responds 2-3 times quicker then in v.2.00;
(41) The function can accept language specification by default in contrast to v.2.00;
(42) 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;
(43) 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: