Ifd:getConstrainedMeasures

From dev.ifd-library.org

API version 2

Function public IfdMeasureInRelationship [] getConstrainedMeasures (
                                   String concept_guid,
                                   String property_guid,
                                   String[] context_guids, 
                                   IfdLanguage [] languages,
                                   String session_id)
                           throws IfdServerException

Function to list get a constrained measure with values

QUERY_FUNCTION getConstrainedMeasures (
                                   concept_guid : STRING;
                                   property_guid : STRING ;
                                   context_guids : LIST OF STRING ; 
                                   languages : LIST OF IfdLanguage) : LIST OF IfdMeasureInRelationship;

Input:

• concept_guid - guid of concept
• property_guid - guid of property
• context_guids[] [] - array of contexts to which the result should be limited
• languages[] [] - array of languages to which the result should be limited
• session_id - the session id for the current user

Return:

• IfdMeasureInRelationship []- The measures with it's constrained values and unit. The measures is returned with its contexts in the case where there are more than one measure-context combination for one set of constrained values.

API version 3

Function public IfdMeasureInRelationship [] getConstrainedMeasures (
                                   String session_id
                                   String concept_guid,
                                   String property_guid,
                                   String[] context_guids, 
                                   IfdLanguage [] languages)
                           throws IfdServerException

EXPRESS heading

QUERY_FUNCTION getConstrainedMeasures(
                      concept_guid,
                      property_guid : STRING;  
                      context_guids : LIST OF STRING;
                      languages	: LIST OF IfdLanguage): LIST OF IfdMeasureInRelationship;

The function returns constraining values of 'ASSIGNS_PROPERTY_WITH_VALUES' relationship specified by parent concept and property, grouped by their 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;
• 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: IfdMeasureInRelationship []- List of fully specified (in terms of required languages) measures with values assigned to the specified concept and property, every element of the list has the following attributes:

• base - fully specified measure of the values, with the following attributes:
• relationship_type - set to 'ASSIGNS_PROPERTY_WITH_VALUES';
• context_guids - fully specified domain contexts (subset of required in list context_guids) of the relationship

Back to the API

Comments: