Ifd:getConcept

From dev.ifd-library.org

Jump to: navigation, search
Function public IfdConcept getConcept (
                String guid,
                IfdLanguage languages[],
                String session_id )
                throws [[Ifd:IfdServerException|IfdServerException

EXPRESS heading

QUERY_FUNCTION getConcept(
             concept_guid: STRING; languages: LIST OF IfdLanguage) : IfdConcept;

Method to retrieve the concept given language preferences and a GUID of a concept

Input:

  • string guid - the guid of the concept to retrieve
  • IfdLanguage languages[] - a list of languages in which you want the concept in
  • string session_id - the session id for the current user

Return:

Back to the API

Comments: For retrieving the Concept the guid as input parameter suffices. The language parameter is not needed, and could even cause the concept not to be retrieved if the concept is not available in the selected language(s). So I propose to remove the language parameter. Kees Woestenenk.

The intended use of the language parameter is to be able to filter on one or many languages. If you omit the parameter names in all languages will be returned. Having it enables us to limit the amount of returned data in the case where only one or more language is of interest. I suggest we keep it for the moment. It is not mandatory. --Lars.Bjørkhaug 11:33, 31 August 2006 (CEST)

It is more clear to leave out the language parameter. I don't see why a caller would use a language filter when retrieving a Concept. The caller of this functions can always decide to filter Names. Kees Woestenenk.