SAP ABAP Class CL_CDOCS_UTILS (CDOCs: Utilities for Files)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-DOC (Application Component) Engineering Documents
     ⤷ EDMS_SKWF_LAYER (Package) EDMS: Communication with KPRO (SKWF)

Properties

Class	CL_CDOCS_UTILS
Short Description	CDOCs: Utilities for Files
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	EDMS_SKWF_LAYER	EDMS: Communication with KPRO (SKWF)
Created	20020404	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	CL_CDOCS_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_CDOCS_UTILS has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CDOCS_COMMON_FILE	☐	20020405	CDOCS: Main Files
2	CL_CDOCS_DOCUMENT	☐	20020405	CDOCS: Document
3	CL_CDOCS_FACTORY	☐	20020405	CDOCs: Factory for Document
4	CL_CDOCS_FOLDER	☐	20020405	CDOCS: Main Files

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_INVALID_CHARS	Constant	Public	☐	Type reference (TYPE)	STRING	'üäöÜÄÖß?!"§/()={}[]*<>:'		20020816
2	M_SCAT_INFO	Static Attribute	Private	☐	Type reference (TYPE)	TS_CAT_INFO		Storage Repository for Physical Objects	20020409

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_FILE_URL	Static method	Public	Method	Generate File URL	20020419
2	GET_BASENAME	Static method	Public	Method	File Without Extension and Without Path	20020404
3	GET_BASENAME4URL	Static method	Public	Method	Determine File Name for URL	20041110
4	GET_EXTENSION	Static method	Public	Method	Extension of a file	20020404
5	GET_FILENAME	Static method	Public	Method	File Without Path	20020404
6	GET_INVALID_CHARS_IN_DOCNAME	Static method	Public	Method	Determine Invalid Characters in Document Name	20020816
7	GET_LOIO_CLASS_FOR_ID	Static method	Public	Method	Find Class for ID	20020408
8	GET_MIMETYPE	Static method	Public	Method	Determine Mimetype for File	20020404
9	GET_PATHNAME	Static method	Public	Method	Path Name Without File	20020404
10	GET_REPOSITORY	Static method	Public	Method	Determine Repository for Category	20020404
11	GET_REPOSITORY_TYPE	Static method	Public	Method	Infos for Repository	20020404
12	GET_SCAT_INFO	Static method	Public	Method	Infos for Category	20020409
13	GET_SKWF_ERROR_FROM_SYS	Static method	Private	Method	Fill SKWF Errors from System Notifications	20020405
14	REMOVE_SKWF_LOCK	Static method	Private	Method	Delete Lock	20020405
15	SET_SKWF_LOCK	Static method	Private	Method	Set Lock	20020405
16	SORT_CHILDREN	Instance method	Public	Method	Sort Documents	20020410
17	SPLIT_FILE	Static method	Private	Method	Separate File Name into File and Extension	20020404
18	SPLIT_PATH	Static method	Private	Method	Separate File Path into Path and File	20020404
19	VALIDATE_DOCUMENT_NAME	Static method	Public	Method	Check Validity of a Document Name in a Folder	20020416

Events

Class CL_CDOCS_UTILS has no event.

Types

Class CL_CDOCS_UTILS has no local type.

Method Signatures

Method BUILD_FILE_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_URL	Call by reference	☐	Type reference (TYPE)	SKWF_URL		KW Framework: URL oder Teil-URL	20020419

Method BUILD_FILE_URL on class CL_CDOCS_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	20020404
2	Returning	R_BASENAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404

Method GET_BASENAME on class CL_CDOCS_UTILS has no exception.

Method GET_BASENAME4URL 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	20041110
2	Returning	R_DOCNAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041110

Method GET_BASENAME4URL on class CL_CDOCS_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	20020404
2	Returning	R_EXTENSION	Value transfer	☐	Type reference (TYPE)	W3FILEEXT		Filenamenserweiterung	20020404

Method GET_EXTENSION on class CL_CDOCS_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	20020404
2	Returning	R_FILENAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404

Method GET_FILENAME on class CL_CDOCS_UTILS has no exception.

Method GET_INVALID_CHARS_IN_DOCNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	EDMS_DOC_NAME		Name	20020816
2	Returning	R_BAD_CHARS	Value transfer	☐	Type reference (TYPE)	STRING		ungültige Zeichen	20020816

Method GET_INVALID_CHARS_IN_DOCNAME on class CL_CDOCS_UTILS has no exception.

Method GET_LOIO_CLASS_FOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID für Dokumente und Beziehungen	20020408
2	Returning	RT_OBJECTS	Value transfer	☐	Type reference (TYPE)	SDOKOBJECTS		Objektliste	20020408

Method GET_LOIO_CLASS_FOR_ID on class CL_CDOCS_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	20020404
2	Returning	R_MIMETYPE	Value transfer	☐	Type reference (TYPE)	W3CONTTYPE		HTML-Content-Type	20020404

Method GET_MIMETYPE on class CL_CDOCS_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	20020404
2	Returning	R_PATHNAME	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404

Method GET_PATHNAME on class CL_CDOCS_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	20020404
2	Returning	R_REPOSITORY	Value transfer	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20020404

Method GET_REPOSITORY on class CL_CDOCS_UTILS has no exception.

Method GET_REPOSITORY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REPOSITORY	Call by reference	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20020404
2	Returning	R_TYPE	Value transfer	☐	Type reference (TYPE)	SCMS_CRTYP		Ablagetyp (R/3-Datenbank, HTTP-Content-Server...)	20020404

Method GET_REPOSITORY_TYPE on class CL_CDOCS_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			20020409
2	Exporting	E_REPOSITORY	Call by reference	☐	Type reference (TYPE)	SCMS_CREP		Ablageort für physische Dokumente	20020409
3	Exporting	E_REPOSITORY_TYPE	Call by reference	☐	Type reference (TYPE)	SCMS_CRTYP		Ablagetyp (R/3-Datenbank, HTTP-Content-Server...)	20020409
4	Importing	I_SCAT	Call by reference	☐	Type reference (TYPE)	SDOK_STCAT		Kategorie für physische Dokumente	20020409

Method GET_SCAT_INFO on class CL_CDOCS_UTILS has no exception.

Method GET_SKWF_ERROR_FROM_SYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ERROR	Value transfer	☐	Type reference (TYPE)	SKWF_ERROR		KW Framework: Fehler Objekt	20020405

Method GET_SKWF_ERROR_FROM_SYS on class CL_CDOCS_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	20020405
2	Importing	I_LOCKED_BY	Call by reference	☑	Type reference (TYPE)	UNAME		Benutzername	20020405
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	Benutzername	20020405

Method REMOVE_SKWF_LOCK on class CL_CDOCS_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	20020405
2	Importing	I_LOCKED_BY	Call by reference	☑	Type reference (TYPE)	UNAME		Benutzername	20020405
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	UNAME	SY-UNAME	Benutzername	20020405

Method SET_SKWF_LOCK on class CL_CDOCS_UTILS has no exception.

Method SORT_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_CHILDREN	Call by reference	☐	Type reference (TYPE)	CFX_TT_CDOCS_COMMON_ID		CDOCS: Liste von Dokumenten	20020410

Method SORT_CHILDREN on class CL_CDOCS_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	20020404
2	Exporting	E_FILE	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404
3	Importing	I_FILE	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404

Method SPLIT_FILE on class CL_CDOCS_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	20020404
2	Exporting	E_PATH	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404
3	Importing	I_PATH	Call by reference	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20020404

Method SPLIT_PATH on class CL_CDOCS_UTILS has no exception.

Method VALIDATE_DOCUMENT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	EDMS_DOC_NAME		Name	20020416
2	Returning	R_IS_VALID	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20020416

Method VALIDATE_DOCUMENT_NAME on class CL_CDOCS_UTILS has no exception.

History

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