SAP ABAP Class CL_CLB_CONTROLLER_BASE (SAIL: Base controller class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-STW (Application Component) Social Media ABAP Integration Library
     ⤷ S_CLB_PROCESS (Package) Process Layer of the Collaboration Platform Library

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CLB_INJECT	SAIL: Inject an implementation into a controller	20110816

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CLB_CONFIG	Collaboration Platform: Access to configuration	20110808
2	Inheritance (c INHERITING FROM c_ref)	CL_CLB_CONNECTIVITY_CTLR	SAIL: Connectivity controller	20110808
3	Inheritance (c INHERITING FROM c_ref)	CL_CLB_PROCESS_CTLR	SAIL: Process controller	20110808

Properties

Class	CL_CLB_CONTROLLER_BASE
Short Description	SAIL: Base controller class
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_CLB_PROCESS	Process Layer of the Collaboration Platform Library
Created	20110805	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_CLB_CONFIGURATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	IF_CLB_LIB	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CLB_INJECT	☐	☐	SAIL: Inject an implementation into a controller	20110816

Friends

Class CL_CLB_CONTROLLER_BASE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CACHE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CLB_DICTIONARY		SAIL: Dictionary helper	20110830
2	MO_CLASSNAMES	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CLB_DICTIONARY			20110830
3	MS_APPL_KEY	Instance attribute	Protected	☐	Type reference (TYPE)	CLB_S_APPL_KEY		Collaboration Platform: Key Elements	20110831

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPLICATION_ID	Instance method	Public	Method	Get the ID of the application the controller is assigned to	20110808
2	BASE_INIT	Instance method	Public	Method	Initialize the base class	20110805
3	GET_APPL_CONFIG	Instance method	Protected	Method	Get the configuration data of the current application	20110818
4	GET_CLASS_KEY	Instance method	Protected	Method	Get the key for an interface for use with the dictionary	20110816
5	GET_IMPL_CLASS	Instance method	Protected	Method	Retrieve the name of the implementing class of an interface	20110805
6	GET_INSTANCE	Instance method	Protected	Method	Retrieve the instance for a given interface from the cache	20110816
7	PLATFORM	Instance method	Public	Method	Get the current platform	20110830
8	PLATFORM_TYPE	Instance method	Public	Method	Get the platform type of the controller's application	20110822

Events

Class CL_CLB_CONTROLLER_BASE has no event.

Types

Class CL_CLB_CONTROLLER_BASE has no local type.

Method Signatures

Method APPLICATION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	CLB_APPLICATION_ID		Collaboration: Application ID	20110830

Method APPLICATION_ID on class CL_CLB_CONTROLLER_BASE has no exception.

Method BASE_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPLICATION_KEY	Call by reference	☐	Type reference (TYPE)	CLB_S_APPL_KEY		Collaboration Platform: Key Elements	20110831

#	Exception	Resumable	Description	Created on
1	CX_CLB_RUNTIME	☐	SAIL: Runtime exception	20110914

Method GET_APPL_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_VALUE	Value transfer	☐	Type reference (TYPE)	IF_CLB_CONFIGURATION=>TY_APPLICATION_CONFIG			20110818

#	Exception	Resumable	Description	Created on
1	CX_CLB_PROCESS	☐	SAIL: Process layer exception	20110902
2	CX_CLB_RUNTIME	☐	SAIL: Runtime exception	20110914

Method GET_CLASS_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	CLB_APPLICATION_ID		Collaboration: Application ID	20110817
2	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of interface/class	20110816
3	Importing	I_PLATFORM_TYPE	Call by reference	☐	Type reference (TYPE)	CLB_PLATFORM_TYPE		Collaboration Platform Type	20110822
4	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20110816

Method GET_CLASS_KEY on class CL_CLB_CONTROLLER_BASE has no exception.

Method GET_IMPL_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLASSNAME	Call by reference	☐	Type reference (TYPE)	STRING		Reference type	20110805
2	Returning	R_CLASSNAME	Value transfer	☐	Type reference (TYPE)	CLB_CLASS_NAME		Reference type	20110805

#	Exception	Resumable	Description	Created on
1	CX_CLB_PROCESS	☐	SAIL: Process layer exception	20110901
2	CX_CLB_RUNTIME	☐	SAIL: Runtime exception	20110914

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IF_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Key of the interface sought	20110816
2	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		Implementing class	20110816

#	Exception	Resumable	Description	Created on
1	CX_CLB_RUNTIME	☐	SAIL: Runtime exception	20110914

Method PLATFORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	CLB_PLATFORM_ID		Platform ID	20110830

Method PLATFORM on class CL_CLB_CONTROLLER_BASE has no exception.

Method PLATFORM_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	CLB_PLATFORM_TYPE		Collaboration Platform Type	20110830

Method PLATFORM_TYPE on class CL_CLB_CONTROLLER_BASE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	732