SAP ABAP Class CL_XDC_DOCUMENT (Obsolete! Please do not use!)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CCM-PRN (Application Component) Print and Output Management
     ⤷ S_XDC_SUPPLEMENTARY (Package) Supplementary functionalities for XDC

Properties

Class	CL_XDC_DOCUMENT
Short Description	Obsolete! Please do not use!
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_XDC_SUPPLEMENTARY	Supplementary functionalities for XDC
Created	20100210	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_XDC_DOCUMENT has no interface implemented.

Friends

Class CL_XDC_DOCUMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	INPUT_TRAY_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20100210
2	IXML	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML			20100210
3	MEDIUM_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20100210
4	OUTPUT_TRAY_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20100210
5	SEQUENCE_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	I			20100210
6	STREAMFACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_STREAM_FACTORY			20100210
7	XDC_DATA	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20100210
8	XDC_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20100210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20100210
2	GET_DOCUMENT	Instance method	Public	Method		20100210
3	GET_ELEMENT_ID_BY_INDEX	Instance method	Private	Method		20100210
4	GET_FIRST_INPUT_TRAY	Instance method	Public	Method		20100210
5	GET_FIRST_MEDIUM	Instance method	Public	Method		20100210
6	GET_FIRST_OUTPUT_TRAY	Instance method	Public	Method		20100210
7	GET_FIRST_SEQUENCE	Instance method	Public	Method		20100210
8	GET_INPUT_TRAY	Instance method	Public	Method		20100210
9	GET_MEDIUM	Instance method	Public	Method		20100210
10	GET_NEXT_INPUT_TRAY	Instance method	Public	Method		20100210
11	GET_NEXT_MEDIUM	Instance method	Public	Method		20100210
12	GET_NEXT_OUTPUT_TRAY	Instance method	Public	Method		20100210
13	GET_NEXT_SEQUENCE	Instance method	Public	Method		20100210
14	GET_OPTION	Instance method	Public	Method		20100210
15	GET_OUTPUT_TRAY	Instance method	Public	Method		20100210
16	GET_REQUIRED_NODE	Instance method	Public	Method		20100210
17	GET_SEQUENCE	Instance method	Public	Method		20100210
18	GET_XDC_FILE	Instance method	Public	Method		20100210
19	PARSE_XML_STREAM	Instance method	Private	Method		20100210
20	SET_ID	Instance method	Public	Method		20100210
21	SET_INPUT_TRAY	Instance method	Public	Method		20100210
22	SET_NAME	Instance method	Public	Method		20100210
23	SET_OPTION	Instance method	Public	Method		20100210
24	SET_OUTPUT_TRAY	Instance method	Public	Method		20100210

Events

Class CL_XDC_DOCUMENT has no event.

Types

Class CL_XDC_DOCUMENT has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_XDC_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20100210

Method CONSTRUCTOR on class CL_XDC_DOCUMENT has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20100210

Method GET_DOCUMENT on class CL_XDC_DOCUMENT has no exception.

Method GET_ELEMENT_ID_BY_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Importing	IM_ID_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	I			20100210
4	Returning	RE_ID_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20100210

Method GET_ELEMENT_ID_BY_INDEX on class CL_XDC_DOCUMENT has no exception.

Method GET_FIRST_INPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_INPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_MEDIUM	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Exporting	EX_TRAY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_FIRST_INPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_FIRST_MEDIUM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MEDIUM_STOCK	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_FIRST_MEDIUM on class CL_XDC_DOCUMENT has no exception.

Method GET_FIRST_OUTPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_BIN	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_OUTPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_FIRST_OUTPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_FIRST_SEQUENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SEQUENCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XDC_ELEMENT			20100210

Method GET_FIRST_SEQUENCE on class CL_XDC_DOCUMENT has no exception.

Method GET_INPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MEDIUM	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Exporting	EX_TRAY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100210
5	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	I	1		20100210
6	Importing	IM_INPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_INPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_MEDIUM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_LONG	Call by reference	☐	Type reference (TYPE)	F			20100210
2	Exporting	EX_LONG_UNIT	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100210
4	Exporting	EX_SHORT	Call by reference	☐	Type reference (TYPE)	F			20100210
5	Exporting	EX_SHORT_UNIT	Call by reference	☐	Type reference (TYPE)	STRING			20100210
6	Importing	IM_MEDIUM_STOCK	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_MEDIUM on class CL_XDC_DOCUMENT has no exception.

Method GET_NEXT_INPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_INPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_MEDIUM	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Exporting	EX_TRAY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_NEXT_INPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_NEXT_MEDIUM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_MEDIUM_STOCK	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_NEXT_MEDIUM on class CL_XDC_DOCUMENT has no exception.

Method GET_NEXT_OUTPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_BIN	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_OUTPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_NEXT_OUTPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_NEXT_SEQUENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SEQUENCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XDC_ELEMENT			20100210

Method GET_NEXT_SEQUENCE on class CL_XDC_DOCUMENT has no exception.

Method GET_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_OPTION_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100210
3	Importing	IM_OPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_OPTION on class CL_XDC_DOCUMENT has no exception.

Method GET_OUTPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_BIN	Call by reference	☐	Type reference (TYPE)	STRING			20100210
2	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100210
3	Exporting	EX_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Importing	IM_OUTPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_OUTPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method GET_REQUIRED_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE			20100210
2	Importing	IV_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Importing	IV_ATTR_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Importing	IV_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210

#	Exception	Resumable	Description	Created on
1	CX_XDC_PDL_CMD	☐		20100210

Method GET_SEQUENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SEQUENCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XDC_ELEMENT			20100210
2	Importing	IM_SEQUENCE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method GET_SEQUENCE on class CL_XDC_DOCUMENT has no exception.

Method GET_XDC_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NEW_XDC_DATA	Value transfer	☐	Type reference (TYPE)	XSTRING			20100210

Method GET_XDC_FILE on class CL_XDC_DOCUMENT has no exception.

Method PARSE_XML_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING			20100210
2	Returning	RE_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20100210

Method PARSE_XML_STREAM on class CL_XDC_DOCUMENT has no exception.

Method SET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100217
2	Importing	IM_XDC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method SET_ID on class CL_XDC_DOCUMENT has no exception.

Method SET_INPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100217
2	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	I	0		20100210
3	Importing	IM_INPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
4	Importing	IM_MEDIUM	Call by reference	☐	Type reference (TYPE)	STRING			20100210
5	Importing	IM_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210
6	Importing	IM_TRAY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method SET_INPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

Method SET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100217
2	Importing	IM_XDC_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method SET_NAME on class CL_XDC_DOCUMENT has no exception.

Method SET_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100210
2	Importing	IM_OPTION_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Importing	IM_OPTION_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method SET_OPTION on class CL_XDC_DOCUMENT has no exception.

Method SET_OUTPUT_TRAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100217
2	Importing	IM_BIN	Call by reference	☐	Type reference (TYPE)	STRING			20100210
3	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	I	0		20100210
4	Importing	IM_OUTPUT_TRAY_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100210
5	Importing	IM_TRAY_NUMBER	Call by reference	☐	Type reference (TYPE)	STRING			20100210

Method SET_OUTPUT_TRAY on class CL_XDC_DOCUMENT has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	740