Ifd:correctSpellingForDescription

From dev.ifd-library.org

API version 2

public IfdDescription correctSpellingForDescription (
                                         IfdDescription description,
                                         String session_id )
       throws IfdServerException

Function to update the spelling in a description. This means that we assume the changes in IfdDescription are valid for all concepts that use this as a description (comment or definition).

Input:

IfdDescription description - Description to change spelling for.
session_id - The session id for the active user

Returns:

IfdDescription - The changed description.

API version 3

public IfdDescription correctSpellingForDescription (
                                         String session_id,
                                         IfdDescription description)
       throws IfdServerException

EXPRESS Heading

QUERY FUNCTION correctSpellingForDescription(
                     description : IfdDescription): IfdDescription;

The function corrects text and/or type of specified description.

Input:

session_id - The session id for the active user

IfdDescription description -fully specified description to be changed in its text, with the following attributes:

guid – unique database id of the description, that was set to it in creation, the value shall be specified to find original description in IFD population;
language – language of the description specified with any of the following: guid (high priority), language_code, name_in_english or name_in_self;
description – new text of the description;
description_type – type of the description: 'DEFINITION' or 'COMMENT';
preferred_by – list of organization that prefer the description, ignored in the input

Returns:

IfdDescription - Fully specified corrected description with may be changed guid.

Difference with v.2.00

(66) The function in v.2.00 did change description type, did not check if any description with the same text/type/language exists yet, did not check user’s rights to modify contexts.

Back to the API

Comments: This function is not needed, updateDescription can be used instead. Kees Woestenenk

Spelling is different from update

There is a difference between updating something for the one concept connected to it, ot changing it for every concept connected to it. Spelling mistake is for everything connected to it. Updates will only be valid for the concept you send in.

Håvard.Bell