SAP ABAP Class CL_FOPC_DOCUMENTS_COLLECTION (Handler for set of documents belonging to one app. object)
Hierarchy
☛ FINBASIS (Software Component) Fin. Basis
   ⤷ FIN-CGV-MIC (Application Component) Management of Internal Controls
     ⤷ FOPC_DOCUMENTS (Package) Documents
Properties
Class CL_FOPC_DOCUMENTS_COLLECTION  
Short Description Handler for set of documents belonging to one app. object    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class FOPCD    
Program status     
Category 0   
Package FOPC_DOCUMENTS   Documents 
Created 20040224   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_COLLECTION 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 FOPCE Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
5 SKWFC Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_FOPC_DOCUMENTS_COLLECTION has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_FOPC_DOCUMENTS_MANAGER 20040224 Main Document Subsystem Manager Class
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 APPL_OBJ_KEY Instance attribute Public Type reference (TYPE) FOPCD_APPLICATION_OBJECT_KEY 20040224
2 C_CONTENT_HASH_ALG Constant Public Type reference (TYPE) HASHALG SPACE Document content hash type (MD5, SHA1, space = disabled) 20040226
3 C_NEW_DOCUMENT_DESCRIPTION Static Attribute Public Type reference (TYPE) SDOK_TITEL Component of Version Number 20040305
4 C_NEW_URLLINK_DESCRIPTION Static Attribute Public Type reference (TYPE) SDOK_TITEL Title of a document 20041019
5 TH_DOCUMENTS Instance attribute Public Type reference (TYPE) FOPCD_TH_RUNTIME_DOCS 20040225
6 _TH_DOC_VERSIONS Static Attribute Private Type reference (TYPE) YTH_DOCUMENT_VERSION 20050803
7 _TH_DOC_VERSIONS_NUM Static Attribute Private Type reference (TYPE) YTH_DOCUMENT_VERSION_NUM 20050808
8 _TH_DOMAIN_VALUE_TEXT Static Attribute Private Type reference (TYPE) YTH_DOMAIN_VALUE_TEXT 20041105
Methods
# Method Level Visibility Method type Description Created on
1 ADD_DOCUMENT Instance method Public Method Adds runtime document to document collection 20040224
2 CHECK_ALLOWED_TO_CHANGE Instance method Private Method Check if user is allowed to change or delete doc. via task 20040312
3 CLASS_CONSTRUCTOR Static method Public Constructor 20040305
4 COMPUTE_HASH Static method Public Method Computes hash code 20040226
5 CONSTRUCTOR Instance method Public Constructor 20040224
6 CONVERT_TIMESTAMP Static method Public Method Converts timestamp in UTC to time and date 20040226
7 CREATE_DOCUMENT Instance method Public Method Creates new document in collection 20040225
8 DELETE_ALL_DOCUMENTS Instance method Public Method 20040303
9 DELETE_DOCUMENT Instance method Public Method 20040224
10 FREE Instance method Public Method 20040224
11 GET_CHANGED_DOCUMENTS Instance method Public Method Returns All Changed Documents (Added/Modified/Deleted) 20050322
12 GET_DDIC_DOMAIN_VALUE_TEXT Static method Public Method 20041105
13 GET_DOCUMENT Instance method Public Method Returns Given Document from Collection 20050804
14 GET_DOCUMENT_DESCRIPTION Instance method Public Method 20040305
15 GET_DOCUMENT_LOIO_KEY Static method Public Method Retrieves document LOIO key 20041108
16 GET_DOCUMENT_PHIO_KEY Static method Public Method Retrieves document LOIO key 20041108
17 GET_DOCUMENT_PHYSICAL_VERSIONS Instance method Public Method Returns All Existing Physical (PHIO) Versions of Given Doc. 20050803
18 GET_DOC_ACCESS_TEXT Static method Public Method 20041017
19 GET_DOC_CATEGORY_TEXT Static method Public Method 20041014
20 GET_DOC_CLASS_TEXT Static method Public Method 20041014
21 GET_DOC_ORIGIN_TEXT Static method Public Method 20041023
22 GET_LOIO_CLASS_FROM_PHIO_CLASS Static method Public Method 20040930
23 GET_NUMBER_OF_VERSIONS Static method Public Method Returns All Existing Physical (PHIO) Versions of Given Doc. 20050808
24 GET_PHIO_CLASS_FROM_LOIO_CLASS Static method Public Method 20040930
25 GET_STD_DOC_CREATION_HEADER Instance method Public Method Returns prefilled document KPro header for newly created doc 20040226
26 SET_NEW_DOCUMENT_DESCRIPTION Instance method Public Method 20040305
27 SYNCHRONIZE_WITH_DOC_STORAGE Instance method Public Method Synchronizes cached data with document storage system 20040224
28 UPDATE_DOCUMENT Instance method Public Method Updates document content and/or header in collection 20040224
29 WAS_ANY_DOCUMENT_CHANGED Instance method Public Method Returns whether the collection contains any changed docs 20050322
30 _DELETE_DOCUMENT_FROM_STORAGE Instance method Private Method 20040229
31 _FILL_DOCUMENT_CONTENT_INFO Instance method Private Method From KPro properties fills runtime document structure 20050803
32 _FILL_DOCUMENT_PROPERTIES Instance method Private Method From KPro properties fills runtime document structure 20040302
33 _FILL_LOIO_PHIO_PROPERTIES Instance method Private Method FIlls PHIO or LOIO object properties from runtime document 20040302
34 _INSERT_DOCUMENT_TO_STORAGE Instance method Private Method 20040229
35 _RAISE_ERROR_MSG_EXCEPTION Static method Private Method Raises CX_FOPC_DOCUMENTS_ERROR_MSG with given message 20040302
36 _RAISE_KPRO_S_ERROR Static method Private Method Raises CX_FOPC_DOCUMENTS_ERROR_MSG with given message 20040302
37 _RAISE_KPRO_T_ERROR Static method Private Method Raises CX_FOPC_DOCUMENTS_ERROR_MSG with given message 20040302
38 _REREAD_DOCUMENTS_FROM_STORAGE Instance method Private Method 20040224
39 _UPDATE_DOCUMENT_IN_STORAGE Instance method Private Method 20040229
40 _WRITE_DOCUMENTS_TO_STORAGE Instance method Private Method 20040224
Events
Class CL_FOPC_DOCUMENTS_COLLECTION has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 YS_DOCUMENT_VERSION Public See coding 20050803 begin of ys_document_version, s_document_key type fopcd_s_kpro_document_key, th_versions type fopcd_th_runtime_docs, end of ys_document_version
2 YS_DOCUMENT_VERSION_NUM Public See coding 20050808 begin of ys_document_version_num, s_document_key type fopcd_s_kpro_document_key, num_of_versions type fopc_document_version, end of ys_document_version_num
3 YTH_DOCUMENT_VERSION Public See coding 20050803 yth_document_version type hashed table of ys_document_version with unique key s_document_key
4 YTH_DOCUMENT_VERSION_NUM Public See coding 20050808 yth_document_version_num type hashed table of ys_document_version_num with unique key s_document_key
Method Signatures

Method ADD_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RUNTIME_DOC Value transfer Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040225
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method CHECK_ALLOWED_TO_CHANGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040312
2 Importing I_DELETE Value transfer Type reference (TYPE) AS4FLAG SPACE Flag (X oder Blank) 20040312
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040312

Method CLASS_CONSTRUCTOR Signature

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

Method COMPUTE_HASH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DATA_LENGTH Call by reference Type reference (TYPE) I 0 0: strlenx(i_raw_data) 20040226
2 Importing I_HASH_ALG Call by reference Type reference (TYPE) HASHALG C_CONTENT_HASH_ALG Hash-Algorithmus 20040226
3 Importing I_RAW_DATA Call by reference Type reference (TYPE) XSTRING 20040226
4 Returning R_HASH Value transfer Type reference (TYPE) STRING 20040226
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040228

Method CONSTRUCTOR 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

Method CONSTRUCTOR on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method CONVERT_TIMESTAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_CONVERSION_FAILED Value transfer Type reference (TYPE) AS4FLAG Flag (X oder Blank) 20040226
2 Exporting E_DATE Value transfer Type reference (TYPE) D 20040226
3 Exporting E_TIME Value transfer Type reference (TYPE) T 20040226
4 Importing I_DO_ZONE_CONVERSION Value transfer Type reference (TYPE) AS4FLAG 'X' Convert according user local time zone? 20040226
5 Importing I_TIMESTAMP Value transfer Type reference (TYPE) TIMESTAMP UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss) 20040226

Method CONVERT_TIMESTAMP on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method CREATE_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT_CONTENT Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_CONTENT 20040228
2 Importing IS_DOCUMENT_HEADER Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_HEADER 20040225
3 Importing I_CLONING Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20041111
4 Importing I_DOCUMENT_CATEGORY Call by reference Type reference (TYPE) FOPC_DOCUMENT_CATEGORY Document Category 20041005
5 Importing I_DOCUMENT_LOIO_CLASS Call by reference Type reference (TYPE) FOPC_DOCUMENT_CLASS Dokumentenklasse 20041005
6 Returning RS_RUNTIME_DOCUMENT Value transfer Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040225
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method DELETE_ALL_DOCUMENTS Signature

Method DELETE_ALL_DOCUMENTS on class CL_FOPC_DOCUMENTS_COLLECTION has no parameter.
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040303

Method DELETE_DOCUMENT 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 20040225
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method FREE Signature

Method FREE on class CL_FOPC_DOCUMENTS_COLLECTION has no parameter.
Method FREE on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_CHANGED_DOCUMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_CHANGED_DOCS Value transfer Type reference (TYPE) FOPCD_TH_RUNTIME_DOCS 20050322

Method GET_CHANGED_DOCUMENTS on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DDIC_DOMAIN_VALUE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CACHE_VALUES_AHEAD Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE Cache also unrequested domain values 20041105
2 Importing I_DOMAIN_NAME Call by reference Type reference (TYPE) DDOBJNAME Name eines ABAP Dictionary-Objekts 20041105
3 Importing I_DOMAIN_VALUE Call by reference Type reference (TYPE) DOMVALUE_L Werte für Domänen: Einzelwert/untere Grenze 20041105
4 Importing I_LANGU Value transfer Type reference (TYPE) SYLANGU SY-LANGU R/3-System, aktuelle Sprache 20041105
5 Importing I_NO_EMPTY_DESCRIPTION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE If text is initial -> replace it with technical name 20041105
6 Importing I_USE_CACHING Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE Use cache table 20041105
7 Returning R_TEXT Value transfer Type reference (TYPE) STRING 20041105

Method GET_DDIC_DOMAIN_VALUE_TEXT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOCUMENT 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 20050804
2 Returning RR_DOCUMENT Value transfer Object reference (TYPE REF TO) FOPCD_S_RUNTIME_DOCS 20050804

Method GET_DOCUMENT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOCUMENT_DESCRIPTION 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 20040305
2 Returning R_DESCRIPTION Value transfer Type reference (TYPE) SDOK_TITEL Titel eines Dokuments 20040305

Method GET_DOCUMENT_DESCRIPTION on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOCUMENT_LOIO_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20041108
2 Returning R_KPRO_KEY Value transfer Type reference (TYPE) SKWF_IO KW Framework: Objektschlüssel 20041108

Method GET_DOCUMENT_LOIO_KEY on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOCUMENT_PHIO_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20041108
2 Returning R_KPRO_KEY Value transfer Type reference (TYPE) SKWF_IO KW Framework: Objektschlüssel 20041108

Method GET_DOCUMENT_PHIO_KEY on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOCUMENT_PHYSICAL_VERSIONS 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 20050803
2 Importing I_USE_CACHING Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20050803
3 Returning RTH_DOC_VERSIONS Value transfer Type reference (TYPE) FOPCD_TH_RUNTIME_DOCS 20050803
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20050803

Method GET_DOC_ACCESS_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DOC_ACCESS Call by reference Type reference (TYPE) FOPC_DOCUMENT_ACCESS Document Category 20041017
2 Importing I_LANGU Value transfer Type reference (TYPE) SYLANGU SY-LANGU R/3-System, aktuelle Sprache 20041017
3 Importing I_NO_EMPTY_DESCRIPTION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE If text is initial -> replace it with technical name 20041017
4 Returning R_TEXT Value transfer Type reference (TYPE) STRING 20041017

Method GET_DOC_ACCESS_TEXT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOC_CATEGORY_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DOC_CATEGORY Call by reference Type reference (TYPE) FOPC_DOCUMENT_CATEGORY Document Category 20041014
2 Importing I_LANGU Value transfer Type reference (TYPE) SYLANGU SY-LANGU R/3-System, aktuelle Sprache 20041014
3 Importing I_NO_EMPTY_DESCRIPTION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE If text is initial -> replace it with technical name 20041014
4 Returning R_TEXT Value transfer Type reference (TYPE) STRING 20041014

Method GET_DOC_CATEGORY_TEXT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOC_CLASS_TEXT 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) FOPC_DOCUMENT_CLASS Document Category 20041014
2 Importing I_LANGU Value transfer Type reference (TYPE) SYLANGU SY-LANGU R/3-System, aktuelle Sprache 20041014
3 Importing I_NO_EMPTY_DESCRIPTION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE If text is initial -> replace it with technical name 20041014
4 Returning R_TEXT Value transfer Type reference (TYPE) STRING 20041014

Method GET_DOC_CLASS_TEXT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_DOC_ORIGIN_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DOC_ORIGIN Call by reference Type reference (TYPE) FOPC_DOCUMENT_ORIGIN Document Origin 20041023
2 Importing I_LANGU Value transfer Type reference (TYPE) SYLANGU SY-LANGU R/3-System, aktuelle Sprache 20041023
3 Importing I_NO_EMPTY_DESCRIPTION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE If text is initial -> replace it with technical name 20041023
4 Returning R_TEXT Value transfer Type reference (TYPE) STRING 20041023

Method GET_DOC_ORIGIN_TEXT on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method GET_LOIO_CLASS_FROM_PHIO_CLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_PHIO_CLASS Call by reference Type reference (TYPE) SDOK_CLASS Dokumentenklasse 20040930
2 Returning R_LOIO_CLASS Value transfer Type reference (TYPE) SDOK_CLASS Dokumentenklasse 20040930
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040930

Method GET_NUMBER_OF_VERSIONS 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 20050808
2 Importing I_USE_CACHING Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20050808
3 Returning R_DOC_VERSIONS Value transfer Type reference (TYPE) FOPC_DOCUMENT_VERSION Version 20050808
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20050808

Method GET_PHIO_CLASS_FROM_LOIO_CLASS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_LOIO_CLASS Call by reference Type reference (TYPE) SDOK_CLASS Dokumentenklasse 20040930
2 Returning R_PHIO_CLASS Value transfer Type reference (TYPE) SDOK_CLASS Dokumentenklasse 20040930
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040930

Method GET_STD_DOC_CREATION_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_DOCUMENT_CATEGORY Call by reference Type reference (TYPE) FOPC_DOCUMENT_CATEGORY FOPCD_C_DOCUMENT_CATEGORY-GENERIC Document Category 20041005
2 Importing I_DOCUMENT_LOIO_CLASS Call by reference Type reference (TYPE) FOPC_DOCUMENT_CLASS Document Class 20041019
3 Returning RS_KPRO_HEADER Value transfer Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_HEADER 20040226

Method GET_STD_DOC_CREATION_HEADER on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method SET_NEW_DOCUMENT_DESCRIPTION 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 20040305
2 Importing I_DESCRIPTION Call by reference Type reference (TYPE) SDOK_TITEL Titel eines Dokuments 20040305

Method SET_NEW_DOCUMENT_DESCRIPTION on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method SYNCHRONIZE_WITH_DOC_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_DELETED_DOCUMENTS Value transfer Type reference (TYPE) I 20041111
2 Exporting E_INSERTED_DOCUMENTS Value transfer Type reference (TYPE) I 20041111
3 Exporting E_UPDATED_DOCUMENTS Value transfer Type reference (TYPE) I 20041111
4 Importing IR_APPL_LOG Call by reference Object reference (TYPE REF TO) CL_FOPC_APPLICATION_LOG Application Log for service messages 20041117
5 Importing I_OVERRIDE_TASK_ID Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20041111
6 Importing I_WRITE_BACK_TO_STORAGE Value transfer Type reference (TYPE) AS4FLAG SPACE Cached data are most recent -> write them into storage 20040224
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method UPDATE_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT_CONTENT Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_CONTENT 20040228
2 Importing IS_DOCUMENT_HEADER Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_HEADER 20040225
3 Importing IS_DOCUMENT_KEY Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_KEY 20040225
4 Importing I_OVERWITE_CURRENT_VERSION Value transfer Type reference (TYPE) ABAP_BOOL Update existing/create new version 20050803
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method WAS_ANY_DOCUMENT_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_WAS_ANY_CHANGED Value transfer Type reference (TYPE) ABAP_BOOL 20050322

Method WAS_ANY_DOCUMENT_CHANGED on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method _DELETE_DOCUMENT_FROM_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPL_LOG Call by reference Object reference (TYPE REF TO) CL_FOPC_APPLICATION_LOG Application Log for service messages 20041117
2 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040229
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040229

Method _FILL_DOCUMENT_CONTENT_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_CONTENT_INFO Call by reference Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_CONTENT 20050803
2 Importing IS_APPL_OBJ_KEY Call by reference Type reference (TYPE) FOPCD_APPLICATION_OBJECT_KEY 20050803
3 Importing IS_PHIO_KEY Call by reference Type reference (TYPE) SKWF_IO KW Framework: Objektschlüssel 20050803
4 Importing I_ALT_DOWNLOADER_RELATIVE_URL Call by reference Type reference (TYPE) ABAP_BOOL 20050803
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20050803

Method _FILL_DOCUMENT_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040302
2 Importing IS_LOIO_KEY Call by reference Type reference (TYPE) SKWF_IO KW Framework: Objektschlüssel 20040304
3 Importing IS_PHIO_KEY Call by reference Type reference (TYPE) SKWF_IO KW Framework: Objektschlüssel 20040304
4 Importing IT_PROPERTIES_VALUES Call by reference Type reference (TYPE) SDOKPROPTLS 20040302

Method _FILL_DOCUMENT_PROPERTIES on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method _FILL_LOIO_PHIO_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LOIO_PROPERTIES Call by reference Type reference (TYPE) SDOKPROPTYS SDOK: Liste von Name-Wert-Paaren 20040302
2 Exporting ET_PHIO_PROPERTIES Call by reference Type reference (TYPE) SDOKPROPTYS SDOK: Liste von Name-Wert-Paaren 20040302
3 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040302
4 Importing I_FOR_UPDATE Value transfer Type reference (TYPE) AS4FLAG Attributes relevant only for update 20040305
5 Importing I_OVERRIDE_TASK_ID Value transfer Type reference (TYPE) ABAP_BOOL 20041111

Method _FILL_LOIO_PHIO_PROPERTIES on class CL_FOPC_DOCUMENTS_COLLECTION has no exception.

Method _INSERT_DOCUMENT_TO_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040229
2 Importing I_OVERRIDE_TASK_ID Value transfer Type reference (TYPE) ABAP_BOOL 20041111
3 Returning RS_DOCUMENT_NEW_KEY Value transfer Type reference (TYPE) FOPCD_S_KPRO_DOCUMENT_KEY 20040229
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040229

Method _RAISE_ERROR_MSG_EXCEPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_MSGID Value transfer Type reference (TYPE) SY-MSGID Nachrichten, Nachrichtenklasse 20040302
2 Importing I_MSGNO Value transfer Type reference (TYPE) SY-MSGNO Nachrichten, Nachrichtennummer 20040302
3 Importing I_MSGV1 Value transfer Type reference (TYPE) SIMPLE Nachrichten, Nachrichtenvariable 20040302
4 Importing I_MSGV2 Value transfer Type reference (TYPE) SIMPLE Nachrichten, Nachrichtenvariable 20040302
5 Importing I_MSGV3 Value transfer Type reference (TYPE) SIMPLE Nachrichten, Nachrichtenvariable 20040302
6 Importing I_MSGV4 Value transfer Type reference (TYPE) SIMPLE Nachrichten, Nachrichtenvariable 20040302
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS_ERROR_MSG Exception class error message from Doc.Management Subsystem 20040302

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 20040302
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS_ERROR_MSG Exception class error message from Doc.Management Subsystem 20040302

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 20040302
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS_ERROR_MSG Exception class error message from Doc.Management Subsystem 20040302

Method _REREAD_DOCUMENTS_FROM_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_CHECK_CONTENT_HASH Value transfer Type reference (TYPE) AS4FLAG SPACE Flag (X oder Blank) 20040226
2 Importing I_CHECK_HEADER_HASH Value transfer Type reference (TYPE) AS4FLAG SPACE Flag (X oder Blank) 20040226
3 Importing I_SORT_BY_NAME Value transfer Type reference (TYPE) AS4FLAG 'X' Flag (X oder Blank) 20040305
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225

Method _UPDATE_DOCUMENT_IN_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DOCUMENT Call by reference Type reference (TYPE) FOPCD_S_RUNTIME_DOCS 20040229
2 Importing I_OVERRIDE_TASK_ID Value transfer Type reference (TYPE) ABAP_BOOL 20041111
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040229

Method _WRITE_DOCUMENTS_TO_STORAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_DELETED_DOCUMENTS Call by reference Type reference (TYPE) I 20040229
2 Exporting E_INSERTED_DOCUMENTS Call by reference Type reference (TYPE) I 20040229
3 Exporting E_UPDATED_DOCUMENTS Call by reference Type reference (TYPE) I 20040229
4 Importing IR_APPL_LOG Call by reference Object reference (TYPE REF TO) CL_FOPC_APPLICATION_LOG Application Log for service messages 20041117
5 Importing I_OVERRIDE_TASK_ID Value transfer Type reference (TYPE) ABAP_BOOL 20041111
# Exception Resumable Description Created on
1 CX_FOPC_DOCUMENTS Document Subsystem Exception 20040225
History
Last changed by/on SAP  20060208 
SAP Release Created in 100