Ifd:addConstrainedValues

From dev.ifd-library.org

Jump to: navigation, search

API version 2

Function public IfdMeasure addConstrainedValues (String concept_guid, 
                                                          String property_guid, 
                                                          String measure_guid, 
                                                          String [] value_guids, 
                                                          String rel_context_guid,
                                                          String session_id)
                                throws IfdServerException


Function to add constrained values to a measure

QUERY_FUNCTION addConstrainedValuesToMeasure (concept_guid : STRING; 
                                              property_guid : STRING ; 
                                              measure_guid : STRING ; 
                                              values: LIST OF IfdValue
                                              rel_context_guid: STRING) :  IfdMeasure;

Input:

  • concept_guid - guid of concept
  • property_guid - guid of property
  • measure_guid - guid of measure
  • value_guids [] - array of global unique identifier for values to be contstrained in the concept-property relationship
  • rel_context_guid - (optional) the global unique identifier for the context to whcich the realtionship will be added, if given
  • session_id - the session id for the current user

The values added must be part of the measure given by the measure_guid. If the values are not already part of the measure they will be added using the xtdRelAssignsValues relationship. To constrain a value for a given object-property combination we are using the xtdRelAssignsPropertyWithValues relationship.

Return:

API version 3

Function public IfdMeasure addConstrainedValues (
                                                          String session_id,
                                                          String concept_guid, 
                                                          String property_guid, 
                                                          String measure_guid, 
                                                          String [] value_guids, 
                                                          String rel_context_guid)
                                throws IfdServerException

EXPRESS heading

QUERY_FUNCTION addConstrainedValues(
                                              concept_guid : STRING; 
                                              property_guid : STRING ; 
                                              measure_guid : STRING ; 
                                              values: LIST OF IfdValue
                                              rel_context_guid: STRING) :  IfdMeasure;

Function to add constrained values to a measure

Input:

  • session_id - the session id for the current user
  • concept_guid - global unique id of the concept (neither nest nor bag) to be added with the specified constrained property;
  • property_guid - global unique id of the property to be assigned to the specified concept;
  • measure_guid - (optional) global unique id of measure [to be] associated to the specified values;
  • value_guids [] - aggregate of global unique id-s of the assigned values to be used as constrained values for the property;
  • rel_context_guid - global unique id of the target context for the both relationships where logged user shall be owner

The values added must be part of the measure given by the measure_guid. If the values are not already part of the measure they will be added using the xtdRelAssignsValues relationship. To constrain a value for a given object-property combination we are using the xtdRelAssignsPropertyWithValues relationship.

Return: IfdMeasure - Measure view entity instance representing assigned values with the following attributes:

  • base - if measure_guid is set in input parameters - fully specified in all available languages measure concept; in another case - unset attribute;
  • unit - if measure_guid is set in input parameters - fully specified in all available languages assigned to the measure unit; in another case – unset attribute;
  • values - list of fully specified in all available languages values assigned as constraints in the specified property for the specified concept

Difference with v.2.00

  • (27) For contexts without owners the function allows to add new owners only to database superuser. In v.2.00 the function allows to add specified owners to any logged IFD user (adding him to owners of the context at first)


Back to the API

Example of use

Image:Assignconstrainedvalues.jpg

The picture above shows an example of the intended use of addConsrainedValuesToMeasure. The relationship takes one or more values from a list of values and attach them to a concept.


Comments: