SAP ABAP Class CL_SRM_BASE_CONTROL (SRM Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_CLIENTFRAME_WIN (Package) Records Management: Wingui Client Framework

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUI_CONTROL	Proxy Class for Control in GUI	20020225
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_BASE_CONTROL	Interface to SRM Control	20020225
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_BASE_CONTROL_INT	Help Functions for RM Control: For Internal Use Only	20020726

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_STACKED_CONTROL	RM Control with Stack	20020716

Properties

Class	CL_SRM_BASE_CONTROL
Short Description	SRM Control
Super Class	CL_GUI_CONTROL	Proxy Class for Control in GUI
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_CLIENTFRAME_WIN	Records Management: Wingui Client Framework
Created	20020225	SAP
Last change	20041208	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SRM_ROOT_FACTORY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_SRM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	SRMCF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SRMIF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRM_BASE_CONTROL	☐	☐	Interface to SRM Control	20020225
2	IF_SRM_BASE_CONTROL_INT	☐	☐	Help Functions for RM Control: For Internal Use Only	20020726

Friends

Class CL_SRM_BASE_CONTROL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLIENTCONTEXT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_CLIENTCONTEXT		Reference to Client Context	20020225
2	CLIENTMANAGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_CLIENTMANAGER		Reference to Client Manager	20020225
3	PARENT_CONTAINER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Pointer to Parent Container	20020225
4	POID_REF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID Reference	20020225
5	REQUEST_PROCESSOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST_PROCESSOR		Request Processor	20020225
6	SP_MAIN_CTRL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Main control of SP	20020225
7	SP_REF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_SP_CLIENT_WIN		Reference to Current SP	20020225
8	SP_REF_PASV	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_SP_FRONTEND_SAPGUI_PASV		Display in SAPGUI (passive)	20020419
9	SRM	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_SRM		Ref. to IF_SRM	20020225
10	SRM_SERVICE	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_SRM_SRM_SERVICE		Ref. to IF_SRM_SRM_SERVICE	20020225

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Generates an SRM Control	20020225
2	DISPATCH_ASYNC_ANSWER	Instance method	Protected	Method	Forward Asynchronous Response to SP in Control	20020419
3	DISPATCH_FINISH_ASYNC	Instance method	Protected	Method	Forwarding of End Request	20020419
4	DISPATCH_NEW_PASV_REQUEST	Instance method	Protected	Method	Processing New Passive Request	20020419
5	DISPATCH_NEW_REQUEST	Instance method	Protected	Method	Processing a New Request	20020419
6	DISPATCH_NONINPLACE	Instance method	Protected	Method	Forwarding Requests That Are Not In Place	20020419
7	HANDLE_ASYNC_ANSWER_EVENT	Instance method	Protected	Event handling method	Event Handler for IF_SRM_CLIENT_EVENT~SEND_ASYNC_ANSWER	20020225
8	HANDLE_CLOSE_EVENT	Instance method	Protected	Event handling method	Event Handler for IF_SRM_CLIENT_EVENT~SEND_CLOSE_EVENT	20041007
9	HANDLE_SEND_REQUEST_EVENT	Instance method	Protected	Event handling method	Event Handler for IF_SRM_CLIENT_EVENT~SEND_REQUEST_EVENT	20020225
10	HANDLE_SEND_TITLE_EVENT	Instance method	Protected	Event handling method	Event Handler for Sent Title	20020726
11	ON_ASYNC_ANSWER	Instance method	Protected	Method	For Redefinitions: Answer to a Request	20020225
12	ON_NEW_REQUEST	Instance method	Protected	Method	For Redfinitions: A New Request has been Triggered	20020225
13	SEND_SYSTEM_INFO	Instance method	Protected	Method	Sends system info to element	20020722
14	SET_POID	Instance method	Protected	Method	Sets POID	20020225
15	SET_POID_ACTV	Instance method	Protected	Method	Sets POID	20020419
16	SET_POID_PASV	Instance method	Protected	Method	Sets POID	20020419
17	UNLOAD_POID	Instance method	Protected	Method	Unloading a POID	20020717

Events

Class CL_SRM_BASE_CONTROL has no event.

Types

Class CL_SRM_BASE_CONTROL 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	AUTOALIGN	Value transfer	☐	Type reference (TYPE)	C	'X'		20020225
2	Importing	CFW_ID	Call by reference	☐	Type reference (TYPE)	STRING	SRMIF_CLIENTFRAME_ID	SPS ID des zu verwendenden Client Framework	20020523
3	Importing	LICENSEKEY	Value transfer	☑	Type reference (TYPE)	C			20020225
4	Importing	LIFETIME	Value transfer	☐	Type reference (TYPE)	I	LIFETIME_DEFAULT		20020225
5	Importing	NAME	Value transfer	☑	Type reference (TYPE)	STRING			20020225
6	Importing	PARENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Proxy-Klasse für Objekt im GUI	20020225
7	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I			20020225
8	Importing	SRM	Call by reference	☑	Object reference (TYPE REF TO)	IF_SRM		Referenz auf IF_SRM, falls bereits vorhanden	20020225

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020225

Method DISPATCH_ASYNC_ANSWER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Antwort	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method DISPATCH_FINISH_ASYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_KEEP_STATE	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Zustand halten?	20021025

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method DISPATCH_NEW_PASV_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Request	20020419
2	Returning	RE_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Antwort	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method DISPATCH_NEW_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Request	20020419
2	Returning	RE_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Antwort	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method DISPATCH_NONINPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE_PASV	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Passive Mode	20020424
2	Importing	IM_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Request	20020419
3	Importing	IM_REQUEST_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Request Type	20020419
4	Returning	RE_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Antwort	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method HANDLE_ASYNC_ANSWER_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Attribute reference (LIKE)				20020225

Method HANDLE_ASYNC_ANSWER_EVENT on class CL_SRM_BASE_CONTROL has no exception.

Method HANDLE_CLOSE_EVENT Signature

Method HANDLE_CLOSE_EVENT on class CL_SRM_BASE_CONTROL has no parameter.
Method HANDLE_CLOSE_EVENT on class CL_SRM_BASE_CONTROL has no exception.

Method HANDLE_SEND_REQUEST_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST	Call by reference	☐	Attribute reference (LIKE)				20020225

Method HANDLE_SEND_REQUEST_EVENT on class CL_SRM_BASE_CONTROL has no exception.

Method HANDLE_SEND_TITLE_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EV_PRG_NAME	Call by reference	☐	Attribute reference (LIKE)				20020726
2	Importing	EV_STATUS_NAME	Call by reference	☐	Attribute reference (LIKE)				20020726
3	Importing	EV_TITLE	Call by reference	☐	Attribute reference (LIKE)				20020726

Method HANDLE_SEND_TITLE_EVENT on class CL_SRM_BASE_CONTROL has no exception.

Method ON_ASYNC_ANSWER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		Request	20020225

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020723

Method ON_NEW_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REQUEST		neuer Request	20020225

Method ON_NEW_REQUEST on class CL_SRM_BASE_CONTROL has no exception.

Method SEND_SYSTEM_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE_PASV	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		passiver Modus	20020722
2	Importing	IM_MSG	Call by reference	☐	Type reference (TYPE)	SRMIF_SP_MESSAGE		Message	20020722
3	Importing	IM_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20020722

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020722
2	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020722

Method SET_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE_PASV	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Passive Mode?	20020419
2	Importing	IM_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20020225

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	POID Fehler (abstrakt)	20020225
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020226
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020226

Method SET_POID_ACTV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	POID Fehler (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method SET_POID_PASV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20020419

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	POID Fehler (abstrakt)	20020419
2	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20020419
3	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020419

Method UNLOAD_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_FORCE	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Reagieren auf Abbruch?	20020725
2	Importing	IM_MODE_PASV	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20020717
3	Importing	IM_MSG	Call by reference	☐	Type reference (TYPE)	SRMIF_SP_MESSAGE	SRMIF_SYSTEM_INFO_DESTROY	Message	20020717
4	Importing	IM_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20020717
5	Importing	IM_UNLOAD_MODE	Call by reference	☐	Type reference (TYPE)	I		Unload Modus	20020729

#	Exception	Resumable	Description	Created on
1	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20020717
2	CX_SRM_SP_CLIENT	☐	Ausnahme vom SP Client	20020717

History

Last changed by/on	SAP	20041208
SAP Release Created in	630