SAP ABAP Class /IPRO/CL_BSP_CTRL_GEN (Document Builder General BSP Controller)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-GTF-DOB (Application Component) Document Builder
     ⤷ /IPRO/UI/PROGS/ (Package) Programs

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSP_CONTROLLER2	BSP Component	20031106

Properties

Class	/IPRO/CL_BSP_CTRL_GEN
Short Description	Document Builder General BSP Controller
Super Class	CL_BSP_CONTROLLER2	BSP Component
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/IPRO/UI/PROGS/	Programs
Created	20031106	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /IPRO/CL_BSP_CTRL_GEN has no forward declaration.

Interfaces

Class /IPRO/CL_BSP_CTRL_GEN has no interface implemented.

Friends

Class /IPRO/CL_BSP_CTRL_GEN has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_DOCVIEW	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	/IPRO/CL_VIEW		View Interface	20031106

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	EDITOR_BINDING	Instance method	Protected	Method	Binding to /ipro/if_docb_editor	20040329
2	FILE_BINDING	Instance method	Protected	Method	Binding to /ipro/if_docb_file	20040701
3	GET_COMP	Instance method	Protected	Method	Determine the component ID	20031106
4	GET_DOCVIEW	Instance method	Protected	Method	Determine correspondig virtual view	20040616
5	GET_ELEMENT_TEXT	Instance method	Protected	Method	Get the text for the element	20040622
6	GET_OUTPUT_TEXT	Instance method	Protected	Method	Get the text for the output type	20040622
7	GET_ROOT	Instance method	Protected	Method	Get the root controller	20031112
8	IMAGE_EVENT_PARSE	Instance method	Private	Method	Parse the image event	20050711
9	SEND_DOCUMENT	Instance method	Protected	Method	Send the requested document back in the response.	20040601
10	SEND_ERROR	Instance method	Protected	Method	Send some error text back to the client	20040729
11	TABLE_BINDING	Instance method	Protected	Method	Binding to /ipro/cl_table_view	20040216
12	TABLE_VAR_BINDING	Instance method	Protected	Method	Binding to table variables	20041123

Events

Class /IPRO/CL_BSP_CTRL_GEN has no event.

Types

Class /IPRO/CL_BSP_CTRL_GEN has no local type.

Method Signatures

Method EDITOR_BINDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIO_EDITOR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_EDITOR		Editor	20040329
2	Importing	PIT_FORM_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20040329

Method EDITOR_BINDING on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method FILE_BINDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIO_FILE_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCB_FILE		File View	20040701

Method FILE_BINDING on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method GET_COMP Signature

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

Method GET_COMP on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method GET_DOCVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIT_REQUEST_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20040616
2	Returning	PRO_DOCVIEW	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_VIEW		Abstract view class	20040616

Method GET_DOCVIEW on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method GET_ELEMENT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20040622
2	Importing	IV_ELEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20040622
3	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		The type of element text	20040622
4	Returning	RS_DOC	Value transfer	☐	Type reference (TYPE)	/IPRO/S_OUTPUT		Report output structure	20040622

Method GET_ELEMENT_TEXT on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method GET_OUTPUT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_DOCUMENT		Document Builder Document Interface	20040622
2	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	/IPRO/OTYPE		Document Builder output types	20040622
3	Returning	RS_DOC	Value transfer	☐	Type reference (TYPE)	/IPRO/S_OUTPUT		Report output structure	20040622

Method GET_OUTPUT_TEXT on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method GET_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_CONTROLLER	Value transfer	☐	Object reference (TYPE REF TO)	/IPRO/CL_BSP_CTRL_GEN		Controller Class for zja_docb_bsp_01	20031112

Method GET_ROOT on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method IMAGE_EVENT_PARSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_COMMAND	Call by reference	☐	Type reference (TYPE)	STRING		Command	20050711
2	Exporting	EV_PARAM	Call by reference	☐	Type reference (TYPE)	STRING		Parameter	20050711
3	Importing	IV_COMMAND	Call by reference	☐	Type reference (TYPE)	STRING		Command to search for	20050711
4	Importing	IV_PARAM	Call by reference	☐	Type reference (TYPE)	STRING		Incoming event	20050711

Method IMAGE_EVENT_PARSE on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method SEND_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20040601

Method SEND_DOCUMENT on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method SEND_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIV_CONTENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Text or HTML	20040729
2	Importing	PIV_ERROR	Call by reference	☐	Type reference (TYPE)	STRING			20040729

Method SEND_ERROR on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method TABLE_BINDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIO_TABLE_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/CL_TABLE_VIEW		Generic talbe view for Document Builder	20040216
2	Importing	PIT_FORM_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20040216

Method TABLE_BINDING on class /IPRO/CL_BSP_CTRL_GEN has no exception.

Method TABLE_VAR_BINDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PIO_TRANSPORTABLE	Call by reference	☐	Object reference (TYPE REF TO)	/IPRO/IF_TRANSPORTABLE		View containing transportables	20041123
2	Importing	PIT_FORM_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20041123

Method TABLE_VAR_BINDING on class /IPRO/CL_BSP_CTRL_GEN has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	10A