SAP ABAP Class CL_NWBC_UTILITY (NWBC - Utility Functions)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-FES-BUS (Application Component) Netweaver Business Client
     ⤷ SAP_NWBC (Package) NetWeaver Business Client

Properties

Class	CL_NWBC_UTILITY
Short Description	NWBC - Utility Functions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAP_NWBC	NetWeaver Business Client
Created	20110707	SAP
Last change	20130531	SAP
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)

Interfaces

Class CL_NWBC_UTILITY has no interface implemented.

Friends

Class CL_NWBC_UTILITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_DAY_STRING	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20120111
2	GV_LAST_DATE	Static Attribute	Private	☐	Type reference (TYPE)	D			20120111
3	GV_MONTH_STRING	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20120111
4	MC_NAME_VALUE_SEPARATOR	Constant	Private	☐	Type reference (TYPE)	STRING	'='	Name/Value separator	20111107
5	MC_PARAM_SEPARATOR	Constant	Private	☐	Type reference (TYPE)	STRING	'&'	Parameter separator	20111107
6	MC_QUERY_SEPARATOR	Constant	Private	☐	Type reference (TYPE)	STRING	'?'	Query/paeamaters separator	20111107

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ESCAPE_ATTRIBUTE	Static method	Public	Method	Executes HTML Escaping on a attribute string	20111202
2	ESCAPE_HTML	Static method	Public	Method	Executes HTML Escaping on a String	20110707
3	ESCAPE_JAVASCRIPT	Static method	Public	Method	Executes Javascript Escaping on String	20110707
4	ESCAPE_JSON_STRING	Static method	Public	Method	Escapes a JSON String	20111103
5	ESCAPE_URL	Static method	Public	Method	Executes URL Escaping on a String	20110707
6	FIELDS_TO_STRING	Static method	Public	Method	Encodes a List of Fields as a Query String	20110707
7	GET_BOOL	Static method	Public	Method	Returns ABAP_BOOL representation of value	20130314
8	GET_HTTP_DATE	Static method	Public	Method	Get HTTP formatted date	20120111
9	SPLIT_VALUE_PAIRS_STRING	Static method	Public	Method	Decodes a Query String into a List of Fields	20130314
10	STRING_TO_FIELDS	Static method	Public	Method	Decodes a Query String into a List of Fields	20110707
11	UNESCAPE_URL	Static method	Public	Method	Pair function to ESCAPE_URL for decoding of url	20111124

Events

Class CL_NWBC_UTILITY has no event.

Types

Class CL_NWBC_UTILITY has no local type.

Method Signatures

Method ESCAPE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unencoded String	20111202
2	Returning	RV_ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		HTML-Encoded attribute string	20111202

Method ESCAPE_ATTRIBUTE on class CL_NWBC_UTILITY has no exception.

Method ESCAPE_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unencoded String	20110707
2	Returning	RV_ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		HTML-Encoded String	20110707

Method ESCAPE_HTML on class CL_NWBC_UTILITY has no exception.

Method ESCAPE_JAVASCRIPT Signature

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

Method ESCAPE_JAVASCRIPT on class CL_NWBC_UTILITY has no exception.

Method ESCAPE_JSON_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20111103

Method ESCAPE_JSON_STRING on class CL_NWBC_UTILITY has no exception.

Method ESCAPE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_UNESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		Unencoded String	20110707
2	Returning	RV_ESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		URL-Encoded String	20110707

Method ESCAPE_URL on class CL_NWBC_UTILITY has no exception.

Method FIELDS_TO_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Table with Name/Value Pairs	20110707
2	Importing	IV_ENCODE_NAMES	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	Encode not only values but also names	20140811
3	Importing	IV_QUERY	Call by reference	☑	Type reference (TYPE)	STRING		Existing Query String to append	20121219
4	Returning	RV_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Query String	20110707

Method FIELDS_TO_STRING on class CL_NWBC_UTILITY has no exception.

Method GET_BOOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	CSEQUENCE		String with some value representing boolean as X, YES, ON...	20130314
2	Returning	RV_BOOL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Interpreted result	20130314

Method GET_BOOL on class CL_NWBC_UTILITY has no exception.

Method GET_HTTP_DATE Signature

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

Method GET_HTTP_DATE on class CL_NWBC_UTILITY has no exception.

Method SPLIT_VALUE_PAIRS_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Table with Name/Value Pairs	20130314
2	Importing	IV_CASE_SENSITIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Controls if values shall be convertzed to upper case	20130314
3	Importing	IV_CONDENSE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Controls if spaces in name vlaues shall be trimmed	20130314
4	Importing	IV_DECODE_NAMES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Decode not only values but also names	20130314
5	Importing	IV_DECODE_VALUES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Decode values	20130314
6	Importing	IV_NAME_VALUE_SEPARATOR	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	'='	Name / Value separator symbol	20130314
7	Importing	IV_PAIR_SEPARATOR	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	'&'	Pairs separator symbol	20130314
8	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Encoded Query String	20130314
9	Importing	IV_UNIQUE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Controls if name duplicates shall be removed	20130314

Method SPLIT_VALUE_PAIRS_STRING on class CL_NWBC_UTILITY has no exception.

Method STRING_TO_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELDS	Call by reference	☐	Type reference (TYPE)	TIHTTPNVP		Table with Name/Value Pairs	20110707
2	Importing	IV_DECODE_NAMES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Decode not only values but also names	20120420
3	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Encoded Query String	20110707

Method STRING_TO_FIELDS on class CL_NWBC_UTILITY has no exception.

Method UNESCAPE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ESCAPED	Call by reference	☐	Type reference (TYPE)	STRING		URL-Encoded String	20111125
2	Returning	RV_UNESCAPED	Value transfer	☐	Type reference (TYPE)	STRING		Decoded string	20111125

Method UNESCAPE_URL on class CL_NWBC_UTILITY has no exception.

History

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