Ifd:addDescriptions
From dev.ifd-library.org
API version 3
Function public IfdDescription [] addDescriptions ( String session_id, String concept_guid, IfdDescription[] descriptions, String descr_type) throws IfdServerException
EXPRESS Heading
Query function addDescriptions(
concept_guid : STRING;
descriptions : LIST OF IfdDescription;
descr_type : STRING) : LIST OF IfdDescription;
The function can add both definitions and comments in one call to the specified concept. It covers normative functionality of addCommentsToConcept and addDefinitionsToConcept. Actually the two call addDescription.
Input:
- String concept_guid - global unique id of the target concept;
IfdDescription[] descriptions - 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', if unset, value of descr_type will be used to specify type of the description;
- preferred_by – (optional) aggregate of organizations which will prefer the description, by default set with home organization of the logged user;
- String descr_type - type of the descriptions to use by default: 'COMMENT' or 'DEFINITION'
Return: IfdDescription - List of fully specified descriptions 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