Ifd:updateDescription

From dev.ifd-library.org

API version 2

public IfdDescription updateDescription (
                                                 String concept_guid,
                                                 IfdDescription description,
                                                 String session_id )
       throws IfdServerException

Function to update a description. Everything except GUID may be updated.

Input:

• string concept_guid - The global unique identifier for the concept of the description to be updated.
• IfdDescription description - Description to be updated, any change to the GUID will be ignored.
• session_id - The session id for the active user

Returns:

• IfdDescription - The updated description.

API version 3

public IfdDescription updateDescription (
                                                 String session_id,
                                                 String concept_guid,
                                                 IfdDescription description)
       throws IfdServerException

EXPRESS Heading

QUERY FUNCTION updateDescription(
                     concept_guid : STRING;
                     description : IfdDescription ) : IfdDescription;

The function updates specified description of the concept.

Input:

• session_id - The session id for the active user
• string concept_guid - global unique id of a concept (or context, where user is owner) to be updated in specified description;

IfdDescription description - description specification in the following attributes:

• guid – global unique id of the original description (it shall be assigned to the specified concept);
• language – language (specified by guid, language_code or name_in_english) of the description – could be a subject to change;
• description – edited text of the description;
• description_type –type of the description, shall be one of the following: 'COMMENT' or 'DEFINITION'; it could be another subject for the change;
• preferred_by – ignored in input

Returns:

• IfdDescription - The same description with updated attributes (guid could be changed).

Difference against v.2.00

• (147) In v.2.00 the function did not change date/time stamp of the concept and when target concept was context instance it did not check if the logged user was context owner

Back to the API

Comments: Talk:Ifd:updateDescription