-
Notifications
You must be signed in to change notification settings - Fork 53
/
CLAS_ZSAPLINK_DOCUMENTATION.slnk
432 lines (385 loc) · 18.3 KB
/
CLAS_ZSAPLINK_DOCUMENTATION.slnk
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<?xml version="1.0" encoding="iso-8859-1"?>
<CLAS CLSNAME="ZSAPLINK_DOCUMENTATION" VERSION="1" LANGU="E" DESCRIPT="SAPlink - Documentation" UUID="D337FA9004AE78469B570F1DFC6880C5" CATEGORY="00" EXPOSURE="2" STATE="1" RELEASE="0" AUTHOR="BCUSER" CREATEDON="20070923" CHANGEDBY="BCUSER" CHANGEDON="00000000" CHGDANYON="00000000" CLSFINAL="X" CLSCCINCL="X" FIXPT="X" UNICODE="X" R3RELEASE="700" CLSBCCAT="00" DURATION_TYPE="0 " RISK_LEVEL="0 " REFCLSNAME="ZSAPLINK">
<publicSection>class ZSAPLINK_DOCUMENTATION definition
public
inheriting from ZSAPLINK
final
create public .
*"* public components of class ZSAPLINK_DOCUMENTATION
*"* do not include other source files here!!!
public section.
methods CHECKEXISTS
redefinition .
methods CREATEIXMLDOCFROMOBJECT
redefinition .
methods CREATEOBJECTFROMIXMLDOC
redefinition .</publicSection>
<protectedSection>*"* protected components of class ZSAPLINK_TABLES
*"* do not include other source files here!!!
protected section.
methods DELETEOBJECT
redefinition .
methods GETOBJECTTYPE
redefinition .</protectedSection>
<privateSection>*"* private components of class ZSAPLINK_TABLES
*"* do not include other source files here!!!
private section.</privateSection>
<localImplementation>*"* local class implementation for public class
*"* use this source file for the implementation part of
*"* local helper classes</localImplementation>
<localTypes>*"* use this source file for any type declarations (class
*"* definitions, interfaces or data types) you need for method
*"* implementation or private method's signature</localTypes>
<localMacros>*"* use this source file for any macro definitions you need
*"* in the implementation part of the class</localMacros>
<inheritance CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" STATE="1" AUTHOR="BCUSER" CREATEDON="20070923" CHANGEDON="00000000">
<redefinition CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" MTDNAME="CHECKEXISTS"/>
<redefinition CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" MTDNAME="CREATEIXMLDOCFROMOBJECT"/>
<redefinition CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" MTDNAME="CREATEOBJECTFROMIXMLDOC"/>
<redefinition CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" MTDNAME="DELETEOBJECT"/>
<redefinition CLSNAME="ZSAPLINK_DOCUMENTATION" REFCLSNAME="ZSAPLINK" VERSION="1" MTDNAME="GETOBJECTTYPE"/>
</inheritance>
<method CLSNAME="ZSAPLINK" CMPNAME="CHECKEXISTS" VERSION="0" EXPOSURE="0" STATE="0" EDITORDER="0 " DISPID="0 " CREATEDON="00000000" CHANGEDON="00000000" MTDTYPE="0" MTDDECLTYP="0" BCMTDCAT="00" BCMTDSYN="0">
<source>*/---------------------------------------------------------------------\
*| This file is part of SAPlink. |
*| |
*| SAPlink 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. |
*| |
*| SAPlink 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 SAPlink; if not, write to the |
*| Free Software Foundation, Inc., |
*| 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
*\---------------------------------------------------------------------/
METHOD checkexists.
* Plugin created by:
* Rich Heilman
DATA xdokhl TYPE dokhl.
DATA xdoc_object(62) TYPE c.
DATA xdocu_id TYPE dokhl-id.
DATA xdocu_obj TYPE dokhl-object.
xdoc_object = objname.
xdocu_id = xdoc_object(2).
xdocu_obj = xdoc_object+2(60).
CLEAR xdokhl.
SELECT SINGLE * INTO xdokhl FROM dokhl
WHERE id = xdocu_id
AND object = xdocu_obj.
IF sy-subrc = 0.
exists = 'X'.
ENDIF.
ENDMETHOD.</source>
</method>
<method CLSNAME="ZSAPLINK" CMPNAME="CREATEIXMLDOCFROMOBJECT" VERSION="0" EXPOSURE="0" STATE="0" EDITORDER="0 " DISPID="0 " CREATEDON="00000000" CHANGEDON="00000000" MTDTYPE="0" MTDDECLTYP="0" BCMTDCAT="00" BCMTDSYN="0">
<source>*/---------------------------------------------------------------------\
*| This file is part of SAPlink. |
*| |
*| SAPlink 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. |
*| |
*| SAPlink 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 SAPlink; if not, write to the |
*| Free Software Foundation, Inc., |
*| 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
*\---------------------------------------------------------------------/
METHOD createixmldocfromobject.
* Plugin created by:
* Rich Heilman
DATA root_node TYPE REF TO if_ixml_element.
DATA txtlines_node TYPE REF TO if_ixml_element.
DATA rc TYPE sysubrc.
DATA _objtype TYPE string.
DATA: BEGIN OF xdokhl,
objname(62) TYPE c,
id TYPE dokhl-id,
object TYPE dokhl-object,
typ TYPE dokhl-typ,
dokversion TYPE dokhl-dokversion,
END OF xdokhl.
DATA ilines TYPE TABLE OF tline.
DATA xlines LIKE LINE OF ilines.
DATA _docuname TYPE e071-obj_name.
DATA xdocu_id TYPE dokhl-id.
DATA xdocu_obj TYPE dokhl-object.
_docuname = objname.
* Separate id and object from combined object name
xdocu_id = _docuname(2).
xdocu_obj = _docuname+2(60).
* Check against database
CLEAR xdokhl.
SELECT SINGLE id object typ dokversion
INTO (xdokhl-id, xdokhl-object, xdokhl-typ, xdokhl-dokversion)
FROM dokhl
WHERE id = xdocu_id
AND object = xdocu_obj.
IF sy-subrc <> 0.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING textid = zcx_saplink=>error_message
msg = `Documentation object not found, use full ` &
`object name including ID and Object(example DTZTEST`.
ENDIF.
xdokhl-objname = _docuname.
* Create parent node
_objtype = getobjecttype( ).
root_node = xmldoc->create_element( _objtype ).
me->setattributesfromstructure( node = root_node structure = xdokhl ).
* Read the documentation text
CALL FUNCTION 'DOCU_READ'
EXPORTING
id = xdokhl-id
langu = sy-langu
object = xdokhl-object
typ = xdokhl-typ
version = xdokhl-dokversion
TABLES
line = ilines.
* Write records to XML node
LOOP AT ilines INTO xlines.
txtlines_node = xmldoc->create_element( `TextLines` ).
me->setattributesfromstructure( node = txtlines_node structure = xlines ).
rc = root_node->append_child( txtlines_node ).
ENDLOOP.
* Add node
rc = xmldoc->append_child( root_node ).
ixmldocument = xmldoc.
ENDMETHOD.</source>
</method>
<method CLSNAME="ZSAPLINK" CMPNAME="CREATEOBJECTFROMIXMLDOC" VERSION="0" EXPOSURE="0" STATE="0" EDITORDER="0 " DISPID="0 " CREATEDON="00000000" CHANGEDON="00000000" MTDTYPE="0" MTDDECLTYP="0" BCMTDCAT="00" BCMTDSYN="0">
<source>*/---------------------------------------------------------------------\
*| This file is part of SAPlink. |
*| |
*| SAPlink 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. |
*| |
*| SAPlink 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 SAPlink; if not, write to the |
*| Free Software Foundation, Inc., |
*| 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
*\---------------------------------------------------------------------/
METHOD createobjectfromixmldoc.
* Plugin created by:
* Rich Heilman
DATA root_node TYPE REF TO if_ixml_element.
DATA txtline_node TYPE REF TO if_ixml_element.
DATA txtline_filter TYPE REF TO if_ixml_node_filter.
DATA txtline_iterator TYPE REF TO if_ixml_node_iterator.
DATA: BEGIN OF xdokhl,
objname(62) TYPE c,
id TYPE dokhl-id,
object TYPE dokhl-object,
typ TYPE dokhl-typ,
dokversion TYPE dokhl-dokversion,
END OF xdokhl.
DATA: ilines TYPE TABLE OF tline.
DATA: objname TYPE e071-obj_name.
DATA _objtype TYPE string.
FIELD-SYMBOLS: <xlines_wa> LIKE LINE OF ilines.
_objtype = getobjecttype( ).
xmldoc = ixmldocument.
root_node = xmldoc->find_from_name( _objtype ).
* Get Root
me->getstructurefromattributes(
EXPORTING node = root_node
CHANGING structure = xdokhl ).
objname = xdokhl-objname.
* Get TextLines from XML
FREE: txtline_filter, txtline_iterator, txtline_node.
txtline_filter = xmldoc->create_filter_name( `TextLines` ).
txtline_iterator = xmldoc->create_iterator_filtered( txtline_filter ).
txtline_node ?= txtline_iterator->get_next( ).
WHILE txtline_node IS NOT INITIAL.
APPEND INITIAL LINE TO ilines ASSIGNING <xlines_wa>.
me->getstructurefromattributes(
EXPORTING node = txtline_node
CHANGING structure = <xlines_wa> ).
txtline_node ?= txtline_iterator->get_next( ).
ENDWHILE.
CALL FUNCTION 'RS_ACCESS_PERMISSION'
EXPORTING
global_lock = 'X'
mode = 'INSERT'
object = objname
object_class = 'DOCV'
EXCEPTIONS
canceled_in_corr = 1
enqueued_by_user = 3
enqueue_system_failure = 4
locked_by_author = 5
illegal_parameter_values = 6
no_modify_permission = 7
no_show_permission = 8
permission_failure = 9.
IF sy-subrc <> 0.
CASE sy-subrc.
WHEN 7 OR 8 OR 9.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING
textid = zcx_saplink=>not_authorized.
WHEN 5.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING
textid = zcx_saplink=>error_message
msg = 'object locked'.
WHEN OTHERS.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING
textid = zcx_saplink=>system_error.
ENDCASE.
ENDIF.
DATA checkexists TYPE flag.
checkexists = checkexists( ).
IF checkexists IS NOT INITIAL.
IF overwrite IS INITIAL.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING textid = zcx_saplink=>existing.
ELSE.
* delete object for new install
deleteobject( ).
ENDIF.
ENDIF.
CALL FUNCTION 'RS_CORR_INSERT'
EXPORTING
object = objname
object_class = 'DOCV'
mode = 'INSERT'
global_lock = 'X'
* devclass = devclass
author = sy-uname
master_language = sy-langu
EXCEPTIONS
cancelled = 1
permission_failure = 2
unknown_objectclass = 3.
IF sy-subrc <> 0.
CASE sy-subrc.
WHEN 2.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING
textid = zcx_saplink=>not_authorized.
WHEN OTHERS.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING
textid = zcx_saplink=>system_error.
ENDCASE.
ENDIF.
CALL FUNCTION 'DOCU_UPD'
EXPORTING
id = xdokhl-id
langu = sy-langu
object = xdokhl-object
typ = xdokhl-typ
TABLES
line = ilines
EXCEPTIONS
ret_code = 1
OTHERS = 2.
IF sy-subrc <> 0.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING textid = zcx_saplink=>error_message
msg = `Documentation object import failed`.
ENDIF.
name = objname.
ENDMETHOD.</source>
</method>
<method CLSNAME="ZSAPLINK" CMPNAME="DELETEOBJECT" VERSION="0" EXPOSURE="0" STATE="0" EDITORDER="0 " DISPID="0 " CREATEDON="00000000" CHANGEDON="00000000" MTDTYPE="0" MTDDECLTYP="0" BCMTDCAT="00" BCMTDSYN="0">
<source>*/---------------------------------------------------------------------\
*| This file is part of SAPlink. |
*| |
*| SAPlink 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. |
*| |
*| SAPlink 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 SAPlink; if not, write to the |
*| Free Software Foundation, Inc., |
*| 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
*\---------------------------------------------------------------------/
METHOD deleteobject.
* Plugin created by:
* Rich Heilman
DATA xdokhl TYPE dokhl.
DATA _docuname TYPE e071-obj_name.
DATA xdocu_id TYPE dokhl-id.
DATA xdocu_obj TYPE dokhl-object.
_docuname = objname.
xdocu_id = _docuname(2).
xdocu_obj = _docuname+2(60).
CLEAR xdokhl.
SELECT SINGLE * INTO xdokhl
FROM dokhl
WHERE id = xdocu_id
AND object = xdocu_obj.
CALL FUNCTION 'DOCU_DEL'
EXPORTING
id = xdokhl-id
langu = sy-langu
object = xdokhl-object
typ = xdokhl-typ
EXCEPTIONS
ret_code = 1
OTHERS = 2.
IF sy-subrc <> 0.
RAISE EXCEPTION TYPE zcx_saplink
EXPORTING textid = zcx_saplink=>error_message
msg = `Error when deleting existing documentation object`.
ENDIF.
ENDMETHOD.</source>
</method>
<method CLSNAME="ZSAPLINK" CMPNAME="GETOBJECTTYPE" VERSION="0" EXPOSURE="0" STATE="0" EDITORDER="0 " DISPID="0 " CREATEDON="00000000" CHANGEDON="00000000" MTDTYPE="0" MTDDECLTYP="0" BCMTDCAT="00" BCMTDSYN="0">
<source>*/---------------------------------------------------------------------\
*| This file is part of SAPlink. |
*| |
*| SAPlink 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. |
*| |
*| SAPlink 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 SAPlink; if not, write to the |
*| Free Software Foundation, Inc., |
*| 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
*\---------------------------------------------------------------------/
method GETOBJECTTYPE.
* Plugin created by:
* Rich Heilman
objecttype = 'DOCV'. "Documentation
endmethod.</source>
</method>
</CLAS>