Ifd:getConcept

From dev.ifd-library.org

Jump to: navigation, search

API version 2

Function public IfdConcept getConcept (
                String guid,
                IfdLanguage languages[],
                String session_id )
                throws IfdServerException

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:

API version 3

Function public IfdConcept getConcept (
                String session_id
                String concept_guid,
                IfdLanguage languages[])
                throws IfdServerException

EXPRESS heading

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

The function fills all attributes for the required concept in terms of specified languages.

Input:

  • string session_id - the session id for the current user
  • string concept_guid - global unique id of the required concept (normally it can be get from addConcept, getChildren, getParents, searchForConcepts, etc.);
  • IfdLanguage languages[] - (optional) list of languages to represent concept (names and descriptions), by default - in all languages available for the IFD population

Return:

As the language code is unique we can use it rather than the GUID to filter on languages. There is no need to give in the full IfdLanguage object. Suggest to change the type from IfdLanguage to String.

Difference with v.2.00

  • (76) Current version of the function responds 3-4 times quicker then v.2.00
  • (77) In v.2.00 the function did not check restriction of the context if required;
  • (78) In v.2.00 the function did not return illustrations


Back to the API