Property

Property is a definition of some generic node characteristic that could be used then to specify a node feature via an assignment.

property_list_types

returns list of types acceptable for properties in target PBS

QUERY_FUNCTION property_list_types: LIST OF STRING


property_create

creates new property definition in current state of pbs according to provided input

To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION property_create(subject: v_property): v_property

Parameter:
subject input parameter of the property, see v_property
some attributes of the input are ignored, like the following:
  • subject.item.instance_id - generated
  • subject.item.cancelled - set to FALSE
  • subject.item.creator - set to logged in user
  • subject.item.last_changed - set to date/time of the call
  • subject.item.last_editor - set to logged in user
  • subject.item.comments - unset
  • subject.item.events - is populated with a creation event

Returns actual attributes of the newly registered property (see v_property)


property_get

gets data of a property definition specified by its instance id

To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION property_get(id: INTEGER): v_property

Parameter:
id id of the property instance

Returns actual data of the required property (see v_property)


property_list

lists data of property definitions specified by list of their instance id. Normally source of the list is v_pbs returned by pbs_get

To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION property_list(ids: LIST OF INTEGER): LIST OF v_property

Parameter:
ids list of interesting properties instance id-s

Returns list of actual data of the required properties (see v_property)


property_select

properties search is not implemented in current realize
QUERY_FUNCTION property_select(
      pbs,
      creator           : INTEGER;
      version,
      kind,
      applicable_to     : STRING)  :  LIST OF v_property
Parameters:
pbs (optional) instance id of parent pbs
creator (optional) instance id of person who introduced the property
version (optional) version of PBS where the property was introduced
kind (optional) property type
applicable_to (optional) type of applicable node

Returns list of found properties (see v_property)


property_update

updates data of property defined before. The property is specified by its instance id

To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION property_update(subject: v_property): v_property

Parameter:
subject updated data of the property definition to be updated in model (see v_property)
Target instance specified by subject.item.instance_id

The following attributes are ignored:

  • subject.item.introduced - is leaved as before
  • subject.item.creator - is leaved as before
  • subject.item.last_changed - set to current date/time
  • subject.item.last_editor - set to calling user
  • subject.item.comments - is leaved as before
  • subject.item.event - is added with update event

Returns actual data of the updated property definition (see v_property)


property_cancel

cancels property definition specified by its instance id in the target pbs. The property is declared as cancelled and could not be used any more in references after that. The instance of the property can be even removed from the model if it was not used in any relationships

To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION property_cancel(id: INTEGER): BOOLEAN

Parameter:
id instance id of the property to be cancelled

Returns TRUE if the instance deleted (was not used), FALSE if just cancelled

Back to Home page