Ifd:getConstrainedValues

API version 2
Function public IfdMeasure [] getConstrainedValues (                            String concept_guid,                             String property_guid,                             String measure_guid,                             String[] context_guids,                              IfdLanguage [] languages,                             String session_id) throws IfdServerException

Function to list get a constrained measure with values

QUERY_FUNCTION getConstrainedValues (                               concept_guid : STRING;                                property_guid : STRING ;                                measure_guid : STRING ;                                context_guids : LIST OF STRING ;                                 languages : LIST OF IfdLanguage) : IfdMeasure;

Input:
 * - guid of the concept
 * - guid of the property
 * - guid of the measure
 * - array of contexts to which the result should be limited
 * - array of languages to which the result should be limited
 * session_id - the session id for the current user

Return:
 * IfdMeasure [] - The measures with it's constrained values and unit.

API version 3
Function public IfdMeasure [] getConstrainedValues (                            String session_id                             String concept_guid,                             String property_guid,                             String measure_guid,                             String[] context_guids,                              IfdLanguage [] languages) throws IfdServerException

EXPRESS heading QUERY_FUNCTION getConstrainedValues(                      concept_guid,                        property_guid,                       measure_guid : STRING;                       context_guids : LIST OF STRING;                        languages : LIST OF IfdLanguage) : IfdMeasure;

The function returns constraining values of 'ASSIGNS_PROPERTY_WITH_VALUES' relationship specified by parent concept and property and assigned to specified measures (parents assigned to values by 'ASSIGNS_VALUES' relationship).

Input:
 * session_id - the session id for the current user
 * concept_guid - global unique id of parent concept;
 * property_guid - global unique id of a property assigned to the concept with 'ASSIGNS_PROPERTY_WITH_VALUES' relationship;
 * measure_guid - (optional) global unique id of a measure assigned as parent to the values with 'ASSIGNS_VALUES' relationship, if not specified all values are returned in one virtual (not existing) measure structure;
 * context_guids[] [] - (optional) list of global unique id-s of the required relationship contexts – the function returns only values related to parent concept/property in specified contexts; the aggregate can be unset or empty if user is looking for relationships in any available for him contexts.
 * languages[] [] - (optional) list of languages to represent found values/measures (their names and descriptions), by default - in all languages available in the target IFD population

Return:

IfdMeasure [] - Fully specified (in terms of required languages) measure with values assigned on one hand to the specified concept and property ('ASSIGNS_PROPERTY_WITH_VALUES' relationship) and on another hand to the measure (parent in 'ASSIGNS_VALUES' relationship) with the following attributes: base - fully specified generic concept’s attributes of the measure, could be unset if the input measure_guid unset unit - fully specified unit of the measure (assigned as child to the measure via 'ASSIGNS_UNITS' relationship), could be unset if the input measure_guid unset; values - fully specified value instances assigned on one hand to required concept/property and on another to the measure (if specified)

Difference with v.2.00
 * (85) In v.2.00 the function did not provide error handling and could return invalid data;
 * (86) For the function in v.2.00 valid measure_guid was mandatory parameter

Comments: