Project

General

Profile

UniEditor » History » Version 9

Yuriy Shekochihin, 07/08/2011 12:31 PM

1 1 Viktoria Kopach
h1. UniEditor
2
3 6 Viktoria Kopach
{{toc}}
4
5 2 Viktoria Kopach
Содержит дерево требований с тест-кейсами (для краткости будем называть кейсами), каждый узел дерева содержит информацию о соответствующем требовании или кейсе.
6 1 Viktoria Kopach
7 2 Viktoria Kopach
h2. Узел-требование
8 1 Viktoria Kopach
9 2 Viktoria Kopach
Содержит:
10
# Имя требования (Name)
11
# Текст требования
12 3 Viktoria Kopach
* если требование имеет alternative description, то это оно и есть
13
* если требование не имеет alternative description, то это description
14
* если требование только что создано через Requality Explorer или через UniEditor
15 2 Viktoria Kopach
16
17
18
h2. Узел-кейс
19
20
Содержит:
21
# Test Case Number
22
# Описание (Test Case Description)
23
# Ожидаемый результат (Expected Result)
24 4 Viktoria Kopach
25 7 Viktoria Kopach
h2. Команды в редакторе
26 4 Viktoria Kopach
27
* Переходы вверх/вниз по дереву
28
* Добавить требование-брата
29
* Добавить требование-ребенка
30
* Добавить test case-ребенка
31
* Удалить выделенные узлы (Как выделить несколько? Нужно предупреждение, если у узла есть потомки? Нужна возможность отменить удаление?)
32
* Переместить узел (Предупреждение при наличии потомков?)
33
* Вход/выход из режима редактирования.
34 8 Yuriy Shekochihin
35
h2. Интерфейс UniEditor <-> Eclipse
36 9 Yuriy Shekochihin
37 8 Yuriy Shekochihin
<pre>
38
////////////////////////////////////////////////////////////////////////////////
39
// External functions implemented and injected by Requality
40
41
/*
42
 Request for the specific node data
43
 Input parameters:
44
  uuid - (String) uuid of the requested node
45
 Return value:
46
  String value containing JSON definition of the node. Possible values:
47
  a) for root element (''Requirements''):
48
   { type: null, 
49
     children: [''<uuid1>'', ''<uuid2>'', ...] }
50
  b) for requirement elements:
51
   { type: ''requirement'', id: ''<node_id>'', 
52
     description: ''<node_description>'', 
53
     children: [''<uuid1>'', ''<uuid2>'', ...] }
54
  b) for testcase elements:
55
   { type: ''testcase'', 
56
     id: ''<node_id>'', 
57
     description: ''<testcase_description>'', 
58
     result: ''<testcase_result>'', 
59
     status: ''<in progress|complete|verified>'' }
60
*/
61
function getNode(uuid);
62
63
/*
64
 Request for the root element of the selected subtree
65
 Input parameters:
66
  none
67
 Return value:
68
  String value containing uuid of the subtree root node
69
*/
70
function getStartNode();
71
72
/*
73
 Request to change the node ID
74
 Input parameters:
75
  uuid   - (String) uuid of the updated node
76
  new_id - (String) new ID to be set
77
 Return value:
78
  Boolean value: true if operation was successful, false otherwise
79
*/
80
function changeNodeId(uuid, new_id);
81
82
/*
83
 Request to change the value of one of the node attributes
84
 Input parameters:
85
  uuid      - (String) uuid of the updated node
86
  attr_name - (String) name of the changed attribute
87
  new_val   - (String) new attribute value to be set
88
 Return value:
89
  Boolean value: true if operation was successful, false otherwise
90
*/
91
function changeNodeAttr(uuid, attr_name, new_val);
92
93
/*
94
 Request to change the move a node into different subtree
95
 Input parameters:
96
  uuid            - (String) uuid of the moved node
97
  new_parent_uuid - (String) uuid of the new parent node
98
 Return value:
99
  Boolean value: true if operation was successful, false otherwise
100
*/
101
function changeNodeParent(uuid, new_parent_uuid);
102
103
/*
104
 Request to insert a new node
105
 Input parameters:
106
  uuid        - (String) uuid of the new node
107
  parent_uuid - (String) uuid of the parent node
108
 Return value:
109
  Boolean value: true if operation was successful, false otherwise
110
*/
111
function addNode(uuid, parent_uuid);
112
113
/*
114
 Request to remove a node with all its decendants
115
 Input parameters:
116
  uuid - (String) uuid of the removed node
117
 Return value:
118
  Boolean value: true if operation was successful, false otherwise
119
*/
120
function removeNode(uuid);
121
122
123
////////////////////////////////////////////////////////////////////////////////
124
// Callback functions that can be called by Requality
125
126
/*
127
 Callback function called by Requality when node or some of its children change outside of UniEditor
128
 Input parameters:
129
  uuid - (String) uuid of the updated node
130
 Return value:
131
  none
132
*/
133
function onChangeNode(uuid);
134
</pre>