SAP ABAP Interface /IPRO/IF_ASSEMBLE_DOC (Document Assembly Interface)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/INTERFACE (Package) BADI's, Interfaces

Properties

Interface	/IPRO/IF_ASSEMBLE_DOC
Short Description	Document Assembly Interface

General Data

Package	/IPRO/INTERFACE	BADI's, Interfaces
Created	20100610	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface /IPRO/IF_ASSEMBLE_DOC has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/IPRO/IF_WML_TEXTOBJECT	☐	☐	Text Object interface	20100610

Friends

Interface /IPRO/IF_ASSEMBLE_DOC has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_DOCB_DOCUMENT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20100610
2	M_FILLIN_DATA	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100610
3	M_TEXTX	Instance attribute	Public	☐	Type reference (TYPE)	XSTRING			20100610

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CLAUSE	Instance method	Public	Method		20100610
2	ADD_SECTION	Instance method	Public	Method		20100610
3	ASSEMBLE	Instance method	Public	Method	Assemble document	20100610
4	FIND_SECTION_FROM_TEXT	Instance method	Public	Method		20100610
5	GET_CLAUSELIST	Instance method	Public	Method		20100610
6	GET_CLAUSE_INDEX	Instance method	Public	Method		20100610
7	GET_FILLINS	Instance method	Public	Method		20100610
8	GET_FIRST_CLAUSE	Instance method	Public	Method		20100610
9	GET_FIRST_ELEMENT	Instance method	Public	Method		20100610
10	GET_FIRST_ELEMENT_IN_SECTION	Instance method	Public	Method		20100610
11	GET_SECTION_COUNT	Instance method	Public	Method		20100610
12	GET_VERSION	Instance method	Public	Method		20100610
13	GET_WORDML_DOCB_MAP	Instance method	Public	Method		20100610
14	IS_SECTION_EMPTY	Instance method	Public	Method		20100610
15	IS_SECTION_VACANT	Instance method	Public	Method		20100610
16	LOOKUP_CLAUSE	Instance method	Public	Method		20100610
17	LOOKUP_SECTION	Instance method	Public	Method		20100610
18	PROCESS	Instance method	Public	Method	Process document	20100610
19	PROTECT	Instance method	Public	Method		20100610
20	SET_DOCB_DOCUMENT	Instance method	Public	Method		20100610
21	SET_FILLINS	Instance method	Public	Method		20100610
22	SET_OVERLAY	Instance method	Public	Method		20100610
23	SET_PG_BREAK_ON_SECTION	Instance method	Public	Method		20100610
24	SET_SHOW_SECTION_TITLES	Instance method	Public	Method		20100610
25	SET_VERSION	Instance method	Public	Method		20100610
26	UPDATE_CLAUSE	Instance method	Public	Method		20100610

Events

Interface /IPRO/IF_ASSEMBLE_DOC has no event.

Types

Interface /IPRO/IF_ASSEMBLE_DOC has no local type.

Method Signatures

Method ADD_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CLAUSE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_CLAUSE		Clause interface	20100610

Method ADD_CLAUSE on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method ADD_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SECTION	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_SECTION		interface section	20100610

Method ADD_SECTION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method ASSEMBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TOC_SECTION_ORDER	Call by reference	☑	Type reference (TYPE)	NUMC4			20100610

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_WML_TEXT_EXCEPTION	☐		20100610

Method FIND_SECTION_FROM_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CLAUSE_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RV_SECTION_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100610

Method FIND_SECTION_FROM_TEXT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_CLAUSELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_CLAUSELIST	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_CLAUSELIST			20100610

Method GET_CLAUSELIST on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_CLAUSE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Importing	IV_SECTION	Value transfer	☑	Type reference (TYPE)	STRING			20100610
3	Returning	RV_INDEX	Value transfer	☐	Type reference (TYPE)	I			20100610

Method GET_CLAUSE_INDEX on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_FILLINS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20100610

Method GET_FILLINS on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_FIRST_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_FIRST_CLAUSE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_CLAUSE		Clause interface	20100610

Method GET_FIRST_CLAUSE on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_FIRST_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT			20100610
2	Returning	RO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT			20100610

Method GET_FIRST_ELEMENT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_FIRST_ELEMENT_IN_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SECTION	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ATTRIBUTE			20100610
2	Returning	RO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT			20100610

Method GET_FIRST_ELEMENT_IN_SECTION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_SECTION_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SECTION	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RV_COUNT	Value transfer	☐	Type reference (TYPE)	I			20100610

Method GET_SECTION_COUNT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VERSION	Value transfer	☐	Type reference (TYPE)	STRING			20100610

Method GET_VERSION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method GET_WORDML_DOCB_MAP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SECTION	Value transfer	☑	Type reference (TYPE)	STRING			20100610
2	Returning	RT_MAP	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_ELM_CLAUSE_MAPPING			20100610

Method GET_WORDML_DOCB_MAP on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method IS_SECTION_EMPTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SECTION	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	SEU_BOOL			20100610

Method IS_SECTION_EMPTY on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method IS_SECTION_VACANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SECTION	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	SEU_BOOL			20100610

Method IS_SECTION_VACANT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method LOOKUP_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RO_CLAUSE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_WML_CLAUSE			20100610

Method LOOKUP_CLAUSE on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method LOOKUP_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Value transfer	☐	Type reference (TYPE)	STRING			20100610
2	Returning	RO_SECTION	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_SECTION		interface section	20100610

Method LOOKUP_SECTION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_MODE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20100610

Method PROCESS on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method PROTECT Signature

Method PROTECT on Interface /IPRO/IF_ASSEMBLE_DOC has no parameter.
Method PROTECT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_DOCB_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DOCB_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT			20100610

Method SET_DOCB_DOCUMENT on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_FILLINS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILLIN_XML	Value transfer	☐	Type reference (TYPE)	STRING			20100610

Method SET_FILLINS on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_OVERLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OVERLAY	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_WML_OVERLAY			20100610

Method SET_OVERLAY on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_PG_BREAK_ON_SECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PG_BREAK_ON_SECTION	Value transfer	☐	Type reference (TYPE)	SEU_BOOL			20100610

Method SET_PG_BREAK_ON_SECTION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_SHOW_SECTION_TITLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SHOW_SECTION_TITLES	Value transfer	☐	Type reference (TYPE)	SEU_BOOL			20100610

Method SET_SHOW_SECTION_TITLES on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method SET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VERSION	Value transfer	☐	Type reference (TYPE)	STRING			20100610

Method SET_VERSION on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

Method UPDATE_CLAUSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT			20100610
2	Importing	IV_LOCATION	Value transfer	☐	Type reference (TYPE)	I			20100610

Method UPDATE_CLAUSE on Interface /IPRO/IF_ASSEMBLE_DOC has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	703