Ifd:searchForNames
From dev.ifd-library.org
API version 2
public IfdName [] searchForConcepts( String search_criteria, IfdLanguages[] languages, IfdNameTypeEnum [] name_types, String session_id ) throws IfdServerException
Standard function to search in the Ifd library.
Input:
- string 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.
- name_types[] - Optional: Array of IfdNameTypeEnum 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:
- IfdName [] - An array of Ifd names.
API version 3
public IfdName [] searchForNames( String session_id String search_criteria, Ifd:IfdLanguage [] languages, String [] name_types) throws IfdServerException
EXPRESS heading
QUERY_FUNCTION searchForNames(
search_criteria : STRING;
languages : LIST OF IfdLanguage;
name_types : LIST OF STRING): LIST OF IfdName;
The function searches for names matching to specified criteria.
Input:
- session_id - The session id for the active user
- string search_criteria - The search string made by the user. See pattern matching options below.
- languages[] - (optional) list of required language specifications, every element of the aggregate shall be uniquely specified with one of the following attribute (in priority order):
language_code – two or three letter international language code (as they stored in the target IFD population, see getLanguages), guid – global unique id of the language in IFD population, name_in_english – name of the language as it stored in IFD population. The function will apply search_criteria to names within listed languages. If the parameter is unset (empty aggregate) search will be done for all languages.
- name_types[] - (optional) list of required name types. The function will apply search_criteria to names within the listed types or to all types if the parameter is unset (empty)
Returns:
- IfdName [] - List of found names that match to criteria and language/type limitations.
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)
Difference against v.2.0
- (141) The search responds 4-8 times quicker comparing to v.2.0