Ifd:searchForConcepts

From dev.ifd-library.org

Jump to: navigation, search
public IfdConcept [] searchForConcepts(
                                    String search_criteria,
                                    Ifd:IfdLanguage [] languages,
                                    IfdConceptTypeEnum [] concept_types,
                                    String session_id )
                 throws IfdServerException

EXPRESS heading

QUERY_FUNCTION searchForConcepts( search_criteria : STRING; 
                        languages : LIST OF IfdLanguage; 
                        concept_types : LIST OF STRING) : LIST OF IfdConcept;

Standard function to search in the Ifd library.

Input:

  • search_criteria - The search string made by the user. See pattern matching options below.
  • languages[] - Optional: Array of IfdLanguage objects for the languages the search should be limited to. If not given, names in any language are returned.
  • concept_types[] - Optional: Array of IfdConceptTypeEnum for the type of object the search should be limited to. If not given concepts of all types are returned.
  • session_id - The session id for the active user

Returns:

  • IfdConcept [] - An array of Ifd concepts or one of it's subtypes.


Possible pattern matching characters:

@   Matches any letter
^   Matches any upper case letter
?   Matches any character
&   Matches remainder of string
#   Matches any digit
$   Matches a substring terminated by a space character or end-of-string
*   Matches any number of characters
\   Begins a pattern escape sequence
!   Negation character (used with the other characters)

Back to the API