1
2---
3
4# assignAdminsToCourse
5
6This activity allows the assignment of multiple course administrators.
7
8## Location
9
10Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
11Temporary Location: Will be moved to location under control of the relevant maintainer
12
13## API
14
15ilModulesCourseTasks
16
17## Method
18
19assignAdminsToCourse
20
21## Inputs
22
23* crsRefId
24
25	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
26
27* usrIdList
28
29	A list ( an array ) of integer values which are supposed to be user-object-ids.
30	Such may be gathered from methods reading participants, e.g. readLearnersFromCourse or readAdminsFromCourse.
31
32## Outputs
33
34None.
35
36## Sample Modelling / Usage
37
38	<bpmn2:callActivity id="CallActivity_5" name="AssignAdminsToCourse">
39		<bpmn2:extensionElements>
40		<ilias:properties>
41			<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
42			api="ilModulesCourseTasks" method="assignAdminsToCourse"/>
43		</ilias:properties>
44		</bpmn2:extensionElements>
45		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
46		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
47		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
48			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
49		</bpmn2:dataInputAssociation>
50		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
51			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
52		</bpmn2:dataInputAssociation>
53	</bpmn2:callActivity>
54
55---
56
57# assignTutorToCourse
58
59This activity allows the assignment of multiple course tutors.
60
61## Location
62
63Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
64Temporary Location: Will be moved to location under control of the relevant maintainer
65
66## API
67
68ilModulesCourseTasks
69
70## Method
71
72assignTutorsToCourse
73
74## Inputs
75
76* crsRefId
77
78	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
79
80* usrIdList
81
82	A list ( an array ) of integer values which are supposed to be user-object-ids.
83	Such may be gathered from methods reading participants, e.g. readLearnersFromCourse or readAdminsFromCourse.
84
85## Outputs
86
87None.
88
89## Sample Modelling / Usage
90
91	<bpmn2:callActivity id="CallActivity_5" name="AssignTutorsToCourse">
92		<bpmn2:extensionElements>
93		<ilias:properties>
94			<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
95			api="ilModulesCourseTasks" method="assignTutorsToCourse"/>
96		</ilias:properties>
97		</bpmn2:extensionElements>
98		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
99		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
100		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
101			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
102		</bpmn2:dataInputAssociation>
103		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
104			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
105		</bpmn2:dataInputAssociation>
106	</bpmn2:callActivity>
107
108---
109
110# assignLearnersToCourse
111
112This activity allows the assignment of multiple learners to a course.
113
114## Location
115
116Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
117Temporary Location: Will be moved to location under control of the relevant maintainer
118
119## API
120
121ilModulesCourseTasks
122
123## Method
124
125assignLearnersToCourse
126
127## Inputs
128
129* crsRefId
130
131	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
132
133* usrIdList
134
135	A list ( an array ) of integer values which are supposed to be user-object-ids.
136	Such may be gathered from methods reading participants, e.g. readLearnersFromCourse or readAdminsFromCourse.
137
138## Outputs
139
140None.
141
142## Sample Modelling / Usage
143
144	<bpmn2:callActivity id="CallActivity_5" name="AssignTutorsToCourse">
145		<bpmn2:extensionElements>
146		<ilias:properties>
147			<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
148			api="ilModulesCourseTasks" method="assignLearnersToCourse"/>
149		</ilias:properties>
150		</bpmn2:extensionElements>
151		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
152		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
153		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
154			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
155		</bpmn2:dataInputAssociation>
156		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
157			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
158		</bpmn2:dataInputAssociation>
159	</bpmn2:callActivity>
160
161---
162
163# createCourse
164
165This activity allows the creation of a course.
166
167## Location
168
169Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
170Temporary Location: Will be moved to location under control of the relevant maintainer
171
172## API
173
174ilModulesCourseTasks
175
176## Method
177
178createCourse
179
180## Inputs
181
182* crsTitle
183
184	String with the name of the course to be created.
185
186* destRefId
187
188	Ref-ID where the new course is to be created.
189
190## Outputs
191
192* crsRefId
193
194	Course Reference ID as seen in the URL of ILIAS (ref-id - Parameter)
195
196## Sample Modelling / Usage
197
198	<bpmn2:callActivity id="CallActivity_5" name="CreateCourse">
199		<bpmn2:extensionElements>
200			<ilias:properties>
201				<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
202				api="ilModulesCourseTasks" method="createCourse"/>
203			</ilias:properties>
204		</bpmn2:extensionElements>
205		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
206		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
207		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
208			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
209		</bpmn2:dataInputAssociation>
210		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
211			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
212		</bpmn2:dataInputAssociation>
213	</bpmn2:callActivity>
214
215---
216
217# readAdminsFromCourse
218
219This activity reads users assigned as course administrators.
220
221## Location
222
223Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
224Temporary Location: Will be moved to location under control of the relevant maintainer
225
226## API
227
228ilModulesCourseTasks
229
230## Method
231
232readAdminsFromCourse
233
234## Inputs
235
236* crsRefId
237
238	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
239
240## Outputs
241
242* usrIdList
243
244	A list ( an array ) of integer values which are supposed to be user-object-ids.
245
246## Sample Modelling / Usage
247
248	<bpmn2:callActivity id="CallActivity_5" name="ReadAdminsFromCourse">
249		<bpmn2:extensionElements>
250			<ilias:properties>
251				<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
252				api="ilModulesCourseTasks" method="readAdminsFromCourse"/>
253			</ilias:properties>
254		</bpmn2:extensionElements>
255		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
256		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
257		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
258			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
259		</bpmn2:dataInputAssociation>
260		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
261			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
262		</bpmn2:dataInputAssociation>
263	</bpmn2:callActivity>
264
265---
266
267# readTutorsFromCourse
268
269This activity reads users assigned as course tutors.
270
271## Location
272
273Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
274Temporary Location: Will be moved to location under control of the relevant maintainer
275
276## API
277
278ilModulesCourseTasks
279
280## Method
281
282readTutorsFromCourse
283
284## Inputs
285
286* crsRefId
287
288	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
289
290## Outputs
291
292* usrIdList
293
294	A list ( an array ) of integer values which are supposed to be user-object-ids.
295
296## Sample Modelling / Usage
297
298	<bpmn2:callActivity id="CallActivity_5" name="ReadTutorsFromCourse">
299		<bpmn2:extensionElements>
300			<ilias:properties>
301				<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
302				api="ilModulesCourseTasks" method="readTutorsFromCourse"/>
303			</ilias:properties>
304		</bpmn2:extensionElements>
305		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
306		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
307		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
308			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
309		</bpmn2:dataInputAssociation>
310		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
311			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
312		</bpmn2:dataInputAssociation>
313	</bpmn2:callActivity>
314
315---
316
317# readLearnersFromCourse
318
319This activity reads users assigned as learners.
320
321## Location
322
323Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php
324Temporary Location: Will be moved to location under control of the relevant maintainer
325
326## API
327
328ilModulesCourseTasks
329
330## Method
331
332readLearnersFromCourse
333
334## Inputs
335
336* crsRefId
337
338	Course Reference ID as seen in the URL of ILIAS (ref_id - Parameter)
339
340## Outputs
341
342* usrIdList
343
344	A list ( an array ) of integer values which are supposed to be user-object-ids.
345
346## Sample Modelling / Usage
347
348	<bpmn2:callActivity id="CallActivity_5" name="ReadLearnersFromCourse">
349		<bpmn2:extensionElements>
350			<ilias:properties>
351				<ilias:libraryCall location="Services/WorkflowEngine/classes/tasks/class.ilModulesCourseTasks.php"
352				api="ilModulesCourseTasks" method="readLearnersFromCourse"/>
353			</ilias:properties>
354		</bpmn2:extensionElements>
355		<bpmn2:incoming>SequenceFlow_5</bpmn2:incoming>
356		<bpmn2:outgoing>SequenceFlow_6</bpmn2:outgoing>
357		<bpmn2:dataInputAssociation id="DataInputAssociation_6">
358			<bpmn2:sourceRef>DataObjectReference_4</bpmn2:sourceRef>
359		</bpmn2:dataInputAssociation>
360		<bpmn2:dataInputAssociation id="DataInputAssociation_1">
361			<bpmn2:sourceRef>DataObjectReference_7</bpmn2:sourceRef>
362		</bpmn2:dataInputAssociation>
363	</bpmn2:callActivity>
364
365---