Ifd:correctSpellingForName

From dev.ifd-library.org

API version 2

public IfdName correctSpellingForName (IfdName name, String session_id )
       throws IfdServerException

Function to update the spelling in a name. This means that we assume the changes in IfdName are valid for all concepts that use this as a name.

Input:

IfdName name - Name to change spelling for.
session_id - The session id for the active user

Returns:

IfdName - The changed name.

API version 3

public IfdName correctSpellingForName (
                              String session_id,
                              IfdName name)
       throws IfdServerException

EXPRESS Heading

QUERY FUNCTION correctSpellingForName(
                     name : IfdName) : IfdName;

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

Input:

session_id - The session id for the active user

IfdName name - fully specified name to be changed in its text/type, with the following attributes:

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

Returns:

IfdName - Fully specified corrected name with may be changed guid.

Difference with v.2.00

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

Back to the API

Comments: Updating (the spelling of) a name should be a method of IfdName. Kees Woestenenk

The object itself cannot have a method. All methods need to be seperate from the objects. Håvard.Bell