SAP ABAP Class CL_CFX_SETTINGS_DOC (XML Document for Settings)

Hierarchy

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

Properties

Class	CL_CFX_SETTINGS_DOC
Short Description	XML Document for Settings
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_FOLDERS	Collaboration Folders: Folder and Documents
Created	20010322	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	CFXF1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	IXML	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SKWFC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CFX_SETTINGS_DOC has no interface implemented.

Friends

Class CL_CFX_SETTINGS_DOC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_DOC_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20010322
2	M_FOLDER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20010322
3	SC_FILE_EXTENSION	Constant	Private	☐	Type reference (TYPE)	TEXT10	'.xml'	Text (10 Characters)	20010322

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Creates a Settings Object	20010322
2	CREATE_DOC	Instance method	Private	Method	Creates a New Document	20010322
3	CREATE_DOM	Instance method	Private	Method	Creates an Initial DOM	20010322
4	DECRYPT_STRING	Static method	Public	Method	Decodes a String	20010828
5	DELETE	Instance method	Public	Method	Deletes the File for the Settings Object	20010322
6	DELETE_ALL	Static method	Public	Method	Deletes All Settings Files	20010322
7	DOWNLOAD	Instance method	Public	Method	Saves All Settings as XML File on the PC	20010322
8	ENCRYPT_STRING	Static method	Public	Method	Codes a String	20010828
9	GET_APPLICATION_NAME	Static method	Public	Method	Delivers the SKWF Application Name	20011009
10	GET_DOC	Instance method	Public	Method	Delivers the Binary Content of a Document	20010322
11	GET_DOC_LOIO	Instance method	Private	Method	Delivers the LOIO of a Document	20010322
12	GET_DOC_NAME	Instance method	Public	Method	Delivers the name of the Settings	20010322
13	GET_DOC_PHIO	Instance method	Private	Method	Delivers the PHIO of a Document	20010322
14	GET_DOM	Instance method	Public	Method	Delivers the DOM	20010322
15	GET_ELEMENT	Instance method	Public	Method	Delivers an XML Element to a Tag Name	20010322
16	GET_EXISTING_DOC	Instance method	Public	Method	Gets Binary Content of an Existing Document	20030226
17	GET_FILE_NAME	Instance method	Public	Method	Delivers the File Names of the Settings	20010322
18	GET_FOLDER_ENTRIES	Static method	Public	Method	Delivers All Entries of a Folder	20010322
19	GET_FOLDER_LOIO	Static method	Private	Method	Delivers the LOIO of a Setting Folder	20010322
20	GET_FOLDER_NAME	Instance method	Public	Method	Delivers the Folder Name of the Settings	20010322
21	GET_TAG_NAME	Instance method	Public	Method	Delivers a Valid Tag Name	20010322
22	GET_URL	Instance method	Public	Method	Delivers the URL for the Settings File	20010322
23	GET_WEBDAV_SEETINGS	Static method	Public	Method	Delivers the WEBDAV Settings	20010322
24	IS_FILE_EXISTING	Instance method	Public	Method	Determines If a File Exists for the Document	20010322
25	SAVE_DOM	Instance method	Public	Method	Saves the DOM in an SKWF Document	20010322
26	SET_NAME	Instance method	Private	Method	Sets the Name	20010328
27	TEST	Static method	Public	Method	Tests Class	20010322

Events

Class CL_CFX_SETTINGS_DOC has no event.

Types

Class CL_CFX_SETTINGS_DOC has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_DOM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010322
2	Importing	I_FOLDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Mappenname	20010322
3	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der XML Datei	20010322

Method CONSTRUCTOR on class CL_CFX_SETTINGS_DOC has no exception.

Method CREATE_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RAW_CONTENT	Value transfer	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Webserver	20010322
2	Exporting	E_CONTENT_SIZE	Value transfer	☐	Type reference (TYPE)	I			20010322
3	Exporting	E_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		GUID im 'CHAR' Format in Großschreibung	20030404
4	Importing	IP_DOM	Call by reference	☑	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010322

Method CREATE_DOC on class CL_CFX_SETTINGS_DOC has no exception.

Method CREATE_DOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_DOM	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT			20010322

Method CREATE_DOM on class CL_CFX_SETTINGS_DOC has no exception.

Method DECRYPT_STRING 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)	STRING			20010828
2	Returning	R_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20010828

Method DECRYPT_STRING on class CL_CFX_SETTINGS_DOC has no exception.

Method DELETE Signature

Method DELETE on class CL_CFX_SETTINGS_DOC has no parameter.
Method DELETE on class CL_CFX_SETTINGS_DOC has no exception.

Method DELETE_ALL Signature

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

Method DELETE_ALL on class CL_CFX_SETTINGS_DOC has no exception.

Method DOWNLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TARGET_FILE_NAME	Value transfer	☑	Type reference (TYPE)	STRING			20010322

Method DOWNLOAD on class CL_CFX_SETTINGS_DOC has no exception.

Method ENCRYPT_STRING 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)	STRING			20010828
2	Returning	R_STRING	Value transfer	☐	Type reference (TYPE)	STRING			20010828

Method ENCRYPT_STRING on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_APPLICATION_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_APPLICATION_NAME	Value transfer	☐	Type reference (TYPE)	SKWF_APPL		KW Framework: Objektschlüssel	20011009

Method GET_APPLICATION_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RAW_CONTENT	Call by reference	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Webserver	20010322
2	Exporting	E_CONTENT_SIZE	Call by reference	☐	Type reference (TYPE)	I			20010322
3	Exporting	E_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		GUID im 'CHAR' Format in Großschreibung	20030404

Method GET_DOC on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_DOC_LOIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DOC_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20010322

Method GET_DOC_LOIO on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_DOC_NAME Signature

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

Method GET_DOC_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_DOC_PHIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOC_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20010322
2	Returning	R_DOC_PHIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO			20010322

Method GET_DOC_PHIO on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_DOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_DOM	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010322

Method GET_DOM on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_DOM	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010322
2	Importing	IP_PARENT_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT			20010322
3	Importing	I_ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20010322
4	Returning	RP_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT			20010322

Method GET_ELEMENT on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_EXISTING_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RAW_CONTENT	Call by reference	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Webserver	20030226
2	Exporting	E_CONTENT_SIZE	Call by reference	☐	Type reference (TYPE)	I			20030226
3	Exporting	E_DOC_IS_EXISTING	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		wurde Dokument gefunden	20030226

Method GET_EXISTING_DOC on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_FILE_NAME Signature

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

Method GET_FILE_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_FOLDER_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FILE_NAME	Call by reference	☐	Type reference (TYPE)	CFX_TT_STRING		Tabelle mit strings	20010322
2	Exporting	ET_URL	Call by reference	☐	Type reference (TYPE)	CFX_TT_STRING		Tabelle mit strings	20010322
3	Importing	I_FOLDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20010322

Method GET_FOLDER_ENTRIES on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_FOLDER_LOIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FOLDER_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20010322
2	Returning	R_FOLDER_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20010322

Method GET_FOLDER_LOIO on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_FOLDER_NAME Signature

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

Method GET_FOLDER_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_TAG_NAME Signature

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

Method GET_TAG_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_URL Signature

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

Method GET_URL on class CL_CFX_SETTINGS_DOC has no exception.

Method GET_WEBDAV_SEETINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_APPLICATION_NAME	Value transfer	☐	Type reference (TYPE)	SKWF_APPL		Applikation	20010322
2	Exporting	E_CONNECTIONSPACE	Value transfer	☐	Type reference (TYPE)	SKWF_CSPCS		Liefert den Verbindungsbereich der Applikation	20010322
3	Exporting	E_FOLDER_CLASS	Value transfer	☐	Type reference (TYPE)	SDOK_CLASS		Liefert eine Verzeichnisklasse	20010322
4	Exporting	E_LOIOCLASS_FOR_PHIOCLASS	Value transfer	☐	Type reference (TYPE)	SDOK_CLASS		Liefert die logische Dokumentenklasse	20010322
5	Exporting	E_LOIO_CLASS_FOR_PUT	Value transfer	☐	Type reference (TYPE)	SDOK_CLASS		Liefert Dokumentenklassen zum Erzeugen eines neuen Dok.	20010322
6	Exporting	E_PHIOCLASS_FOR_FILE	Value transfer	☐	Type reference (TYPE)	SDOK_CLASS		Liefert Dokumentenklasse zu gegebenem Dateinamen	20010322
7	Exporting	E_PHIO_CLASS_FOR_PUT	Value transfer	☐	Type reference (TYPE)	SDOK_CLASS		Liefert Dokumentenklassen zum Erzeugen eines neuen Dok.	20010322
8	Exporting	E_UPDATE_VERSION	Value transfer	☐	Type reference (TYPE)	I			20010608

Method GET_WEBDAV_SEETINGS on class CL_CFX_SETTINGS_DOC has no exception.

Method IS_FILE_EXISTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS_EXISTING	Value transfer	☐	Type reference (TYPE)	CFX_BOOLEAN			20010322

Method IS_FILE_EXISTING on class CL_CFX_SETTINGS_DOC has no exception.

Method SAVE_DOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_DOM	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20010322

Method SAVE_DOM on class CL_CFX_SETTINGS_DOC has no exception.

Method SET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOC_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20010328

Method SET_NAME on class CL_CFX_SETTINGS_DOC has no exception.

Method TEST Signature

Method TEST on class CL_CFX_SETTINGS_DOC has no parameter.
Method TEST on class CL_CFX_SETTINGS_DOC has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	20A