SAP ABAP Class /IPRO/IF_DOCB_ELEMENT (Interface to document builder element)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	/IPRO/IF_ACTION	Document Builder Action Interface	20040721
2	Interface composition (i COMPRISING i_ref)	/IPRO/IF_DOCB_ATTRIBUTE	Attribute	20040121

Properties

Class	/IPRO/IF_DOCB_ELEMENT
Short Description	Interface to document builder element
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20040121	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class /IPRO/IF_DOCB_ELEMENT has no forward declaration.

Interfaces

Class /IPRO/IF_DOCB_ELEMENT has no interface implemented.

Friends

Class /IPRO/IF_DOCB_ELEMENT has no friend class.

Attributes

Class /IPRO/IF_DOCB_ELEMENT has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTACHMENT	Instance method	Public	Method		20070508
2	ASSEMBLE	Instance method	Public	Method	Assemble Clause	20041215
3	CHECK_MATERIAL_CHANGE	Instance method	Public	Method	Check for material/imaterial change	20070225
4	CREATE_NOTE	Instance method	Public	Method	Create note for element	20041007
5	CREATE_VERSION	Instance method	Public	Method	Create a new version of the element	20070425
6	DELETE_ELEMENT_ATTACHMENT	Instance method	Public	Method		20070508
7	DELETE_NOTE	Instance method	Public	Method	Delete note from element	20041007
8	GET_ALT_ELEMENTS	Instance method	Public	Method	Get all alternative element	20060907
9	GET_BY_REF_TXT	Instance method	Public	Method	Get by reference text	20040121
10	GET_COMMENT_FULL_TXT	Instance method	Public	Method		20070510
11	GET_CUSTELM_ID	Instance method	Public	Method	Get custom element ID	20040121
12	GET_EDIT_HISTORY	Instance method	Public	Method	Get the edit history for element	20040610
13	GET_ELEMENT_ATTACHMENTS	Instance method	Public	Method		20070508
14	GET_ELEMENT_FORMAT	Instance method	Public	Method	Get element format	20070710
15	GET_ELEMENT_TYPE	Instance method	Public	Method	Get element type	20040121
16	GET_ELEMENT_UPDATE	Instance method	Public	Method	Get element update	20040716
17	GET_ELEMENT_UPDATE_PARENT	Instance method	Public	Method	Get element update parent	20080725
18	GET_ELEMNT_CATEGORY	Instance method	Public	Method	Get the element category for Workflow	20070209
19	GET_FILLIN_VARIABLES	Instance method	Public	Method	Get fillin variables	20040123
20	GET_FULL_TXT	Instance method	Public	Method	Get full text	20040121
21	GET_GUIDE_TXT	Instance method	Public	Method	Get guidance text	20040121
22	GET_INTENDED_USE_FULL_TXT	Instance method	Public	Method		20070510
23	GET_MODE	Instance method	Public	Method	Get element mode	20040723
24	GET_NEXT	Instance method	Public	Method	Get the next element in linked list	20040211
25	GET_NOTE	Instance method	Public	Method	Get element note	20041007
26	GET_ORIGIN_ELEMENT_ID	Instance method	Public	Method	Get the origin element	20070503
27	GET_OUTPUT_TYPE	Instance method	Public	Method	Get the output type for element	20040629
28	GET_PREDECESSOR	Instance method	Public	Method	Get the predecessor version	20070225
29	GET_PRESC_TXT	Instance method	Public	Method	Get prescription text	20040121
30	GET_PREVIOUS	Instance method	Public	Method	Get the previous element in linked list	20040211
31	GET_PROPERTIES	Instance method	Public	Method	Get element properties	20040121
32	GET_PURORG	Instance method	Public	Method	Returns all associated purch org	20070405
33	GET_REP_STATE	Instance method	Public	Method	Returns the internal rep state as number	20070404
34	GET_RULE	Instance method	Public	Method	Get FOBU Rule	20040326
35	GET_SOURCE_ELM_FOR_CUSTELM	Instance method	Public	Method	Get the source element object	20070510
36	GET_SOURCE_ID_FOR_CUSTELM	Instance method	Public	Method	Get the element source ID for custom element	20040121
37	GET_STATUS	Instance method	Public	Method	Get status (Include, Exclude, Optional,etc)	20040121
38	GET_STDELM_ID	Instance method	Public	Method	Get standard element ID	20040121
39	GET_TELMNT_ROW	Instance method	Public	Method	Return field structure of type telmnt	20061204
40	GET_UPDATE_STATUS	Instance method	Public	Method	Get the element update status	20041026
41	GET_URL	Instance method	Public	Method		20070503
42	GET_USRELM_ID	Instance method	Public	Method	Get user element ID	20040121
43	GET_WF_GUID	Instance method	Public	Method	Get the Workflow GUID	20070212
44	GET_WHERE_USED_LIST	Instance method	Public	Method	where used list	20070531
45	HAS_ALT_ELEMENTS	Instance method	Public	Method	Has the element alternatives?	20060912
46	HIDE_ELEMENT	Instance method	Public	Method	Hides the element by setting the status to US	20080809
47	IS_EDITABLE	Instance method	Public	Method	Is the standard element editable ?	20040625
48	IS_EXCLUDED	Instance method	Public	Method	Is the element included	20040305
49	IS_IBR	Instance method	Public	Method	Element is included by reference (true/false)	20040121
50	IS_INCLUDED	Instance method	Public	Method	Is the element included	20040305
51	IS_NOTE_APPENDED	Instance method	Public	Method	Is note appended?	20041013
52	IS_OPTIONAL	Instance method	Public	Method	Element is optional (true/false)	20040121
53	IS_RECOMMENDED	Instance method	Public	Method	Element is recommended (true/false)	20040805
54	IS_REQUIRED	Instance method	Public	Method	Element is required (true/false)	20040121
55	IS_UPDATE_AVAILABLE	Instance method	Public	Method	Is element update available	20040716
56	PAGE_BREAK	Instance method	Public	Method	Insert page break?	20041021
57	PROCESS_ELEMENT_UPDATE	Instance method	Public	Method	Update element	20040716
58	RECORD_HISTORY	Instance method	Public	Method	Record the element's edit history	20040630
59	REJECT_ELEMENT_UPDATE	Instance method	Public	Method	Reject element update	20040929
60	RESET_STATUS	Instance method	Public	Method	Reset the element status to original configuration status	20041109
61	SET_ALT_ELEMENTS	Instance method	Public	Method	Insert one alternative element	20070427
62	SET_COMMENT_FULL_TXT	Instance method	Public	Method		20070510
63	SET_ELEMENT_FORMAT	Instance method	Public	Method	Set element format	20070710
64	SET_ELEMENT_UPDATE	Instance method	Public	Method	Set element update	20040716
65	SET_ELEMENT_UPDATE_PARENT	Instance method	Public	Method	Set the Update Element's parent	20080725
66	SET_ELEMNT_CATEGORY	Instance method	Public	Method		20070418
67	SET_FULL_TXT	Instance method	Public	Method	Set full text	20040121
68	SET_IBR_PROPERTY	Instance method	Public	Method	Set the IBR property of the clause	20040621
69	SET_INTENDED_USE_FULL_TXT	Instance method	Public	Method		20070510
70	SET_NOTE	Instance method	Public	Method	Set the element note	20041007
71	SET_ORIGIN_ELEMENT_ID	Instance method	Public	Method	Set the origin element	20070503
72	SET_OUTPUT_TYPE	Instance method	Public	Method	Set the output type for element	20070418
73	SET_PAGE_BREAK	Instance method	Public	Method	Set page break for section header	20041021
74	SET_PURORG	Instance method	Public	Method	sets the associated purch org	20070405
75	SET_STATUS	Instance method	Public	Method	Set status (Include, Exclude, Optional,etc)	20040121
76	SET_TELMNT_ROW	Instance method	Public	Method	Set structure of type telmnt	20070221
77	SET_UPDATE_STATUS	Instance method	Public	Method	Set element update status	20041026
78	UNHIDE_ELEMENT	Instance method	Public	Method	Retrieves its original status	20080809

Events

Class /IPRO/IF_DOCB_ELEMENT has no event.

Types

Class /IPRO/IF_DOCB_ELEMENT has no local type.

Method Signatures

Method ADD_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Content	20070508
2	Importing	IV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	/IPRO/CONTENT_TYPE		Content Type	20070508
3	Importing	IV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Filename	20070508
4	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	/IPRO/TITLE		Description	20070508
5	Returning	RO_ATTACHMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ATTACHMENT		DocB Document Attachment	20070508

Method ADD_ATTACHMENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method ASSEMBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CLAUSE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Clauses (Raw Format)	20050106
2	Importing	IV_STYLE	Call by reference	☑	Type reference (TYPE)	/IPRO/STYLE		Document Style	20041215
3	Returning	RS_CLAUSE	Value transfer	☐	Type reference (TYPE)	/IPRO/S_OUTPUT		Clause Data	20041216

Method ASSEMBLE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method CHECK_MATERIAL_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIO_SOURCE_ELEMENT	Call by reference	☑	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to document builder element	20070510
2	Returning	PRV_MATERIAL_CHANGE	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20070225

Method CHECK_MATERIAL_CHANGE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method CREATE_NOTE Signature

Method CREATE_NOTE on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method CREATE_NOTE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method CREATE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIS_REF_ELEMENT	Call by reference	☑	Type reference (TYPE)	/IPRO/S_ELMNT_ID		keyfields	20070425
2	Returning	PRO_NEW_VERSION	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to document builder element	20070425

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_OPEN_APPROVAL	☐	another approval version	20070425

Method DELETE_ELEMENT_ATTACHMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ATTACHMENT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ATTACHMENT		DocB Document Attachment	20070508

Method DELETE_ELEMENT_ATTACHMENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method DELETE_NOTE Signature

Method DELETE_NOTE on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method DELETE_NOTE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ALT_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRT_ALT_ELEMENTS	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_STDELMRES		Alternative Element IDs	20060907

Method GET_ALT_ELEMENTS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_BY_REF_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SPRAS	SY-LANGU	Language Key	20050414
2	Returning	RO_BY_REF_TXT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Text Class	20040121

Method GET_BY_REF_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_COMMENT_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SPRAS		Language Key	20070510
2	Returning	RO_FULL_TXT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Document Builder Element Text Class	20070510

Method GET_COMMENT_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_CUSTELM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CUSTELM_ID	Value transfer	☐	Type reference (TYPE)	GUID		Globally Unique Identifier	20040121

Method GET_CUSTELM_ID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_EDIT_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_HISTORY	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_EDIT_HIST		Element Edit History	20040610

Method GET_EDIT_HISTORY on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMENT_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRT_DOCUMENT_ATTACHMENTS	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_ATTACH		Element Attachments Table Type	20070508

Method GET_ELEMENT_ATTACHMENTS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMENT_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRT_FORMAT	Value transfer	☐	Type reference (TYPE)	/IPRO/TTELM_FMT		Maintain relationship between elements and formats	20070711

Method GET_ELEMENT_FORMAT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMENT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ELM_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Element Type	20040128
2	Exporting	EV_ELM_TYPE_DESCR	Value transfer	☐	Type reference (TYPE)	STRING		Element Type Description	20040128

Method GET_ELEMENT_TYPE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMENT_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_UPDATE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Element Update	20040716

Method GET_ELEMENT_UPDATE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMENT_UPDATE_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_UPDATE_PARENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Update Element's Parent	20080725

Method GET_ELEMENT_UPDATE_PARENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ELEMNT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRV_ELMNT_CATEGORY	Value transfer	☐	Type reference (TYPE)	/IPRO/ELEMENT_CATEGORY		Element Category	20070209

Method GET_ELEMNT_CATEGORY on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_FILLIN_VARIABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRT_FILLIN_VARS	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_ELM_FILLIN		Element Fillin Variables	20040123

Method GET_FILLIN_VARIABLES on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SPRAS		Language Key	20050414
2	Returning	RO_FULL_TXT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		DOCB Text Class	20040121

Method GET_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_GUIDE_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_GUIDE_TXT	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_DOCB_TEXT		DocB Text Table	20040121

Method GET_GUIDE_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_INTENDED_USE_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SPRAS		Language Key	20070510
2	Returning	RO_FULL_TXT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Document Builder Element Text Class	20070510

Method GET_INTENDED_USE_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_MODE	Value transfer	☐	Type reference (TYPE)	/IPRO/MODE		Mode	20040723

Method GET_MODE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_NEXT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Next element in linked list	20040211

Method GET_NEXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_DOC_GUID	Call by reference	☐	Type reference (TYPE)	GUID		Document GUID	20101207
2	Returning	RO_NOTE	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Note	20041007

Method GET_NOTE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_ORIGIN_ELEMENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ORIGIN_ELEMENT_ID	Value transfer	☐	Type reference (TYPE)	/IPRO/S_ELMNT_ID		Structure for element identification	20070503

Method GET_ORIGIN_ELEMENT_ID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_OUTPUT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OTYPE	Value transfer	☐	Type reference (TYPE)	/IPRO/OTYPE		Output Type	20040629

Method GET_OUTPUT_TYPE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_PREDECESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRO_PREDECESSOR	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to document builder element	20070225

Method GET_PREDECESSOR on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_PRESC_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PRESC_TXT	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_DOCB_TEXT		Text Objects Table Type	20040121

Method GET_PRESC_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_PREVIOUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_PREVIOUS	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Previous element in linked list	20040211

Method GET_PREVIOUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DOCB_ELEMENT	Value transfer	☑	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to Document Builder Element	20080410
2	Importing	IS_DOCB_ELEMENT_ID	Value transfer	☑	Type reference (TYPE)	/IPRO/S_ELMNT_ID		Structure for Element Identification	20080410
3	Returning	RT_PROPERTY	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_PROPERTY		Element Property Table	20040121

Method GET_PROPERTIES on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_PURORG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRT_PURORG	Value transfer	☐	Type reference (TYPE)	/IPRO/TTDOCPUR		table typ for /IPRO/TDOCPUR	20070405

Method GET_PURORG on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_REP_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRV_REP_STATE	Value transfer	☐	Type reference (TYPE)	CHAR1		1 draft, 2 rejected, 3 in approval, 4 active, 5 inactive	20070404

Method GET_REP_STATE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXT_AUTH_CHECK	Call by reference	☑	Type reference (TYPE)	XFELD		Checkbox	20061222
2	Returning	RT_RULE	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_RULE		FOBU Rule	20040331

Method GET_RULE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_SOURCE_ELM_FOR_CUSTELM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRO_SOURCE_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Interface to document builder element	20070510

Method GET_SOURCE_ELM_FOR_CUSTELM on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_SOURCE_ID_FOR_CUSTELM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_SOURCE_ID	Value transfer	☐	Type reference (TYPE)	/IPRO/S_ELMNT_ID		Structure for element identification	20040126

Method GET_SOURCE_ID_FOR_CUSTELM on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	STRING		Element Status	20040121

Method GET_STATUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_STDELM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_STDELM_ID	Value transfer	☐	Type reference (TYPE)	/IPRO/S_ELMNT_ID		Structure for element identification	20040121

Method GET_STDELM_ID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_TELMNT_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRS_TELMNT_ROW	Value transfer	☐	Type reference (TYPE)	/IPRO/TELMNT		Element table	20061204

Method GET_TELMNT_ROW on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_UPDATE_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_UPDATE_STATUS	Value transfer	☐	Type reference (TYPE)	STRING		Update status	20041026

Method GET_UPDATE_STATUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_MODE	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20070503
2	Returning	PRV_OUT_ABSOLUTE_URL	Value transfer	☐	Type reference (TYPE)	STRING			20070503

Method GET_URL on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_USRELM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_USRELM_ID	Value transfer	☐	Type reference (TYPE)	GUID		Globally Unique Identifier	20040121

Method GET_USRELM_ID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_WF_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_WF_GUID	Value transfer	☐	Type reference (TYPE)	GUID		Globally Unique Identifier	20070212

Method GET_WF_GUID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method GET_WHERE_USED_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ONLY_DOCUMENTS	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070531
2	Importing	PIV_ONLY_TEMPLATES	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070531
3	Importing	PIV_ONLY_USR_TEMPLATES	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070531
4	Returning	PRT_WHERE_USED_LIST	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_ELMLIST		where used list	20070601

Method GET_WHERE_USED_LIST on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method HAS_ALT_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PRV_ALTERNATIVES	Value transfer	☐	Type reference (TYPE)	XFELD		Checkbox	20060912

Method HAS_ALT_ELEMENTS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method HIDE_ELEMENT Signature

Method HIDE_ELEMENT on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method HIDE_ELEMENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_EDITABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EDITABLE	Value transfer	☐	Type reference (TYPE)	/IPRO/IS_EDIT		Is standard element editable?	20040625

Method IS_EDITABLE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_EXCLUDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EXCLUDED	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040305

Method IS_EXCLUDED on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_IBR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_IBR	Value transfer	☐	Type reference (TYPE)	BOOLEAN		boolean variable (X=true, -=false, space=unknown)	20040121

Method IS_IBR on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_INCLUDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INCLUDED	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Boolean	20040305

Method IS_INCLUDED on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_NOTE_APPENDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NOTE_APPENDED	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Has Note?	20041013

Method IS_NOTE_APPENDED on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_OPTIONAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OPTIONAL	Value transfer	☐	Type reference (TYPE)	BOOLEAN		boolean variable (X=true, -=false, space=unknown)	20040121

Method IS_OPTIONAL on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_RECOMMENDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RECOMMENDED	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Is Recommended?	20040805

Method IS_RECOMMENDED on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_REQUIRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_REQUIRED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		boolean variable (X=true, -=false, space=unknown)	20040121

Method IS_REQUIRED on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method IS_UPDATE_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_AVAILABLE	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Update Available	20040716

Method IS_UPDATE_AVAILABLE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method PAGE_BREAK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_PAGE_BREAK	Value transfer	☐	Type reference (TYPE)	SEU_BOOL		Insert Page Break?	20041021

Method PAGE_BREAK on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method PROCESS_ELEMENT_UPDATE Signature

Method PROCESS_ELEMENT_UPDATE on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method PROCESS_ELEMENT_UPDATE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method RECORD_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_EDIT	Call by reference	☐	Type reference (TYPE)	/IPRO/TEDHIST		Element Edit	20040630

Method RECORD_HISTORY on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method REJECT_ELEMENT_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REJECT_MANDATORY	Call by reference	☑	Type reference (TYPE)	SEU_BOOL		Boolean	20130522

Method REJECT_ELEMENT_UPDATE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method RESET_STATUS Signature

Method RESET_STATUS on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method RESET_STATUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ALT_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIT_ALT_ELEMENTS	Value transfer	☐	Type reference (TYPE)	/IPRO/TT_STDELMRES			20070427

Method SET_ALT_ELEMENTS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_COMMENT_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMMENT_FULL_TXT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Document Builder Element Text Class	20070510

Method SET_COMMENT_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ELEMENT_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIT_FORMAT	Call by reference	☐	Type reference (TYPE)	/IPRO/TTELM_FMT		Maintain relationship between elements and formats	20070711

Method SET_ELEMENT_FORMAT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ELEMENT_UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_UPDATE	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Element Update	20040716

Method SET_ELEMENT_UPDATE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ELEMENT_UPDATE_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_UPDATE_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_ELEMENT		Update Parent	20080725

Method SET_ELEMENT_UPDATE_PARENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ELEMNT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_ELMNT_CATEGORY	Call by reference	☐	Type reference (TYPE)	/IPRO/ELEMENT_CATEGORY		Element Category	20070418

Method SET_ELEMNT_CATEGORY on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FULL_TXT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Text Class	20040121

Method SET_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_IBR_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_IS_IBR	Call by reference	☐	Type reference (TYPE)	/IPRO/IS_IBR		Included by reference Flag	20040621

Method SET_IBR_PROPERTY on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_INTENDED_USE_FULL_TXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INTENDED_USE_FULL_TXT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Document Builder Element Text Class	20070510

Method SET_INTENDED_USE_FULL_TXT on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NOTE	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_DOCB_TEXT		Note	20041007

Method SET_NOTE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_ORIGIN_ELEMENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIS_ORIGIN_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	/IPRO/S_ELMNT_ID		Structure for element identification	20070503

Method SET_ORIGIN_ELEMENT_ID on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_OUTPUT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_OTYPE	Call by reference	☐	Type reference (TYPE)	/IPRO/OTYPE		Output Type	20070418

Method SET_OUTPUT_TYPE on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_PAGE_BREAK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PAGE_BREAK	Call by reference	☐	Type reference (TYPE)	SEU_BOOL		Page break flag	20041021

Method SET_PAGE_BREAK on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_PURORG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIT_PURORG	Call by reference	☐	Type reference (TYPE)	/IPRO/TTDOCPUR		table typ for /IPRO/TDOCPUR	20070411

Method SET_PURORG on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RULE_ID	Call by reference	☑	Type reference (TYPE)	/IPRO/RULE_ID		Rule Identifier	20070504
2	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	STRING		Single-character flag	20040121

Method SET_STATUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method SET_TELMNT_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIS_TELMNT_ROW	Call by reference	☐	Type reference (TYPE)	/IPRO/TELMNT		Element table	20070221

#	Exception	Resumable	Description	Created on
1	/IPRO/CX_ACTION_ILLEGAL	☐	Illegal Document Builder Action	20070226

Method SET_UPDATE_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UPDATE_STATUS	Call by reference	☐	Type reference (TYPE)	STRING		Update Status	20041026

Method SET_UPDATE_STATUS on class /IPRO/IF_DOCB_ELEMENT has no exception.

Method UNHIDE_ELEMENT Signature

Method UNHIDE_ELEMENT on class /IPRO/IF_DOCB_ELEMENT has no parameter.
Method UNHIDE_ELEMENT on class /IPRO/IF_DOCB_ELEMENT has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in