SAP ABAP Class CL_FOPC_DOCUMENTS_MANAGER (Main Document Subsystem Manager Class)

Hierarchy

☛ FINBASIS (Software Component) Fin. Basis
   ⤷ FIN-CGV-MIC (Application Component) Management of Internal Controls
     ⤷ FOPC_DOCUMENTS (Package) Documents

Properties

Class	CL_FOPC_DOCUMENTS_MANAGER
Short Description	Main Document Subsystem Manager Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	FOPCD
Program status
Category	0
Package	FOPC_DOCUMENTS	Documents
Created	20040217	SAP
Last change	20060208	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)
2	CL_FOPC_DOCUMENTS_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	FOPCD	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SDOKA	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_FOPC_DOCUMENTS_MANAGER has no interface implemented.

Friends

Class CL_FOPC_DOCUMENTS_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DEFAULT_MIMETYPE	Constant	Public	☐	Type reference (TYPE)	W3CONTTYPE	'text/plain'	HTML content type	20041019
2	C_RO_PREFIX_PARENT	Constant	Public	☐	Type reference (TYPE)	FOPCD_UI_DOCUMENT_KEY_PREFIX	'2RO'	Key Prefix for Read Only Documents from Parent	20041023
3	C_RW_PREFIX_OWN	Constant	Public	☐	Type reference (TYPE)	FOPCD_UI_DOCUMENT_KEY_PREFIX	'0RW'	Key Prefix for Read Write Documents (Own Documents)	20041023
4	C_RW_PREFIX_PARENT	Constant	Public	☐	Type reference (TYPE)	FOPCD_UI_DOCUMENT_KEY_PREFIX	'1RW'	Key Prefix for Read Write Documents (from Parent)	20041023
5	C_TRY_ENSURE_DOWNLOAD_URL	Constant	Public	☐	Type reference (TYPE)	AS4FLAG	SPACE	Alternate downloader if default fails to retrieve URL	20041013
6	_TH_DOC_COLLECTION	Static Attribute	Private	☐	Type reference (TYPE)	YTH_DOC_COLLECTION			20040224
7	_T_MIC_LOIO_ATTRS	Static Attribute	Private	☐	Type reference (TYPE)	SDOKPROPTNS		List of Attribute Names of MIC LOIOs	20050803
8	_T_MIC_PHIO_ATTRS	Static Attribute	Private	☐	Type reference (TYPE)	SDOKPROPTNS		List of Attribute Names of MIC PHIOs	20050803

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_APPLICATION_OBJECT_KEY	Static method	Public	Method	From doc.application object key retrieves crm-bsp object key	20040225
2	BUILD_DOCUMENT_KEY	Static method	Public	Method	From document key retrieves crm-bsp object key	20040225
3	CHECK_IF_KPRO_DOCUMENT_EXISTS	Static method	Public	Method		20041013
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20040228
5	CLONE_OBJECT_DOCUMENTS	Static method	Public	Method		20041108
6	CONVERT_BINARY_TAB_TO_XSTRING	Static method	Public	Method		20040304
7	CONVERT_SIZE	Static method	Public	Method	Converts Size from Bytes to Specified UNIT (KB as Default)	20041026
8	CONVERT_STRING_TO_XSTRING	Static method	Public	Method		20041019
9	CONVERT_XSTRING_TO_BINARY_TAB	Static method	Public	Method		20040304
10	CONVERT_XSTRING_TO_STRING	Static method	Public	Method		20041018
11	CREATE_LOIO_PHIO_DOCUMENT	Static method	Public	Method	Stiores document content in given PHIO	20041007
12	DELETE_KPRO_DOCUMENT	Static method	Public	Method		20041013
13	DELETE_KPRO_DOCUMENT_TABLE	Static method	Public	Method		20041013
14	FACTORY_GET_DOC_COLLECTION	Static method	Public	Method	Instantiates handler for app. object documents collection	20040224
15	GET_ALL_MIC_LOIO_ATTRIBUTES	Static method	Public	Method	Returns are LOIO-relevant MIC attributes of attachment	20050803
16	GET_ALL_MIC_PHIO_ATTRIBUTES	Static method	Public	Method	Returns are LOIO-relevant MIC attributes of attachment	20050803
17	GET_DOCUMENT_DOWNLOAD_URL	Static method	Public	Method	From KPro properties fills runtime document structure	20041013
18	GET_KPRO_DOCUMENT_DESCRIPTION	Static method	Public	Method	Returns KPro Description of Given Document	20050808
19	GET_PHIOS_FROM_LOIOS_ALL	Static method	Public	Method		20050802
20	GET_PHIOS_FROM_LOIOS_NEWEST	Static method	Public	Method		20050802
21	GET_PHYSICAL_DOCUMENT_CONTENT	Static method	Public	Method		20040304
22	GET_UPLOAD_FILE_NAME	Static method	Public	Method		20041215
23	INVALIDATE_CACHE	Static method	Public	Method		20040224
24	IS_CACHE_EMPTY	Static method	Public	Method	Returns if cache of document collections is empty	20040224
25	LOCK_KPRO_DOCUMENT	Static method	Public	Method		20041013
26	LOCK_KPRO_DOCUMENT_TABLE	Static method	Public	Method		20041013
27	PARSE_APPLICATION_OBJECT_KEY	Static method	Public	Method	From crm-bsp object key retrieves doc.application object key	20040224
28	PARSE_DOCUMENT_KEY	Static method	Public	Method	From crm-bsp object key retrieves document key	20040225
29	PARSE_DOCUMENT_KEY_WITH_PREFIX	Static method	Public	Method	From crm-bsp object key retrieves document key	20040720
30	QUERY_DOCUMENTS	Static method	Public	Method		20041118
31	QUERY_DOCUMENT_PROPERTIES	Static method	Public	Method		20041121
32	RAISE_KPRO_S_ERROR	Static method	Public	Method	Raises CX_FOPC_DOCUMENTS_ERROR_MSG with given message	20041013
33	RAISE_KPRO_T_ERROR	Static method	Public	Method	Raises CX_FOPC_DOCUMENTS_ERROR_MSG with given message	20041013
34	SET_KPRO_DOCUMENT_PROPERTIES	Static method	Public	Method		20050803
35	SET_PHYSICAL_DOCUMENT_CONTENT	Static method	Public	Method	Stores Document Content in Given PHIO (Must Be Empty!!!)	20040305
36	UNLOCK_KPRO_DOCUMENT	Static method	Public	Method		20041013
37	UNLOCK_KPRO_DOCUMENT_TABLE	Static method	Public	Method		20041013
38	UPDATE_KPRO_DOCUMENT_CONTENT	Static method	Public	Method	Updates Document Content in Given PHIO	20050805
39	_GET_DOCUMENT_URL_CMS	Static method	Private	Method	From KPro properties fills runtime document structure	20041013
40	_GET_DOCUMENT_URL_FOPC	Static method	Private	Method	From KPro properties fills runtime document structure	20041013

Events

Class CL_FOPC_DOCUMENTS_MANAGER has no event.

Types

Class CL_FOPC_DOCUMENTS_MANAGER has no local type.

Method Signatures

Method BUILD_APPLICATION_OBJECT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20041103
2	Returning	R_OBJECT_KEY	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Schlüssel eines Objektes	20040225

Method BUILD_APPLICATION_OBJECT_KEY on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method BUILD_DOCUMENT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_S_KPRO_DOCUMENT_KEY			20041103
2	Importing	I_PREFIX	Value transfer	☐	Type reference (TYPE)	FOPCD_UI_DOCUMENT_KEY_PREFIX	CL_FOPC_DOCUMENTS_MANAGER=>C_RW_PREFIX_OWN		20040719
3	Returning	R_OBJECT_KEY	Value transfer	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Schlüssel eines Objektes	20040225

Method BUILD_DOCUMENT_KEY on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CHECK_IF_KPRO_DOCUMENT_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_FOPC_DOCUMENTS_MANAGER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CLONE_OBJECT_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_DOCUMENTS_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_FOPC_DOCUMENTS		Document Subsystem Exception	20041111
2	Exporting	E_CLONED_CNT	Call by reference	☐	Type reference (TYPE)	I			20041111
3	Exporting	E_WRITTEN_CNT	Call by reference	☐	Type reference (TYPE)	I			20041111
4	Importing	IR_APPL_LOG	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOPC_APPLICATION_LOG			20041109
5	Importing	IS_APPL_OBJECT_KEY_FROM	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20041108
6	Importing	IS_APPL_OBJECT_KEY_TO	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20041108
7	Importing	I_LOG_DETLEVEL	Call by reference	☑	Type reference (TYPE)	BALLEVEL		Anwendungs-Log: Detaillierungsgrad	20041109
8	Importing	I_LOG_PROBCLASS	Call by reference	☑	Type reference (TYPE)	BALPROBCL		Anwendungs-Log: Problemklasse einer Meldung	20041109

Method CLONE_OBJECT_DOCUMENTS on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CONVERT_BINARY_TAB_TO_XSTRING 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)	FOPCD_T_KPRO_PHIO_CONTENT			20040306
2	Importing	IT_BIN_CONTENT	Call by reference	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Web-Server	20040306
3	Importing	IT_BIN_META	Call by reference	☐	Type reference (TYPE)	SDOKFILACIS		SDOK: Angaben zu Dokumentinhalten in internen Tabellen	20040306

Method CONVERT_BINARY_TAB_TO_XSTRING on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CONVERT_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SIZE	Value transfer	☐	Type reference (TYPE)	DDSIZED		Größe (KB)	20041026
2	Importing	I_UNIT_BASIS	Call by reference	☐	Type reference (TYPE)	DDSIZED	1024	Größe (KB)	20041026
3	Returning	R_SIZE	Value transfer	☐	Type reference (TYPE)	DDSIZED		Größe (KB)	20041026

Method CONVERT_SIZE on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CONVERT_STRING_TO_XSTRING 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			20041019
2	Returning	R_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING			20041019

Method CONVERT_STRING_TO_XSTRING on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CONVERT_XSTRING_TO_BINARY_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BIN_CONTENT	Call by reference	☐	Type reference (TYPE)	SDOKCNTBINS		SDOK: Tabelle von Binärdokumentinhalten für den Web-Server	20040304
2	Exporting	ET_BIN_META	Call by reference	☐	Type reference (TYPE)	SDOKFILACIS		SDOK: Angaben zu Dokumentinhalten in internen Tabellen	20040304
3	Importing	I_FILENAME	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20040304
4	Importing	I_MIME_TYPE	Call by reference	☑	Type reference (TYPE)	W3CONTTYPE		HTML-Content-Type	20040304
5	Importing	I_PROPERTY	Call by reference	☑	Type reference (TYPE)	SDOK_COMPR		Komponentenattribut für die Anwendung	20040304
6	Importing	I_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING			20040304

Method CONVERT_XSTRING_TO_BINARY_TAB on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

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

Method CONVERT_XSTRING_TO_STRING on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method CREATE_LOIO_PHIO_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041007
2	Exporting	ES_PHIO	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041007
3	Importing	IT_LOIO_PROPERTIES	Value transfer	☑	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20041007
4	Importing	IT_PHIO_PROPERTIES	Value transfer	☑	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20041007
5	Importing	I_LOIO_CLASS	Call by reference	☑	Type reference (TYPE)	SKWF_CLS		KW Framework: Info Objekt Klasse	20041007
6	Importing	I_PHIO_CLASS	Call by reference	☑	Type reference (TYPE)	SKWF_CLS		KW Framework: Info Objekt Klasse	20041007

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041007

Method DELETE_KPRO_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
2	Importing	I_DELETE_CHILDREN	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	SPACE	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method DELETE_KPRO_DOCUMENT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_IOS	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		KW Framework: Objektschlüssel	20041013
2	Importing	I_DELETE_CHILDREN	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	SPACE	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method FACTORY_GET_DOC_COLLECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20040224
2	Returning	RR_DOC_COLLECTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_FOPC_DOCUMENTS_COLLECTION		Handler for set of documents belonging to one app. object	20040224

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20040225

Method GET_ALL_MIC_LOIO_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_LOIO_PROPERTIES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTNS		List von Attributnamen (als Struktur)	20050803

Method GET_ALL_MIC_LOIO_ATTRIBUTES on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method GET_ALL_MIC_PHIO_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_PHIO_PROPERTIES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTNS		List von Attributnamen (als Struktur)	20050803

Method GET_ALL_MIC_PHIO_ATTRIBUTES on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method GET_DOCUMENT_DOWNLOAD_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY		MIC Application Object Key	20041013
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
3	Importing	I_ALT_DOWNLOADER_RELATIVE_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Generate URL for alternate downloader relative (for UI)	20050404
4	Importing	I_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20050401
5	Importing	I_CONT_DISP_AS_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Use 'attachment' instead of 'inline' in content-disposition	20050401
6	Importing	I_RETURN_LINKS_AS_DOCUMENTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Hanle MIC Links as normal documents	20050331
7	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method GET_KPRO_DOCUMENT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOC_CLASS	Call by reference	☐	Type reference (TYPE)	SDOK_CLASS		Dokumentenklasse	20050808
2	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID für Dokumente und Beziehungen	20050808
3	Importing	I_LANGU	Value transfer	☐	Type reference (TYPE)	SDOK_MSLAN	SY-LANGU		20050808
4	Returning	R_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	SDOK_TITEL		Titel eines Dokuments	20050808

Method GET_KPRO_DOCUMENT_DESCRIPTION on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method GET_PHIOS_FROM_LOIOS_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PHIO	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20050802
2	Exporting	ET_PHIO_PROPERTIES_VALUES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTLS		SDOK: Objekt, Attributname und Ausprägung	20050802
3	Importing	IT_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20050802
4	Importing	IT_PHIO_PROPERTIES_NAMES	Value transfer	☑	Type reference (TYPE)	SDOKPROPTNS		SDOK: Name von Attributen eines Objektes	20050802

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050802

Method GET_PHIOS_FROM_LOIOS_NEWEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LPIO	Value transfer	☐	Type reference (TYPE)	SKWF_LPIOS			20050802
2	Exporting	ET_PHIO	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20050802
3	Exporting	ET_PHIO_PROPERTIES_VALUES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTLS		SDOK: Objekt, Attributname und Ausprägung	20050802
4	Importing	IT_LOIO	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20050802
5	Importing	IT_PHIO_PROPERTIES_NAMES	Value transfer	☑	Type reference (TYPE)	SDOKPROPTNS		SDOK: Name von Attributen eines Objektes	20050802

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050802

Method GET_PHYSICAL_DOCUMENT_CONTENT 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)	FOPCD_T_KPRO_PHIO_CONTENT		SDOK: Tabelle von Binärdokumentinhalten für den Web-Server	20040306
2	Exporting	ET_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20040306
3	Exporting	E_NO_CONTENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20041111
4	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20040306
5	Importing	IS_REQUIRED_MIC_APPL_OBJECT	Call by reference	☑	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY		Only if document belongs to specifed MIC appl. object	20040310
6	Importing	I_ACCESS_INFO_ONLY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Read only content properties, not raw content itself	20041012
7	Importing	I_PHIO_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20050407
8	Importing	I_REQUIRED_SAME_MIC_TASK	Value transfer	☐	Type reference (TYPE)	AS4FLAG	SPACE	Doc.content retrieval only if taskid same as creation task	20040407

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20040305

Method GET_UPLOAD_FILE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING			20041215
2	Exporting	E_EXTENSION	Call by reference	☐	Type reference (TYPE)	STRING			20041215
3	Exporting	E_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING			20041215
4	Importing	I_FULLNAME	Call by reference	☐	Type reference (TYPE)	STRING			20041215

Method GET_UPLOAD_FILE_NAME on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method INVALIDATE_CACHE Signature

Method INVALIDATE_CACHE on class CL_FOPC_DOCUMENTS_MANAGER has no parameter.
Method INVALIDATE_CACHE on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method IS_CACHE_EMPTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS_EMPTY	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Cache is empty	20040224

Method IS_CACHE_EMPTY on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method LOCK_KPRO_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
2	Importing	I_EXCLUSIVE	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	'X'	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013
3	Importing	I_WAIT	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	SPACE	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method LOCK_KPRO_DOCUMENT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_IOS	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		KW Framework: Objektschlüssel	20041013
2	Importing	I_ALL_OR_NONE	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	'X'	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013
3	Importing	I_EXCLUSIVE	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	'X'	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013
4	Importing	I_WAIT	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	SPACE	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method PARSE_APPLICATION_OBJECT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Schlüssel eines Objektes	20040224
2	Returning	R_APPL_OBJECT_KEY	Value transfer	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY			20040224

Method PARSE_APPLICATION_OBJECT_KEY on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method PARSE_DOCUMENT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Schlüssel eines Objektes	20040225
2	Returning	R_DOCUMENT_KEY	Value transfer	☐	Type reference (TYPE)	FOPCD_S_KPRO_DOCUMENT_KEY			20040225

Method PARSE_DOCUMENT_KEY on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method PARSE_DOCUMENT_KEY_WITH_PREFIX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_S_KPRO_DOCUMENT_KEY			20040720
2	Exporting	E_PREFIX	Call by reference	☐	Type reference (TYPE)	FOPCD_UI_DOCUMENT_KEY_PREFIX			20040720
3	Importing	I_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	CRMT_BSP_OBJECTKEY		Schlüssel eines Objektes	20040720

Method PARSE_DOCUMENT_KEY_WITH_PREFIX on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method QUERY_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETH_RESULT	Call by reference	☐	Type reference (TYPE)	FOPCD_TH_PHIOS_OF_LOIO		Tabelle mit getypten Info Objekten	20041118
2	Importing	ITR_CATEGORY	Call by reference	☐	Type reference (TYPE)	FOPCD_TR_DOCUMENT_CATEGORY			20041118
3	Importing	ITR_CLASS	Call by reference	☐	Type reference (TYPE)	FOPCD_TR_DOCUMENT_CLASS		Only EQ, I supported	20041118
4	Importing	ITR_ID	Call by reference	☐	Type reference (TYPE)	FOPCD_TR_DOCUMENT_OBJ_ID			20041118
5	Importing	ITR_TASK	Call by reference	☐	Type reference (TYPE)	FOPCD_TR_DOCUMENT_TASK			20041118
6	Importing	ITR_TYPE	Call by reference	☐	Type reference (TYPE)	FOPCD_TR_DOCUMENT_OBJ_TYPE			20041118
7	Importing	I_RESOLVE_PHIOS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20041118

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041118

Method QUERY_DOCUMENT_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PHIO_ACCESS_INFO	Call by reference	☐	Type reference (TYPE)	FOPCD_T_KPRO_DOCUMENT_CONTENT			20041121
2	Exporting	ET_PROPERTIES_VALUES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTLS		Liste von Attributausprägungen von Objekten	20041121
3	Importing	IS_DOCUMENT_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041121
4	Importing	IT_ADDITIONAL_PROPERTIES	Value transfer	☑	Type reference (TYPE)	SDOKPROPTNS		List von Attributnamen (als Struktur)	20041121
5	Importing	I_ALT_DOWNLOADER_AS_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Forcr 'attachment' mode in disposition for alternative down.	20050407
6	Importing	I_ALT_DOWNLOADER_RELATIVE_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Return relative URL if alternative doenloader used	20050404
7	Importing	I_NO_STD_PROPERTIES	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Skip reading standard FOPC properties	20041121
8	Importing	I_RESOLVE_DOWNLOAD_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	When reading access info resolve also download URL	20050331

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041121

Method RAISE_KPRO_S_ERROR Signature

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

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS_ERROR_MSG	☐	Exception class error message from Doc.Management Subsystem	20041013

Method RAISE_KPRO_T_ERROR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KPRO_ERROR	Call by reference	☐	Type reference (TYPE)	SKWF_IOERRS		KW Framework: Fehler Objekt	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS_ERROR_MSG	☐	Exception class error message from Doc.Management Subsystem	20041013

Method SET_KPRO_DOCUMENT_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20050803
2	Importing	IT_PROPERTY_TABLE	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20050803

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050803

Method SET_PHYSICAL_DOCUMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTENT	Call by reference	☐	Type reference (TYPE)	FOPCD_S_KPRO_DOCUMENT_CONTENT			20041007
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20040305

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20040305

Method UNLOCK_KPRO_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_IO	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
2	Importing	I_EXCLUSIVE	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	'X'	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

Method UNLOCK_KPRO_DOCUMENT on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method UNLOCK_KPRO_DOCUMENT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_IOS	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		KW Framework: Objektschlüssel	20041013
2	Importing	I_EXCLUSIVE	Value transfer	☐	Type reference (TYPE)	SKWF_FLAG	'X'	KW Framework: Boolsche Flagge ('X' gesetzt, ' ' gelöscht)	20041013

Method UNLOCK_KPRO_DOCUMENT_TABLE on class CL_FOPC_DOCUMENTS_MANAGER has no exception.

Method UPDATE_KPRO_DOCUMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONTENT	Call by reference	☐	Type reference (TYPE)	FOPCD_S_KPRO_DOCUMENT_CONTENT			20050805
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20050805
3	Importing	I_CREATE_NEW_VERSION	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Create new version or delete the old most recent version	20050805
4	Returning	RS_NEW_PHIO_KEY	Value transfer	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20050805

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20050805

Method _GET_DOCUMENT_URL_CMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY		MIC Application Object Key	20041013
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
3	Importing	I_ALT_DOWNLOADER_RELATIVE_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050404
4	Importing	I_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20050401
5	Importing	I_CONT_DISP_AS_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Use 'attachment' instead of 'inline' in content-disposition	20050401
6	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

Method _GET_DOCUMENT_URL_FOPC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_APPL_OBJ_KEY	Call by reference	☐	Type reference (TYPE)	FOPCD_APPLICATION_OBJECT_KEY		MIC Application Object Key	20041013
2	Importing	IS_PHIO_KEY	Call by reference	☐	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20041013
3	Importing	I_COMPONENT_ID	Call by reference	☑	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20050401
4	Importing	I_CONT_DISP_AS_ATTACHMENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Use 'attachment' instead of 'inline' in content-disposition	20050401
5	Importing	I_USE_RELATIVE_URL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050404
6	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	SAEURI		SAP ArchiveLink: Datenelement für absolute URI	20041013

#	Exception	Resumable	Description	Created on
1	CX_FOPC_DOCUMENTS	☐	Document Subsystem Exception	20041013

History

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