Method

Method is definition of some common way to perform a generic task. Then assigned task will refer to the definition.

method_list_types

returns list of all possible types of methods definitions

QUERY_FUNCTION method_list_types: LIST OF STRING

method_create

defines new generic method for tasks 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 method_create(subject: v_method): v_method

Parameter:

subject

input parameters of newly defining method, see v_method
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 defined method (see v_method)

method_get

gets data of the method 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 method_get(id: INTEGER): v_method

Parameter:

id	id of the method instance

Returns actual data of the required method (see v_method)

method_list

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

QUERY_FUNCTION method_list(ids: LIST OF INTEGER): LIST OF v_method

Parameter:

ids

list of interesting method instance id-s

Returns list of actual data of the required methods (see v_method)

method_select

methods search is not implemented in current realize

QUERY_FUNCTION method_select(
      pbs,
      creator           : INTEGER;
      version          : STRING;
      kind              : STRING)  :  LIST OF v_method

Parameters:

pbs	(optional) instance id of parent pbs
creator	(optional) instance id of person who introduced the method
version	(optional) version of PBS where the method was introduced
kind	(optional) method type

Returns list of found methods (see v_method)

method_update

updates data of method defined before. The method 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 method_update(subject: v_method): v_method

Parameter:

subject

updated data of the method definition to be updated in model (see v_method)
subject.item.instance_id is used to identify updated instance

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 method definition (see v_method)

method_cancel

cancels method definition specified by its instance id in the pbs. The method is declared as cancelled and could not be used any more in references after that. The instance of the method 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 method_cancel(id: INTEGER): BOOLEAN

Parameter:

id	instance id of the method to be cancelled

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

Back to Home page