File: GNOME_MrProject_TaskManager.idl

package info (click to toggle)
mrproject 0.5.1-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 5,136 kB
  • ctags: 4,114
  • sloc: ansic: 40,041; sh: 7,059; makefile: 1,107; yacc: 318; python: 111
file content (211 lines) | stat: -rw-r--r-- 5,241 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2000-2001 CodeFactory AB
 * Copyright (C) 2000-2001 Richard Hult <rhult@codefactory.se>
 * Copyright (C) 2001      Mikael Hallendal <micke@codefactory.se>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Richard Hult
 */

#ifndef GNOME_MRPROJECT_TASK_MANAGER_IDL
#define GNOME_MRPROJECT_TASK_MANAGER_IDL

module GNOME {
	
	module MrProject {

		enum TaskFixedType {
			TASK_FIXED_WORK,
			TASK_FIXED_UNIT,
			TASK_FIXED_DURATION
		};

		enum TaskType {
			TASK_MILESTONE,
			TASK_SUMMARY,
			TASK_NORMAL
		};

		enum DependencyType {
			DEPENDENCY_SS, /* start-to-start */
			DEPENDENCY_SF, /* start-to-finish */
			DEPENDENCY_FS, /* finish-to-start */
			DEPENDENCY_FF  /* finish-to-finish */
		};
		
		struct Dependency {
			Id			depId;
			DependencyType		type;
			Id			taskId;
			Id			predecessorId;
			string                  empty; /* FIXME: if we don't have this,
							* we have a fixed size struct
							* which is treated like a basic type... 
							*/
		};

		typedef sequence<Dependency>	DependencySeq;

		enum TaskPropertyType {
			TASK_PROPERTY_ID,
			TASK_PROPERTY_PARENT_ID,
			TASK_PROPERTY_NAME,
			TASK_PROPERTY_START,
			TASK_PROPERTY_END,
			TASK_PROPERTY_DURATION,
			TASK_PROPERTY_PREDECESSORS,
			TASK_PROPERTY_PRIORITY,
			TASK_PROPERTY_PERCENT_COMPLETE
		};

		struct TaskProperty {
			TaskPropertyType	type;
			any			value;
		};
		
		/* FIXME: Make this the "real" task data later? */
		typedef sequence<TaskProperty>	PropertySeq;

		struct Task {
			Id			taskId;
			Id			parentId;
			string			name;
			Time			start;
			Time			end;
			TaskType                type;
			short                   percentComplete;
		};

		typedef sequence<Task>		TaskSeq;

		enum TaskOrderType {
			TASK_BEFORE,
			TASK_AFTER
		};

		enum TaskEdge {
			TASK_START,
			TASK_END
		};

		interface TaskManager : Bonobo::Unknown {

			exception NoSuchTask {
				ErrorMessage msg;
			};

			exception NoSuchSibling {
				ErrorMessage msg;				
			};

			exception NoSuchParent {
				ErrorMessage msg;
			};
			
			exception NoSuchPredecessor {
				ErrorMessage msg;
			};

			attribute ProjectState state;
			
			/* Creates a task with default values. */
			Task createTask		();

			Id insertTask		(in Task t,
						 in Id   parentId)			raises (NoSuchParent);

			Id insertTaskFull       (in Task t,
						 in Id   parentId,
						 in Id   siblingId,
						 in TaskOrderType type)			raises (NoSuchParent);

			void moveTask		(in Id taskId,
						 in Time startTime,
						 in TaskEdge relativeEdge);
			void setTaskDuration	(in Id taskId,
						 in Time duration,
						 in TaskEdge relativeEdge);
			
			void updateTask		(in Id   taskId,
						 in Task t)				raises (NoSuchTask);
			
			void reparentTask       (in Id   taskId,
						 in Id   parentId)			raises (NoSuchTask);

			void repositionTask	(in Id                taskId,
						 in Id                siblingId,
						 in TaskOrderType     type)		raises (NoSuchTask,
												NoSuchSibling);

			Task getTask		(in Id taskId)				raises (NoSuchTask);
			TaskSeq getAllTasks	();
			IdSeq getAllTaskIdsSorted();
			void removeTasks	(in IdSeq taskIds)			raises (NoSuchTask);

			/* Dependencies. */
			Id linkTasks            (in Id              taskId,
						 in Id              predecessorId,
						 in DependencyType  type)		raises (NoSuchTask);
			void unlinkTasks        (in Id taskId, in Id predecessorId)	raises (NoSuchTask,
												NoSuchPredecessor);
			void removeDependency   (in Id linkId)				/*raises (NoSuchLink)*/;

			Dependency getDependency (in Id dependencyId);			/*raises (NoSuchLink)*/
			DependencySeq getPredecessors (in Id taskId)			raises (NoSuchTask);
			DependencySeq getSuccessors   (in Id taskId)			raises (NoSuchTask);

			/* Notes */
			
			void setNote            (in Id              taskId,
						 in string          note);
			
			string getNote          (in Id              taskId);
			
			/* For debugging: */
			void dumpTree           ();
		};

		/*
		 * Structures that are passed with events.
		 */

		struct EventTaskReparented {
			Id			taskId;
			Id			newParentId;
		};

		struct EventTaskRepositioned {
			TaskOrderType           type;
			Id			taskId;
			Id                      siblingId;
		};

		struct EventTaskInserted {
			Task                    theTask;
			Id                      siblingId;
			TaskOrderType           type;
		};
		
		struct EventNoteChanged {
			Id                      taskId;
			string                  note;
		};
	};
};

#endif