SAP ABAP Class CL_CFX_API_UTIL (CFX API: Help Functions)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_API (Package) Collaboration Folders: API

Properties

Class	CL_CFX_API_UTIL
Short Description	CFX API: Help Functions
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_API	Collaboration Folders: API
Created	20010809	SAP
Last change	20141109
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	CFXA0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CFX_API_UTIL has no interface implemented.

Friends

Class CL_CFX_API_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_EMBED_TAG	Constant	Public	☐	Type reference (TYPE)	STRING	'		20050705
2	SC_IMG_TAG	Constant	Public	☐	Type reference (TYPE)	STRING	'		20050705
3	SC_OBJECT_TAG	Constant	Public	☐	Type reference (TYPE)	STRING	'		20050708
4	SC_SCRIPT_TAG	Constant	Public	☐	Type reference (TYPE)	STRING	'		20050705

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BOOL_TO_API_FORMAT	Static method	Public	Method	Converted cfx_boolean into API Format	20020516
2	CHECK_FOR_MALICIOUS_CODE	Static method	Public	Method	Checks Whether Cross-Side-Scripting Is Attempted in String	20050705
3	DELETE_TRAILING_BLANKS	Static method	Public	Method	Deletion of all Blank Characters at the End of a String	20011008
4	GET_URLS_FOR_UPLOAD	Static method	Public	Method	Returns URL for Direct Upload (of App)	20040204
5	GET_URL_FOR_DOWNLOAD	Static method	Public	Method	Returns URL for Version Download	20010809
6	GET_URL_FOR_WAS_DOWNLOAD	Static method	Public	Method	Returns URL for Version Download	20020322
7	READ_CONTENT_FROM_URL	Static method	Public	Method	HTTP-Client Call to URL	20010810
8	XSTRING_TO_XML_DOC	Static method	Public	Method	Delivers an XML Document for an xString	20010919

Events

Class CL_CFX_API_UTIL has no event.

Types

Class CL_CFX_API_UTIL has no local type.

Method Signatures

Method BOOL_TO_API_FORMAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BOOL	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolscher Typ	20020516
2	Returning	R_API_BOOL	Value transfer	☐	Type reference (TYPE)	CFX_API_T_BOOL		'yes' = ja oder 'no' = nein	20020516

Method BOOL_TO_API_FORMAT on class CL_CFX_API_UTIL has no exception.

Method CHECK_FOR_MALICIOUS_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_STRING	Call by reference	☐	Type reference (TYPE)	CFX_STRING		Zeichenkette für Collaboration Folders	20050705
2	Returning	R_IS_DANGEROUS	Value transfer	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolscher Typ	20050705

Method CHECK_FOR_MALICIOUS_CODE on class CL_CFX_API_UTIL has no exception.

Method DELETE_TRAILING_BLANKS Signature

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

Method DELETE_TRAILING_BLANKS on class CL_CFX_API_UTIL has no exception.

Method GET_URLS_FOR_UPLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BASE_URL	Call by reference	☐	Type reference (TYPE)	STRING			20040204
2	Exporting	E_DIRECT_URL	Call by reference	☐	Type reference (TYPE)	STRING			20040204
3	Exporting	E_INDIRECT_URL	Call by reference	☐	Type reference (TYPE)	STRING			20040204
4	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040204
5	Importing	I_COL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040204
6	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040204
7	Importing	I_PAGENAME	Call by reference	☑	Type reference (TYPE)	CFX_BSPPAGE		Name einer BSP-Seite	20040204
8	Importing	I_TOPIC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20040204
9	Importing	I_VDESC	Call by reference	☐	Type reference (TYPE)	STRING			20040204
10	Importing	I_VNAME	Call by reference	☐	Type reference (TYPE)	STRING			20040204

Method GET_URLS_FOR_UPLOAD on class CL_CFX_API_UTIL has no exception.

Method GET_URL_FOR_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_IS_CONTENT_SERVER_URL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		if true, it is a absolute (non-WAS) content server URL	20020322
2	Exporting	E_URL	Call by reference	☐	Type reference (TYPE)	STRING			20020322
3	Importing	I_AREA_ID	Call by reference	☑	Type reference (TYPE)	STRING			20010809
4	Importing	I_COL_ID	Call by reference	☑	Type reference (TYPE)	STRING			20010809
5	Importing	I_CONTENT_SERVER_ALLOWED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	if true, it is allowed to return a URL to a content server	20020322
6	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010809
7	Importing	I_FILEEXT	Call by reference	☑	Type reference (TYPE)	STRING		Teilweise redundant zu i_filename	20010809
8	Importing	I_FILENAME	Call by reference	☑	Type reference (TYPE)	STRING			20010809
9	Importing	I_IP_ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING	' '	Ip Adress of frontend, if known	20020422
10	Importing	I_LONGURL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '		20010809
11	Importing	I_PAGENAME	Call by reference	☑	Type reference (TYPE)	CFX_BSPPAGE		Name einer BSP-Seite	20010809
12	Importing	I_ROLE	Call by reference	☑	Type reference (TYPE)	CFX_ROLE		role of a cfx user	20010809
13	Importing	I_SAVEMODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	if true, the URL is a "Save As"-URL	20010809
14	Importing	I_TOPIC_ID	Call by reference	☑	Type reference (TYPE)	STRING			20010809
15	Importing	I_VER_ID	Call by reference	☐	Type reference (TYPE)	STRING			20010809

Method GET_URL_FOR_DOWNLOAD on class CL_CFX_API_UTIL has no exception.

Method GET_URL_FOR_WAS_DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA_ID	Call by reference	☑	Type reference (TYPE)	STRING			20020322
2	Importing	I_COL_ID	Call by reference	☑	Type reference (TYPE)	STRING			20020322
3	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020322
4	Importing	I_FILEEXT	Call by reference	☑	Type reference (TYPE)	STRING		Teilweise redundant zu i_filename	20020322
5	Importing	I_FILENAME	Call by reference	☑	Type reference (TYPE)	STRING			20020322
6	Importing	I_LONGURL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '		20020322
7	Importing	I_PAGENAME	Call by reference	☑	Type reference (TYPE)	CFX_BSPPAGE		Name einer BSP-Seite	20020322
8	Importing	I_ROLE	Call by reference	☐	Type reference (TYPE)	CFX_ROLE		role of a cfx user	20020322
9	Importing	I_SAVEMODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	if true, the URL is a "Save As"-URL	20020322
10	Importing	I_TOPIC_ID	Call by reference	☑	Type reference (TYPE)	STRING			20020322
11	Importing	I_VER_ID	Call by reference	☐	Type reference (TYPE)	STRING			20020322
12	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20020322

Method GET_URL_FOR_WAS_DOWNLOAD on class CL_CFX_API_UTIL has no exception.

Method READ_CONTENT_FROM_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONTENT	Call by reference	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Webserver	20010810
2	Exporting	E_CONTENT_XSTR	Call by reference	☐	Type reference (TYPE)	XSTRING			20010810
3	Exporting	E_MIME	Call by reference	☐	Type reference (TYPE)	STRING		HTML-Content-Type	20010810
4	Exporting	E_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20010810
5	Exporting	E_SIZE	Call by reference	☐	Type reference (TYPE)	STRING			20010810
6	Importing	I_CONTENT_PROXY	Call by reference	☑	Type reference (TYPE)	STRING			20010810
7	Importing	I_CONTENT_PROXYPORT	Call by reference	☑	Type reference (TYPE)	STRING			20010810
8	Importing	I_CONTENT_URL	Call by reference	☐	Type reference (TYPE)	STRING		Referenz zu Datei-In	20010810

#	Exception	Resumable	Description	Created on
1	HTTP_COMMUNICATION_FAILURE	☐	Allgemeiner Fehler beim HTTP-Aufruf	20010810
2	HTTP_OBJECT_NOT_FOUND	☐	HTTP-Returncode 404 empfangen	20010813

Method XSTRING_TO_XML_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20010919
2	Returning	RP_DOCUMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010919

Method XSTRING_TO_XML_DOC on class CL_CFX_API_UTIL has no exception.

History

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