Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 374.1
bearbeitet von tleu
am 01.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 390.2
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Hilfe.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.tleu
1 +XWiki.carina
Inhalt
... ... @@ -1,68 +1,420 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
5 +{{/layout-section}}
6 +
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -====== Inhalt: ======
9 +\\
10 +{{/layout-cell}}
5 5  
12 +{{layout-cell}}
13 +{{scroll-ignore}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
6 6  
7 7  
8 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
17 +{{toc/}}
18 +{{/panel}}
19 +{{/scroll-ignore}}
9 9  {{/layout-cell}}
21 +{{/layout-section}}
10 10  
23 +{{layout-section ac:type="single"}}
11 11  {{layout-cell}}
12 -|=(% colspan="1" %)(% colspan="1" %)
25 +== Allgemeines ==
26 +
27 +Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
28 +
29 +(% class="wrapped" %)
30 +|(((
31 +armSite
32 +)))|(((
33 +Anmeldung von Folgerequests beim ONYX Reporter.
34 +)))
35 +|(((
36 +initiateSite
37 +)))|(((
38 +Initiiert die Reporter-Session (Übertragung des CPs).
39 +)))
40 +|(((
41 +disarmSite
42 +)))|(((
43 +Freigabe von allen Reporter-Ressourcen für diese Session.
44 +)))
45 +|(((
46 +getResultValues
47 +)))|(((
48 +Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
49 +)))
50 +|(% colspan="1" %)(% colspan="1" %)
13 13  (((
14 -Programmversion
52 +getResultVariables
15 15  )))|(% colspan="1" %)(% colspan="1" %)
16 16  (((
17 -
55 +Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
18 18  )))
19 -|=(((
20 -Status
57 +
58 +== Anmeldung des LMS ==
59 +
60 +{{code language="xml" title="Anmeldung des LMS"}}
61 +@WebMethod(operationName = „armSite")
62 +public String armSite(
63 +@WebParam(name = „version") final Integer version,
64 +@WebParam(name = „userId") final String userId,
65 +@WebParam(name = „optionalRole") final Integer role,
66 +@WebParam(name = „secretToShare") final String secretToShare,
67 +@WebParam(name = „optionalUserLastName") final String userLastName,
68 +@WebParam(name = „optionalUserFirstName") final String userFirstName,
69 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
70 +}
71 +{{/code}}
72 +
73 +=== Parameter armSite ===
74 +
75 +(% class="wrapped" %)
76 +|(((
77 +version
21 21  )))|(((
22 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
79 +Angefragte Version: 1
23 23  )))
24 -|=(((
25 -Aufgaben
81 +|(((
82 +userId
26 26  )))|(((
27 -
84 +UserId des anfragenden Reporter-Benutzers
85 +)))
86 +|(((
87 +optionalRole
88 +)))|(((
89 +Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
90 +)))
91 +|(((
92 +secretToShare
93 +)))|(((
94 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
95 +)))
96 +|(((
97 +optionalUserLastName
98 +)))|(((
99 +Optional. Nachname des Benutzers.
100 +)))
101 +|(% colspan="1" %)(% colspan="1" %)
102 +(((
103 +optionalUserFirstName
104 +)))|(% colspan="1" %)(% colspan="1" %)
105 +(((
106 +Optional. Vorname des Benutzers.
107 +)))
108 +|(% colspan="1" %)(% colspan="1" %)
109 +(((
110 +additionalParams
111 +)))|(% colspan="1" %)(% colspan="1" %)
112 +(((
113 +Reserved for future use.
114 +)))
28 28  
29 -
116 +=== ReturnValue armSite ===
117 +
118 +(% class="wrapped" %)
119 +|(((
120 +String
121 +)))|(((
122 +Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
30 30  )))
31 -|=(((
32 -JIRA
124 +
125 +== Initialisierung durch LMS ==
126 +
127 +{{code language="xml" title="Initialisierung durch LMS"}}
128 +@WebMethod(operationName = „initiateSite")
129 +public String initiateSite(
130 +@WebParam(name = „version") final Integer version,
131 +@WebParam(name = „sessionId") final String sessionId,
132 +@WebParam(name = „secretToShare") final String secretToShare,
133 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
134 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
135 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
136 +}
137 +{{/code}}
138 +
139 +=== Parameter initiateSite ===
140 +
141 +(% class="wrapped" %)
142 +|(((
143 +version
33 33  )))|(((
34 -
145 +Angefragte Version: 1
35 35  )))
147 +|(% colspan="1" %)(% colspan="1" %)
148 +(((
149 +sessionId
150 +)))|(% colspan="1" %)(% colspan="1" %)
151 +(((
152 +SessionId, wie von armSite zurück geliefert.
153 +)))
154 +|(((
155 +secretToShare
156 +)))|(((
157 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
158 +)))
159 +|(((
160 +students
161 +)))|(((
162 +Liste der Studenten mit ihren Resultaten. Siehe unten.
163 +)))
164 +|(((
165 +optionalContentPackage
166 +)))|(((
167 +Optional. Content Package (gezippt) als Byte-Array.
168 +)))
169 +|(((
170 +additionalParams
171 +)))|(((
172 +Reserved for future use.
173 +)))
174 +
175 +=== ReturnValue initiateSite ===
176 +
177 +(% class="wrapped" %)
178 +|(((
179 +String
180 +)))|(((
181 +Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
182 +
183 +* sid: Session ID, wie von armSite zurück gegeben
184 +* uid: Student ID, wie in initiateSite beim Reporter angemeldet
185 +)))
186 +
187 +{{code language="xml"}}
188 +public class ResultsForStudent {
189 +   private String studentId = „";
190 +   private String firstname = „";
191 +   private String lastname = „";
192 +   private String groupname = „";
193 +   private String tutorname = „";
194 +   private File contentFile = null;
195 +   private byte[] resultsFile = null;
196 +}
197 +{{/code}}
198 +
199 +== Abmeldung durch LMS ==
200 +
201 +\\
202 +
203 +{{code}}
204 +@WebMethod(operationName = „disarmSite")
205 +public Boolean disarmSite(
206 +@WebParam(name = „version") final Integer version,
207 +@WebParam(name = „sessionId") final String sessionId,
208 +@WebParam(name = „secretToShare") final String secretToShare,
209 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
210 +}
211 +{{/code}}
212 +
213 +\\
214 +
215 +=== Parameter disarmSite ===
216 +
217 +(% class="wrapped" %)
218 +|(((
219 +version
220 +)))|(((
221 +Angefragte Version: 1
222 +)))
223 +|(% colspan="1" %)(% colspan="1" %)
224 +(((
225 +sessionId
226 +)))|(% colspan="1" %)(% colspan="1" %)
227 +(((
228 +SessionId, wie von armSite zurück geliefert.
229 +)))
230 +|(((
231 +secretToShare
232 +)))|(((
233 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
234 +)))
235 +|(((
236 +additionalParams
237 +)))|(((
238 +Reserved for future use.
239 +)))
240 +
241 +=== ReturnValue disarmSite ===
242 +
243 +(% class="wrapped" %)
244 +|(((
245 +Boolean
246 +)))|(((
247 +True bei Erfolg, sonst false.
248 +)))
249 +
250 +== Abfrage von Lernerresultaten durch LMS ==
251 +
252 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
253 + @WebMethod(operationName = „getResultValues")
254 +public HashMapWrapper getResultValues(
255 + @WebParam(name = „version") final Integer version,
256 + @WebParam(name = „sessionId") final String sessionId,
257 + @WebParam(name = „secretToShare") final String secretToShare,
258 + @WebParam(name = „requestedValues") final HashMap<String, String>
259 + requestedValues,
260 + @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
261 +}
262 +{{/code}}
263 +
264 +=== Parameter getResultValues ===
265 +
266 +(% class="wrapped" %)
267 +|(((
268 +version
269 +)))|(((
270 +Angefragte Version: 1
271 +)))
272 +|(% colspan="1" %)(% colspan="1" %)
273 +(((
274 +sessionId
275 +)))|(% colspan="1" %)(% colspan="1" %)
276 +(((
277 +SessionId, wie von armSite zurück geliefert.
278 +)))
279 +|(((
280 +secretToShare
281 +)))|(((
282 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
283 +)))
284 +|(((
285 +requestedValues
286 +)))|(((
287 +Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
288 +)))
289 +|(((
290 +additionalParams
291 +)))|(((
292 +Reserved for future use.
293 +)))
294 +
295 +=== ReturnValue getResultValues ===
296 +
297 +(% class="wrapped" %)
298 +|(((
299 +HashMap<String, String>
300 +)))|(((
301 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
302 +)))
303 +
304 +== Abfrage von Ergebnisvariablen durch LMS ==
305 +
306 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
307 + @WebMethod(operationName = „getResultVariables")
308 +public HashMapWrapper getResultVariables(
309 +@WebParam(name = „version") final Integer version,
310 +@WebParam(name = „contentPackage") final byte[] contentPackage,
311 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
312 +}
313 +{{/code}}
314 +
315 +=== Parameter getResultVariables ===
316 +
317 +(% class="wrapped" %)
318 +|(((
319 +version
320 +)))|(((
321 +Angefragte Version: 1
322 +)))
323 +|(((
324 +contentPackage
325 +)))|(((
326 +Content Package (gezippt) als Byte-Array.
327 +)))
328 +|(((
329 +additionalParams
330 +)))|(((
331 +Reserved for future use.
332 +)))
333 +
334 +=== ReturnValue getResultVariables ===
335 +
336 +(% class="wrapped" %)
337 +|(((
338 +HashMap<String, String>
339 +)))|(((
340 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
341 +)))
342 +
343 +== Wrapper ==
344 +
345 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
346 +
347 +=== Wrapper für die HashMap<String, String> ===
348 +
349 +HashMapWrapper.java:
350 +
351 +[[image:attach:HashMapWrapperjava.png]]
352 +
353 +[[image:attach:HashMapWrapperjava2.png]]
354 +
355 +=== Wrapper für die ArrayList<ResultsForStudent> ===
356 +
357 +ResultsForStudentsWrapper.java:
358 +
359 +[[image:attach:ResultsForStudentsWrapperjava.png]]
36 36  {{/layout-cell}}
37 37  {{/layout-section}}
38 38  
363 +{{layout-section ac:type="two_right_sidebar"}}
364 +{{layout-cell}}
365 +\\
366 +{{/layout-cell}}
367 +
368 +{{layout-cell}}
369 +====== relevante Links: ======
370 +
371 +* [[doc:ONYX Player Interface]]
372 +{{/layout-cell}}
373 +{{/layout-section}}
374 +{{/layout}}
375 +{{/sv-translation}}
376 +
377 +{{sv-translation language="en"}}
378 +{{layout}}
379 +{{layout-section ac:type="two_equal"}}
380 +{{layout-cell}}
381 +====== Content: ======
382 +
383 +
384 +
385 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
386 +{{/layout-cell}}
387 +
388 +{{layout-cell}}
389 +
390 +{{/layout-cell}}
391 +{{/layout-section}}
392 +
39 39  {{layout-section ac:type="single"}}
40 40  {{layout-cell}}
41 -== Allgemeines ==
395 +== General information ==
42 42  
43 -Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
397 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
44 44  
45 45  |(((
46 46  armSite
47 47  )))|(((
48 -Anmeldung von Folgerequests beim ONYX Reporter.
402 +Registration of sequence requests at the ONYX Reporter
49 49  )))
50 50  |(((
51 51  initiateSite
52 52  )))|(((
53 -Initiiert die Reporter-Session (Übertragung des CPs).
407 +Initiates the Reporter session (transmission of the CP).
54 54  )))
55 55  |(((
56 56  disarmSite
57 57  )))|(((
58 -Freigabe von allen Reporter-Ressourcen für diese Session.
412 +Release of all Reporter resources for this session.
59 59  )))
60 60  |(((
61 61  getResultValues
62 62  )))|(((
63 -Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung:
64 -
65 -Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
417 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
66 66  )))
67 67  |(% colspan="1" %)(% colspan="1" %)
68 68  (((
... ... @@ -69,12 +69,13 @@
69 69  getResultVariables
70 70  )))|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
424 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
73 73  )))
74 74  
75 -== Anmeldung des LMS ==
427 +== Login through the LMS ==
76 76  
77 -{{code title="Anmeldung des LMS" language="xml"}}@WebMethod(operationName = „armSite")
429 +{{code language="xml" title="Login through the LMS"}}
430 +@WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
80 80  @WebParam(name = „userId") final String userId,
... ... @@ -83,53 +83,289 @@
83 83  @WebParam(name = „optionalUserLastName") final String userLastName,
84 84  @WebParam(name = „optionalUserFirstName") final String userFirstName,
85 85  @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
86 -}{{/code}}Parameter armSite
439 +}
440 +{{/code}}
87 87  
442 +=== Parameter armSite ===
443 +
88 88  |(((
89 -
445 +version
90 90  )))|(((
91 -
447 +Requested version: 1
92 92  )))
93 93  |(((
94 -
450 +userId
95 95  )))|(((
96 -
452 +UserId of the requested Reporter user
97 97  )))
98 98  |(((
99 -
455 +optionalRole
100 100  )))|(((
101 -
457 +Optional. User role. 0 = student, 1 = tutor
102 102  )))
103 103  |(((
104 -
460 +secretToShare
105 105  )))|(((
106 -
462 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
107 107  )))
108 108  |(((
109 -
465 +optionalUserLastName
110 110  )))|(((
467 +Optional. Last name of the user.
468 +)))
469 +|(% colspan="1" %)(% colspan="1" %)
470 +(((
471 +optionalUserFirstName
472 +)))|(% colspan="1" %)(% colspan="1" %)
473 +(((
474 +Optional. First name of the user.
475 +)))
476 +|(% colspan="1" %)(% colspan="1" %)
477 +(((
478 +additionalParams
479 +)))|(% colspan="1" %)(% colspan="1" %)
480 +(((
481 +Reserved for future use.
482 +)))
483 +
484 +=== ReturnValue armSite ===
485 +
486 +|(((
487 +String
488 +)))|(((
489 +Session ID which has to be used to mark any other Reporter call.
490 +)))
491 +
492 +== Initialisation through LMS ==
493 +
494 +{{code language="xml" title="Initialisation through LMS"}}
495 +@WebMethod(operationName = „initiateSite")
496 +public String initiateSite(
497 +@WebParam(name = „version") final Integer version,
498 +@WebParam(name = „sessionId") final String sessionId,
499 +@WebParam(name = „secretToShare") final String secretToShare,
500 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
501 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
502 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
503 +}
504 +{{/code}}
505 +
506 +=== Parameter initiateSite ===
507 +
508 +|(((
509 +version
510 +)))|(((
511 +Requested version: 1
512 +)))
513 +|(% colspan="1" %)(% colspan="1" %)
514 +(((
515 +sessionId
516 +)))|(% colspan="1" %)(% colspan="1" %)
517 +(((
518 +SessionId, as returned by armSite.
519 +)))
520 +|(((
521 +secretToShare
522 +)))|(((
523 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
524 +)))
525 +|(((
526 +students
527 +)))|(((
528 +List of students and their results. See below.
529 +)))
530 +|(((
531 +optionalContentPackage
532 +)))|(((
533 +Optional. Content package (zipped) as byte array.
534 +)))
535 +|(((
536 +additionalParams
537 +)))|(((
538 +Reserved for future use.
539 +)))
540 +
541 +=== ReturnValue initiateSite ===
542 +
543 +|(((
544 +String
545 +)))|(((
546 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
547 +
548 +* sid: Session ID, as returned by armSite
549 +* (((
550 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
551 +)))
552 +)))
553 +
554 +{{code language="xml"}}
555 +public class ResultsForStudent {
556 +   private String studentId = „";
557 +   private String firstname = „";
558 +   private String lastname = „";
559 +   private String groupname = „";
560 +   private String tutorname = „";
561 +   private File contentFile = null;
562 +   private byte[] resultsFile = null;
563 +}
564 +{{/code}}
565 +
566 +== Logout through the LMS ==
567 +
111 111  
569 +
570 +{{code}}
571 +@WebMethod(operationName = „disarmSite")
572 +public Boolean disarmSite(
573 +@WebParam(name = „version") final Integer version,
574 +@WebParam(name = „sessionId") final String sessionId,
575 +@WebParam(name = „secretToShare") final String secretToShare,
576 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
577 +}
578 +{{/code}}
579 +
580 +
581 +
582 +=== Parameter disarmSite ===
583 +
584 +|(((
585 +version
586 +)))|(((
587 +Requested version: 1
112 112  )))
589 +|(% colspan="1" %)(% colspan="1" %)
590 +(((
591 +sessionId
592 +)))|(% colspan="1" %)(% colspan="1" %)
593 +(((
594 +SessionId, as returned by armSite.
595 +)))
596 +|(((
597 +secretToShare
598 +)))|(((
599 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
600 +)))
601 +|(((
602 +additionalParams
603 +)))|(((
604 +Reserved for future use.
605 +)))
113 113  
114 -= Überschrift2 =
607 +=== ReturnValue disarmSite ===
115 115  
116 -Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetuer. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.
117 -{{/layout-cell}}
118 -{{/layout-section}}
609 +|(((
610 +Boolean
611 +)))|(((
612 +True in the case of success, otherwise false.
613 +)))
119 119  
120 -{{layout-section ac:type="two_right_sidebar"}}
121 -{{layout-cell}}
122 -====== untergeordnete Seiten: ======
615 +== Request of learner results through the LMS ==
123 123  
617 +{{code language="xml" title="Request of learner results through the LMS"}}
618 + @WebMethod(operationName = „getResultValues")
619 +public HashMapWrapper getResultValues(
620 + @WebParam(name = „version") final Integer version,
621 + @WebParam(name = „sessionId") final String sessionId,
622 + @WebParam(name = „secretToShare") final String secretToShare,
623 + @WebParam(name = „requestedValues") final HashMap<String, String>
624 + requestedValues,
625 + @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
626 +}
627 +{{/code}}
124 124  
629 +=== Parameter getResultValues ===
125 125  
126 -{{children all="true"/}}
127 -{{/layout-cell}}
631 +|(((
632 +version
633 +)))|(((
634 +Requested version: 1
635 +)))
636 +|(% colspan="1" %)(% colspan="1" %)
637 +(((
638 +sessionId
639 +)))|(% colspan="1" %)(% colspan="1" %)
640 +(((
641 +SessionId, as returned by armSite.
642 +)))
643 +|(((
644 +secretToShare
645 +)))|(((
646 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
647 +)))
648 +|(((
649 +requestedValues
650 +)))|(((
651 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
652 +)))
653 +|(((
654 +additionalParams
655 +)))|(((
656 +Reserved for future use.
657 +)))
128 128  
129 -{{layout-cell}}
130 -====== relevante Links: ======
659 +=== ReturnValue getResultValues ===
131 131  
132 -* [[lorem ipsum>>url:https://www.bps-system.de/help/display/OPAL/Handbuch+OPAL||shape="rect"]]
661 +|(((
662 +HashMap<String, String>
663 +)))|(((
664 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
665 +)))
666 +
667 +== Request of result variables through the LMS ==
668 +
669 +{{code language="xml" title="Request of result variables through the LMS"}}
670 + @WebMethod(operationName = „getResultVariables")
671 +public HashMapWrapper getResultVariables(
672 +@WebParam(name = „version") final Integer version,
673 +@WebParam(name = „contentPackage") final byte[] contentPackage,
674 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
675 +}
676 +{{/code}}
677 +
678 +=== Parameter getResultVariables ===
679 +
680 +|(((
681 +version
682 +)))|(((
683 +Requested version: 1
684 +)))
685 +|(((
686 +contentPackage
687 +)))|(((
688 +Content package (zipped) as byte array.
689 +)))
690 +|(((
691 +additionalParams
692 +)))|(((
693 +Reserved for future use.
694 +)))
695 +
696 +=== ReturnValue getResultVariables ===
697 +
698 +|(((
699 +HashMap<String, String>
700 +)))|(((
701 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
702 +)))
703 +
704 +== Wrapper ==
705 +
706 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
707 +
708 +=== Wrapper for HashMap<String, String> ===
709 +
710 +HashMapWrapper.java:
711 +
712 +[[image:attach:HashMapWrapperjava.png]]
713 +
714 +[[image:attach:HashMapWrapperjava2.png]]
715 +
716 +=== Wrapper for the ArrayList<ResultsForStudent> ===
717 +
718 +ResultsForStudentsWrapper.java:
719 +
720 +[[image:attach:ResultsForStudentsWrapperjava.png]]
133 133  {{/layout-cell}}
134 134  {{/layout-section}}
135 135  {{/layout}}
724 +{{/sv-translation}}
HashMapWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342392
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342392/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter