Ifd:getMeasuresForProperty
From dev.ifd-library.org
API version 2
Function public IfdMeasure [] getMeasuresForProperty ( String property_guid, String[] context_guids, IfdLanguage[] languages, String session_id ) throws IfdServerException
EXPRESS heading
QUERY_FUNCTION getMeasuresForProperty (
property_guid : STRING;
context_guids : LIST OF STRING;
languages : LIST OF IfdLanguage) : LIST OF IfdMeasure;
Method to retrieve the measure details , unit and values for a given measure, property or both.
Input:
-
string property_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 list of measures to retrieve
Description As IfdMeasure contains both unit and value this function alone can retrieve all necessary information for measuring a property. The lists of values will not be constrained for a object property relationship. In order to receive the values only valid for a certain combination of property-object you will need to use the getConstrainedValues or getConstrainedMeasures
API version 3
Function public IfdMeasure [] getMeasuresForProperty ( String session_id String property_guid, String[] context_guids, IfdLanguage[] languages, ) throws IfdServerException
EXPRESS heading
QUERY_FUNCTION getMeasuresForProperty(
property_guid : STRING;
context_guids : LIST OF STRING;
languages : LIST OF IfdLanguage) : LIST OF IfdMeasure;
The function collects all measures assigned via 'ASSIGNS_MEASURES' relationship as children to the specified property.
Input:
- string session_id - the session id for the current user
- string property_guid - (optional) global unique id of the target property concept (normally it can be got from addConcept, getChildren, getParents, searchForConcepts, etc.), if not provided all measures assigned to any property will be returned;
- 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 measures (their names and descriptions), by default - in all languages available in the target IFD population
Return: IfdMeasure[] - List of fully specified measures with the following attributes for every element:
- 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
- (96) In v.2.00 the function did not check if relationship contexts are restricted for the logged user
Comments: