STM

STM is a domain of simplified functionality to support a web-client.


stm_node_get_children

QUERY_FUNCTION stm_node_get_children(
	id          : INTEGER;  -- node handler of interesting nodes domain (folder)


stm_open_node

QUERY_FUNCTION stm_open_node(
	id          : INTEGER)  -- node handler of interesting nodes domain (folder)
	: LIST OF stm_node_in_tree;


stm_node_get_file_system

QUERY_FUNCTION stm_node_get_file_system(
	id,
	depth       : INTEGER) -- -1 in in full depth, 0 - if only parent node, 1 - only first child level, etc.
	: stm_node_in_tree;


stm_node_get_representation

QUERY_FUNCTION stm_node_get_representation(
	id       : INTEGER)                 -- node handler
	: stm_node_representation;


stm_list_file_types

QUERY_FUNCTION stm_list_file_types:  LIST OF STRING;


stm_node_assign_file

QUERY_FUNCTION stm_node_assign_file(
	node        : INTEGER;  -- instance id of domain node
	name,                   -- file name (with extension)
	file_type,              -- file type familiar for the system
	link,                   -- link to external file or place where to get it on server
	description : STRING;   -- file comment/description


stm_file_extract

QUERY_FUNCTION stm_file_extract(
	file        : INTEGER;     -- file handler
	link        : STRING)      -- path to extract it
	: STRING;      -- id of the extracted BLOB in positive case


stm_node_get_properties

QUERY_FUNCTION stm_node_get_properties(
	n     : INTEGER)
	: LIST OF stm_property;


stm_node_get_remarks

QUERY_FUNCTION stm_node_get_remarks(
	id    : INTEGER)
	: LIST OF stm_remark;


stm_node_get_resolutions

QUERY_FUNCTION stm_node_get_resolutions(
	id          : INTEGER)
	: LIST OF stm_resolution;


stm_node_get_files

QUERY_FUNCTION stm_node_get_files(
	id    : INTEGER)
	: LIST OF stm_file;


stm_add_remark

QUERY_FUNCTION stm_add_remark(
	item        : INTEGER;     -- handler of commented item
	subj,                      -- subject of the comment
	remark      : STRING)      -- remark for the commented item
	: stm_remark;


stm_withdraw_remark

QUERY_FUNCTION stm_withdraw_remark(
	remark      : INTEGER)      -- handler of the comment
	: BOOLEAN;


stm_list_awalable_resolutions

QUERY_FUNCTION stm_list_awalable_resolutions:  LIST OF STRING;


stm_list_resolutions_awalable_for_me

QUERY_FUNCTION stm_list_resolutions_awalable_for_me(
	node_id  : INTEGER)
	: LIST OF STRING;


stm_node_add_resolution

QUERY_FUNCTION stm_node_add_resolution(
	node           : INTEGER;  -- handler of the assigned item
	resolution,                -- name of resolution (approval) type (normally should be selected from a list)
	remark         : STRING)   -- resolution comment/description/explanation
	: stm_resolution;


stm_withdraw_resolution

QUERY_FUNCTION stm_withdraw_resolution(
	resolution  : INTEGER)      -- handler of the resolution
	: BOOLEAN;


stm_get_latest_remarks

QUERY_FUNCTION stm_get_latest_remarks(
	after       : STRING;      -- get all remarks after the specified date
	page_size,                 -- no more then page_size (if page_size = 0 or unset return complete tree)
	page        : INTEGER)     -- starting from (page-1)*page_size
	: LIST OF stm_remark;


stm_node_delete

stm wrapper for node_delete_version NOTE: in contrast to node_delete_version it does not deal with versions or substitution and gives options to remove the node from one or all parents and adds explaining remark

QUERY_FUNCTION stm_node_delete(
	subject,                         -- node handler (EDM db id of the node) to be deleted
	parent   : INTEGER;              -- optional owning node handler (EDM db id of its node), by default will be removed from everywhere


stm_file_delete

stm wrapper for file_cancel and attached_file_delete NOTE: if optional parent node is specified the file shared by several nodes will be left in target data model, only attachment to the node is cancelled

QUERY_FUNCTION stm_file_delete(
	file,                            -- file handler (EDM db id of attached_file) to be deleted
	node     : INTEGER;              -- optional owning node handler (EDM db id of the node), by default removed from everywhere


stm_list_node_types

QUERY_FUNCTION stm_list_node_types:  LIST OF STRING;


stm_import_file_system

QUERY_FUNCTION stm_import_file_system(
	parent      :  INTEGER;          -- optional handler of the node to be put, could be unset or 0 to import the stuff as root items
	remark      :  STRING;           -- optional comment to updated parent folder
	items       :  LIST OF stm_file_system_item; -- list of file system items in breakdown order (all children just after parent node)

Back to Home page