SAP ABAP Class CL_CLB_TOOLS (Collaboration: Common Tools)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-STW (Application Component) Social Media ABAP Integration Library
     ⤷ S_CLB_COMMON (Package) Common Objects and Services of the Collaboration Platform

Properties

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

General Data

Message Class
Program status
Category	0
Package	S_CLB_COMMON	Common Objects and Services of the Collaboration Platform
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_HTTP_REQUEST	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_CLB_TOOLS has no interface implemented.

Friends

Class CL_CLB_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				20120711
2	M_UTC_CHECK_EXCEPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CX_DYNAMIC_CHECK		Exceptions with Dynamic Check Only of the RAISING Clause	20120711
3	M_UTC_CHECK_RESULT	Static Attribute	Private	☐	Type reference (TYPE)	TY_UTC_CHECK_RESULT			20120711

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	20110805
2	DISPLAY_AS_XML	Static method	Public	Method	Display a string/xstring in a separate window	20110805
3	ESCAPE	Static method	Public	Method	Escape a string	20110805
4	EXEC_METHOD	Static method	Public	Method	Execute a simple method	20120412
5	GET_ISO_LANGUAGE	Static method	Public	Method		20111215
6	GET_NODE	Static method	Public	Method	Retrieve the content of a node / attribute	20120413
7	GET_NONCE	Static method	Public	Method	Get a nonce value	20110805
8	GET_UNIX_TIMESTAMP	Static method	Public	Method	Get a timestamp which is conform to unix	20110805
9	IS_AU_ACTIVE	Static method	Public	Method	Check if Checkpoint Group for AU is Active (TA SAAB)	20111124
10	STRING_TO_XSTRING	Static method	Public	Method	Convert STRING to XSTRING	20110819
11	TIMESTAMP_FROM_UTC	Static method	Public	Method	Convert UTC timestamp to ABAP timestamp	20110819
12	TIMESTAMP_FROM_UTC_RESULT	Static method	Public	Method	Test if an UTC string can be handled with TIMESTAMP_FROM_UTC	20120711
13	UTC_FROM_TIMESTAMP	Static method	Public	Method	Convert timestamp to UTC timestamp	20110819
14	XSTRING_TO_STRING	Static method	Public	Method	Convert XSTRING to STRING	20110805

Events

Class CL_CLB_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	20120711

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			20110805
2	Importing	I_SECOND_URL	Call by reference	☐	Type reference (TYPE)	STRING			20110815
3	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20110805

#	Exception	Resumable	Description	Created on
1	CX_CLB_RUNTIME	☐		20110914

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			20110805
2	Importing	I_XML_STRING	Call by reference	☑	Type reference (TYPE)	STRING			20110805

Method DISPLAY_AS_XML on class CL_CLB_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			20110805
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20110805

Method ESCAPE on class CL_CLB_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_CLB_METHOD_PROCESS		Collaboration: Callback Methods for the Process Layer	20120412
2	Importing	IS_APPL_KEY	Call by reference	☐	Type reference (TYPE)	CLB_S_APPL_KEY		Collaboration Platform: Key Elements	20120412
3	Importing	IV_AUTH_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING	'USER'		20120412
4	Importing	IV_ENDPOINT	Call by reference	☐	Type reference (TYPE)	STRING			20120412
5	Importing	IV_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	CLB_PLATFORM_METHOD		Collaboration: API Method of a Service Provider	20120412
6	Importing	IV_REQUEST_METHOD	Call by reference	☐	Type reference (TYPE)	STRING	IF_HTTP_REQUEST=>CO_REQUEST_METHOD_GET		20120412
7	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	STRING			20120507
8	Importing	IV_VERSION	Call by reference	☐	Type reference (TYPE)	CLB_PLATFORM_METHOD_VERSION	'V1'	Collaboration: Version of Platform API Method	20120412
9	Returning	RO_METHOD	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLB_METHOD_PROCESS		Collaboration: Callback Methods for the Process Layer	20120412

#	Exception	Resumable	Description	Created on
1	CX_CLB_PROCESS	☐	SAIL: Process layer exception	20120412

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			20111215

Method GET_ISO_LANGUAGE on class CL_CLB_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			20120413
2	Importing	IV_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20120413
3	Importing	IV_XML	Call by reference	☐	Type reference (TYPE)	XSTRING			20120413
4	Returning	RV_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING			20120413

Method GET_NODE on class CL_CLB_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			20110805

Method GET_NONCE on class CL_CLB_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			20110805

Method GET_UNIX_TIMESTAMP on class CL_CLB_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	'CLB_AUNIT'		20111124
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1			20111124

Method IS_AU_ACTIVE on class CL_CLB_TOOLS has no exception.

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, ...)	20110819
2	Importing	I_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20110819
3	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING			20110819

Method STRING_TO_XSTRING on class CL_CLB_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			20120711
2	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20120711

Method TIMESTAMP_FROM_UTC on class CL_CLB_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_CLB_PROCESS		SAIL: Process layer exception	20120711
2	Exporting	EV_RESULT	Value transfer	☐	Type reference (TYPE)	TY_UTC_CHECK_RESULT		Boolean Variable (X=True, -=False, Space=Unknown)	20120711

Method TIMESTAMP_FROM_UTC_RESULT on class CL_CLB_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)	20110819
2	Returning	R_VALUE	Value transfer	☐	Type reference (TYPE)	STRING			20110819

Method UTC_FROM_TIMESTAMP on class CL_CLB_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			20110805
2	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20110805

Method XSTRING_TO_STRING on class CL_CLB_TOOLS has no exception.

History

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