SAP ABAP Class CL_CLB2_TOOLS (Collaboration: Common Tools)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
     ⤷ CLB2_COMMON (Package) Common Objects and Services of the Collaboration Platform

Properties

Class	CL_CLB2_TOOLS
Short Description	Collaboration: Common Tools
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CLB2_COMMON	Common Objects and Services of the Collaboration Platform
Created	20130516	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_CLB2_CONFIGURATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_HTTP_REQUEST	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_CLB2_TOOLS has no interface implemented.

Friends

Class CL_CLB2_TOOLS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_UTC_CHECK_RESULTS	Constant	Public	☐	See coding				20130516
2	M_UTC_CHECK_EXCEPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_DYNAMIC_CHECK		CLAS CL_CLB2_TOOLS	20130516
3	M_UTC_CHECK_RESULT	Static Attribute	Private	☐	Type reference (TYPE)	TY_UTC_CHECK_RESULT			20130516

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_URL	Static method	Public	Method	Create an URL from Base URL and End Point	20130516
2	DISPLAY_AS_XML	Static method	Public	Method	Display a String/Xstring in a Separate Window	20130516
3	ESCAPE	Static method	Public	Method	Escape a String	20130516
4	EXEC_METHOD	Static method	Public	Method	Execute a Simple Method	20130516
5	GET_ISO_LANGUAGE	Static method	Public	Method	Get ISO Language	20130516
6	GET_NODE	Static method	Public	Method	Retrieve the Content of a Node / Attribute	20130516
7	GET_NONCE	Static method	Public	Method	Get a Nonce Value	20130516
8	GET_UNIX_TIMESTAMP	Static method	Public	Method	Get a Timestamp which is Conform to Unix	20130516
9	IS_AU_ACTIVE	Static method	Public	Method	Check if Checkpoint Group for AU is Active (TA SAAB)	20130516
10	ODATA_FILTER2SELECT_OPTION	Static method	Public	Method	Parse OData Filter String	20131220
11	STRING_TO_XSTRING	Static method	Public	Method	Convert STRING to XSTRING	20130516
12	TABLE_EXISTS	Static method	Public	Method	Table Existence Check	20130523
13	TIMESTAMP_FROM_UTC	Static method	Public	Method	Convert UTC Timestamp to ABAP Timestamp	20130516
14	TIMESTAMP_FROM_UTC_RESULT	Static method	Public	Method	Test if an UTC String can be Handled with TIMESTAMP_FROM_UTC	20130516
15	UTC_FROM_TIMESTAMP	Static method	Public	Method	Convert Timestamp to UTC Timestamp	20130516
16	XSTRING_TO_STRING	Static method	Public	Method	Convert XSTRING to STRING	20130516

Events

Class CL_CLB2_TOOLS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_UTC_CHECK_RESULT	Public	Type reference (TYPE)	SYSUBRC	Return Value of ABAP Statements	20130516

Method Signatures

Method BUILD_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASE_URL	Call by reference	☐	Type reference (TYPE)	STRING			20130516
2	Importing	I_SECOND_URL	Call by reference	☐	Type reference (TYPE)	STRING			20130516
3	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20130516

#	Exception	Resumable	Description	Created on
1	CX_CLB2_RUNTIME	☐		20130516

Method DISPLAY_AS_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XML_B64	Call by reference	☑	Type reference (TYPE)	XSTRING			20130516
2	Importing	I_XML_STRING	Call by reference	☑	Type reference (TYPE)	STRING			20130516

Method DISPLAY_AS_XML on class CL_CLB2_TOOLS has no exception.

Method ESCAPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20130516
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20130516

Method ESCAPE on class CL_CLB2_TOOLS has no exception.

Method EXEC_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_METHOD	Call by reference	☑	Object reference (TYPE REF TO)	IF_CLB2_METHOD_PROCESS		Collaboration: Callback Methods for the Process Layer	20130516
2	Importing	IS_APPL_KEY	Call by reference	☐	Type reference (TYPE)	CLB2_S_APPL_KEY		Collaboration Platform: Key Elements	20130516
3	Importing	IV_AUTH_CONTEXT	Call by reference	☑	Type reference (TYPE)	STRING	'USER'		20130516
4	Importing	IV_ENDPOINT	Call by reference	☐	Type reference (TYPE)	STRING			20130516
5	Importing	IV_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	CLB2_PLATFORM_METHOD		Collaboration: API Method of a Service Provider	20130516
6	Importing	IV_REQUEST_METHOD	Call by reference	☑	Type reference (TYPE)	STRING	IF_HTTP_REQUEST=>CO_REQUEST_METHOD_GET		20130516
7	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20130516
8	Importing	IV_VERSION	Call by reference	☑	Type reference (TYPE)	CLB2_PLATFORM_METHOD_VERSION	'V1'	Collaboration: Version of Platform API Method	20130516
9	Returning	RO_METHOD	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLB2_METHOD_PROCESS		Collaboration: Callback Methods for the Process Layer	20130516

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PROCESS	☐	SAIL: Process layer exception	20130516

Method GET_ISO_LANGUAGE Signature

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

Method GET_ISO_LANGUAGE on class CL_CLB2_TOOLS has no exception.

Method GET_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20130516
2	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130516
3	Importing	IV_XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20130516
4	Returning	RV_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING			20130516

Method GET_NODE on class CL_CLB2_TOOLS has no exception.

Method GET_NONCE Signature

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

Method GET_NONCE on class CL_CLB2_TOOLS has no exception.

Method GET_UNIX_TIMESTAMP Signature

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

Method GET_UNIX_TIMESTAMP on class CL_CLB2_TOOLS has no exception.

Method IS_AU_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECKPOINT_ID	Call by reference	☑	Type reference (TYPE)	AAB_ID_NAME	'CLB2_AUNIT'		20130516
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1			20130516

Method IS_AU_ACTIVE on class CL_CLB2_TOOLS has no exception.

Method ODATA_FILTER2SELECT_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILTER_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20131220
2	Returning	RT_FILTER_SELECT_OPTION	Value transfer	☐	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION			20131220

#	Exception	Resumable	Description	Created on
1	CX_CLB2_PARSE	☐		20140115

Method STRING_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENCODING	Call by reference	☑	Type reference (TYPE)	ABAP_ENCOD	'UTF-8'	Identifier for Character Format (UTF-8, UCS-2, ...)	20130516
2	Importing	I_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20130516
3	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING			20130516

Method STRING_TO_XSTRING on class CL_CLB2_TOOLS has no exception.

Method TABLE_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20130523
2	Returning	RV_EXISTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Exists	20130523

Method TABLE_EXISTS on class CL_CLB2_TOOLS has no exception.

Method TIMESTAMP_FROM_UTC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ISOSTRING	Call by reference	☐	Type reference (TYPE)	STRING			20130516
2	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130516

Method TIMESTAMP_FROM_UTC on class CL_CLB2_TOOLS has no exception.

Method TIMESTAMP_FROM_UTC_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_CLB2_PROCESS		SAIL: Process layer exception	20130516
2	Exporting	EV_RESULT	Value transfer	☐	Type reference (TYPE)	TY_UTC_CHECK_RESULT		Boolean Variable (X=True, -=False, Space=Unknown)	20130516

Method TIMESTAMP_FROM_UTC_RESULT on class CL_CLB2_TOOLS has no exception.

Method UTC_FROM_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130516
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20130516

Method UTC_FROM_TIMESTAMP on class CL_CLB2_TOOLS has no exception.

Method XSTRING_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20130516
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20130516

Method XSTRING_TO_STRING on class CL_CLB2_TOOLS has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100