SAP ABAP Class CL_CFX_DOC_UTILS (Help Functions for SKWF Management)

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_DOC_UTILS
Short Description	Help Functions for SKWF Management
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_FOLDERS	Collaboration Folders: Folder and Documents
Created	20020415	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)

Interfaces

Class CL_CFX_DOC_UTILS has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_DPR_CFX_DOCUMENT	☐	20050314	Project Management Document Class
2	CL_DPR_CFX_DOCUMENT_VERSION	☐	20050314	CDOCS: Main Files
3	CL_DPR_CFX_FOLDER	☐	20050314	Folder for Project Management
4	CL_EDMS_DOCUMENT_FACTORY	☐	20050314	EDMS: Factory for Documents

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_SCAT_INFO	Static Attribute	Private	☐	Type reference (TYPE)	TS_CAT_INFO		Storage Repository for Physical Objects	20041122

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	FILTER_CONTENT_CATEGORIES	Static method	Public	Method	Filter List of Content Categories to HTTP Repositories	20020415
2	GET_ACTIVE_LOCATION	Static method	Public	Method	Returns Location of User	20020422
3	GET_BASENAME	Static method	Public	Method	File Without Extension and Without Path	20041122
4	GET_CATEGORY_FOR_LOCATION	Static method	Public	Method	Calculates Storage Category from Location	20020415
5	GET_CONTENT_CATEGORY_LIST	Static method	Public	Method	Read List of Content Categories Defined in Customizing	20020415
6	GET_CONTENT_SERVER_FOR_FILES	Static method	Public	Method	Returns Storage Category if (Exactly) one CS is Installed	20020415
7	GET_CS_URL	Static method	Public	Method	Returns URL for Get and Post for Content Servers	20020730
8	GET_DEFAULT_LOCATION	Static method	Public	Method	Return Standard Location	20020415
9	GET_EXTENSION	Static method	Public	Method	Extension of a file	20041122
10	GET_FILENAME	Static method	Public	Method	File Without Path	20041122
11	GET_LOCATION_LIST	Static method	Public	Method	Read List of Locations	20020422
12	GET_MIMETYPE	Static method	Public	Method	Determine Mimetype for File	20041122
13	GET_PATHNAME	Static method	Public	Method		20041122
14	GET_REPOSITORY	Static method	Public	Method	Determine Repository for Category	20041122
15	GET_SCAT_INFO	Static method	Public	Method	Infos for Category	20041122
16	GET_USER_LOCATION_FROM_PARAM	Static method	Public	Method	Read Location of User from Memory Parameter	20020422
17	GET_USER_LOCATION_FROM_SETTING	Static method	Public	Method	Read Location of User from User's cFolders Settings	20020422
18	REMOVE_SKWF_LOCK	Static method	Private	Method	Delete Lock	20050314
19	SET_SKWF_LOCK	Static method	Private	Method	Set Lock	20050314
20	SET_USER_LOCATION_PARAM	Static method	Public	Method	Write Location of User to Memory Parameter	20020422
21	SPLIT_FILE	Static method	Private	Method	Separate File Name into File and Extension	20041122
22	SPLIT_PATH	Static method	Private	Method	Separate File Path into Path and File	20041122

Events

Class CL_CFX_DOC_UTILS has no event.

Types

Class CL_CFX_DOC_UTILS has no local type.

Method Signatures

Method FILTER_CONTENT_CATEGORIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CATEGORY	Call by reference	☐	Type reference (TYPE)	CFX_TT_CDOCS_CONT_CATEGORY		CDOCS: Liste mit Content Categories gemäß KPRO-Customizing	20020415
2	Importing	I_SUBTYPE	Call by reference	☐	Type reference (TYPE)	SCMS_CRSTP		Ablagesubtyp	20020415
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	SCMS_CRTYP		Ablagetyp (Datenbank, HTTP-Content-Server...)	20020415

Method FILTER_CONTENT_CATEGORIES on class CL_CFX_DOC_UTILS has no exception.

Method GET_ACTIVE_LOCATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IP_ADDRESS	Call by reference	☐	Type reference (TYPE)	STRING			20020422
2	Returning	R_LOCATION	Value transfer	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020422

Method GET_ACTIVE_LOCATION on class CL_CFX_DOC_UTILS has no exception.

Method GET_BASENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
2	Returning	R_BASENAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122

Method GET_BASENAME on class CL_CFX_DOC_UTILS has no exception.

Method GET_CATEGORY_FOR_LOCATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOCATION	Call by reference	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020415
2	Returning	R_CATEGORY	Value transfer	☐	Type reference (TYPE)	SDOK_STCAT		Kategorie für physische Dokumente	20020415

Method GET_CATEGORY_FOR_LOCATION on class CL_CFX_DOC_UTILS has no exception.

Method GET_CONTENT_CATEGORY_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUSPACE	Call by reference	☐	Type reference (TYPE)	SDOK_DOCSP		Dokumentbereich	20020415
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	aktuelle Sprache	20020415
3	Returning	RT_CATEGORIES	Value transfer	☐	Type reference (TYPE)	CFX_TT_CDOCS_CONT_CATEGORY		CDOCS: Liste mit Content Categories gemäß KPRO-Customizing	20020415

Method GET_CONTENT_CATEGORY_LIST on class CL_CFX_DOC_UTILS has no exception.

Method GET_CONTENT_SERVER_FOR_FILES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOCATION	Call by reference	☑	Type reference (TYPE)	SDOK_LOC		Ausgewählter Standort	20080826
2	Returning	R_CATEGORY	Value transfer	☐	Type reference (TYPE)	SDOK_STCAT		Kategorie für physische Dokumente	20020415

Method GET_CONTENT_SERVER_FOR_FILES on class CL_CFX_DOC_UTILS has no exception.

Method GET_CS_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PHIO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		GUID im 'CHAR' Format in Großschreibung	20020730
2	Importing	I_GET	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		true = GET, false = POST	20020730
3	Importing	I_LOCATION	Call by reference	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020730
4	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20020730

Method GET_CS_URL on class CL_CFX_DOC_UTILS has no exception.

Method GET_DEFAULT_LOCATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_LOCATION	Value transfer	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020415

Method GET_DEFAULT_LOCATION on class CL_CFX_DOC_UTILS has no exception.

Method GET_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
2	Returning	R_EXTENSION	Value transfer	☐	Type reference (TYPE)	W3FILEEXT		Filenamenserweiterung	20041122

Method GET_EXTENSION on class CL_CFX_DOC_UTILS has no exception.

Method GET_FILENAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
2	Returning	R_FILENAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122

Method GET_FILENAME on class CL_CFX_DOC_UTILS has no exception.

Method GET_LOCATION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	aktuelle Sprache	20020422
2	Returning	RT_LOCATIONS	Value transfer	☐	Type reference (TYPE)	CFX_TT_CDOCS_LOCATION		CDOCS: Liste mit Lokationen und Beschreibung	20020422

Method GET_LOCATION_LIST on class CL_CFX_DOC_UTILS has no exception.

Method GET_MIMETYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SAEURI		HTML-Content-Type	20041122
2	Returning	R_MIMETYPE	Value transfer	☐	Type reference (TYPE)	W3CONTTYPE		HTML-Content-Type	20041122

Method GET_MIMETYPE on class CL_CFX_DOC_UTILS has no exception.

Method GET_PATHNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
2	Returning	R_PATHNAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122

Method GET_PATHNAME on class CL_CFX_DOC_UTILS has no exception.

Method GET_REPOSITORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SCAT	Call by reference	☐	Type reference (TYPE)	SDOK_STCAT		Kategorie für physische Dokumente	20041122
2	Returning	R_REPOSITORY	Value transfer	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20041122

Method GET_REPOSITORY on class CL_CFX_DOC_UTILS has no exception.

Method GET_SCAT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXTERNAL_URL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20041122
2	Exporting	E_REPOSITORY	Call by reference	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20041122
3	Exporting	E_REPOSITORY_TYPE	Call by reference	☐	Type reference (TYPE)	SCMS_CRTYP		Ablagetyp (Datenbank, HTTP-Content-Server...)	20041122
4	Importing	I_SCAT	Call by reference	☐	Type reference (TYPE)	SDOK_STCAT		Kategorie für physische Dokumente	20041122

Method GET_SCAT_INFO on class CL_CFX_DOC_UTILS has no exception.

Method GET_USER_LOCATION_FROM_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_LOCATION	Value transfer	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020422

Method GET_USER_LOCATION_FROM_PARAM on class CL_CFX_DOC_UTILS has no exception.

Method GET_USER_LOCATION_FROM_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_USERID	Call by reference	☐	Type reference (TYPE)	CFX_USERID	SY-UNAME	User Id	20020606
2	Returning	R_LOCATION	Value transfer	☐	Type reference (TYPE)	SDOK_LOC			20020422

Method GET_USER_LOCATION_FROM_SETTING on class CL_CFX_DOC_UTILS has no exception.

Method REMOVE_SKWF_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20050314
2	Importing	I_LOCKED_BY	Call by reference	☑	Type reference (TYPE)	UNAME		Benutzername	20050314
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	Benutzername	20050314

Method REMOVE_SKWF_LOCK on class CL_CFX_DOC_UTILS has no exception.

Method SET_SKWF_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20050314
2	Importing	I_LOCKED_BY	Call by reference	☑	Type reference (TYPE)	UNAME		Benutzername	20050314
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	Benutzername	20050314

Method SET_SKWF_LOCK on class CL_CFX_DOC_UTILS has no exception.

Method SET_USER_LOCATION_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOCATION	Call by reference	☐	Type reference (TYPE)	SDOK_LOC		Lokation als Verteilungskriterium	20020422

Method SET_USER_LOCATION_PARAM on class CL_CFX_DOC_UTILS has no exception.

Method SPLIT_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXTENSION	Value transfer	☐	Type reference (TYPE)	W3FILEEXT		Filenamenserweiterung	20041122
2	Exporting	E_FILE	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
3	Importing	I_FILE	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122

Method SPLIT_FILE on class CL_CFX_DOC_UTILS has no exception.

Method SPLIT_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FILE	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
2	Exporting	E_PATH	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122
3	Importing	I_PATH	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041122

Method SPLIT_PATH on class CL_CFX_DOC_UTILS has no exception.

History

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