Ifd:getMeasure
From dev.ifd-library.org
API version 2
Function public IfdMeasure getMeasure ( String measure_guid, String[] context_guids, IfdLanguage[] languages, String session_id ) throws IfdServerException
EXPRESS heading
QUERY_FUNCTION getMeasure (
measure_guid : STRING;
context_guids : LIST OF STRING;
languages : LIST OF IfdLanguage) : IfdMeasure;
Method to retrieve the measure details , unit and values for a given measure guid.
Input:
-
string measure_guid- optional: the guid of property for which we want to receive measure details -
string context_guids[]- array of context_guids in which you want to constrain the results -
IfdLanguage languages[]- array of languages in which you want to constrain the results -
string session_id- the session id for the current user
Return:
-
IfdMeasure- the returned measure with its unit and values
Description As IfdMeasure contains both unit and value this function alone can retrieve all necessary information for measuring a property.
API version 3
Function public IfdMeasure getMeasure ( String session_id String measure_guid, String[] context_guids, IfdLanguage[] languages) throws IfdServerException
EXPRESS heading
QUERY_FUNCTION getMeasure(
measure_guid : STRING;
context_guids : LIST OF STRING;
languages : LIST OF IfdLanguage): IfdMeasure;
The function returns list of all languages available in target IFD population to specify concept names and descriptions.
Input:
- string session_id - the session id for the current user
- string measure_guid</code> - global unique id of the target measure concept (normally it can be got from addConcept, getChildren, getParents, searchForConcepts, etc.):
- string context_guids[] - (optional) list of global unique id-s for contexts in which domains shall be collected measure unit and values, if the value empty or unset all context available for the logged users will be used;
- IfdLanguage languages[] -(optional) list of languages to represent measure (names and descriptions), by default - in all languages available in the target IFD population
Return:
IfdMeasure - Fully specified interesting measure with the following attributes
- base - fully specified base concept of the measure, see getConcept description;
- unit - measure unit, related to the measure via 'ASSIGNS_UNITS' relationship (context of the relationship shall be listed in input context_guids and not restricted for the logged user);
- values - measure values, assigned to the measure via 'ASSIGNS_VALUES' relationship (context of the relationship shall be listed in input context_guids and not restricted for the logged user)
Difference with v.2.00
- (94) The function was optimized to show better performance than in v.2.00;
- (95) In v.2.00 unit was filled with the first found unit in 'ASSIGNS_UNITS' relationship (there can be a lot of them)
Comments: