SAP ABAP Class CL_CLB_METHOD (SAIL: Collaboration function implementation)

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_METHOD_PROCESS	Collaboration: Callback Methods for the Process Layer	20110825

Properties

Class	CL_CLB_METHOD
Short Description	SAIL: Collaboration function implementation
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	20110808	SAP
Last change	20140121	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_METHOD_PROCESS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CLB_METHOD_PROCESS	☐	☐	Collaboration: Callback Methods for the Process Layer	20110825

Friends

Class CL_CLB_METHOD has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GS_DATA_KEYS	Constant	Public	☐	See coding				20110825
2	MO_CONNECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CLB_HTTP_CONNECTOR		Connector	20110825
3	MO_DICTIONARY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CLB_DICTIONARY		Dictionary of Collaboration Layer	20110825
4	MS_APP_CONFIG	Instance attribute	Protected	☐	Type reference (TYPE)	IF_CLB_CONFIGURATION=>TY_APPLICATION_CONFIG		Configuration Access Key	20110908
5	MS_CONNECTION_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	IF_CLB_METHOD_PROCESS=>TS_CONNECTION_DATA		Connection Data	20110905
6	MT_FORM_FIELDS	Instance attribute	Private	☐	See coding				20130214
7	MT_HEADER_FIELDS	Instance attribute	Private	☐	See coding				20130214
8	MT_RESULT_HEADER	Instance attribute	Protected	☐	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20110818
9	MV_DATA	Instance attribute	Protected	☐	Type reference (TYPE)	XSTRING		Data to be Transported	20120423
10	MV_METHOD_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	CLB_PLATFORM_METHOD		Method Name	20110927
11	MV_RESULT	Instance attribute	Protected	☐	Type reference (TYPE)	XSTRING		Result	20110825
12	MV_RESULT_CODE	Instance attribute	Protected	☐	Type reference (TYPE)	CLB_RESULT_CODE		Result Code	20110825
13	MV_RESULT_MESSAGE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Result Message	20110825
14	MV_VERSION	Instance attribute	Protected	☐	Type reference (TYPE)	CLB_PLATFORM_METHOD_VERSION		Method Version	20110825

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FORM_FIELD	Instance method	Public	Method	Add Form Field to HTTP Request	20130214
2	ADD_HEADER_FIELD	Instance method	Public	Method	Add Header Field to HTTP Request	20130214
3	GET_LOCATION_HEADER	Instance method	Public	Method	Get the Location Header from the HTTP Client	20120427
4	GET_RAW_DATA	Instance method	Public	Method	Get the Result Data as Delivered from the Target Platform	20110905
5	GET_RESULT_CODE	Instance method	Public	Method	Get the Return Code of the Method Call	20120314
6	INIT	Instance method	Public	Method	Initialize the Method	20110829
7	SET_DATA	Instance method	Public	Method	Set Data for Call Preparation	20120423

Events

Class CL_CLB_METHOD has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_FIELD	Public	See coding			20130214	BEGIN OF ts_field, name TYPE string, value TYPE string, END OF ts_field

Method Signatures

Method ADD_FORM_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130218
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20130218

Method ADD_FORM_FIELD on class CL_CLB_METHOD has no exception.

Method ADD_HEADER_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130218
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20130218

Method ADD_HEADER_FIELD on class CL_CLB_METHOD has no exception.

Method GET_LOCATION_HEADER Signature

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

Method GET_LOCATION_HEADER on class CL_CLB_METHOD has no exception.

Method GET_RAW_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_VALUE	Value transfer	☐	Type reference (TYPE)	XSTRING			20110905

Method GET_RAW_DATA on class CL_CLB_METHOD has no exception.

Method GET_RESULT_CODE 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_RESULT_CODE		Result Code	20120314

Method GET_RESULT_CODE on class CL_CLB_METHOD has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APP_CONFIG	Call by reference	☑	Type reference (TYPE)	IF_CLB_CONFIGURATION=>TY_APPLICATION_CONFIG		Application-specific Configuration Data	20110908
2	Importing	IS_CONNECTION_DATA	Call by reference	☑	Type reference (TYPE)	IF_CLB_METHOD_PROCESS=>TS_CONNECTION_DATA		Method-specific Connection Data	20110927
3	Importing	IV_METHOD_NAME	Call by reference	☑	Type reference (TYPE)	CLB_PLATFORM_METHOD		Method Name	20110927
4	Importing	IV_VERSION	Call by reference	☑	Type reference (TYPE)	CLB_PLATFORM_METHOD_VERSION		Method version	20110829

Method INIT on class CL_CLB_METHOD has no exception.

Method SET_DATA Signature

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

Method SET_DATA on class CL_CLB_METHOD has no exception.

History

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